Skip to content

Commit d6adc36

Browse files
mongoKartrustagir
authored andcommitted
DOCSP-48687 - Standardize API source constants (#119)
(cherry picked from commit c649366)
1 parent b388ed6 commit d6adc36

34 files changed

+177
-177
lines changed

snooty.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@ full-version = "{+version+}.0"
3131
language = "Scala"
3232
language-version = "2.13.16"
3333
mdb-server = "MongoDB Server"
34-
java-api-root = "https://mongodb.github.io/mongo-java-driver/{+version+}"
35-
api = "{+java-api-root+}/apidocs/mongo-scala-driver"
34+
api-root = "https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs"
35+
driver-api = "{+api-root+}/mongo-scala-driver/org/mongodb/scala"
36+
core-api = "{+api-root+}/mongodb-driver-core/com/mongodb"
3637
driver-source-gh = "https://github.com/mongodb/mongo-java-driver"
3738
rs-docs = "https://www.reactive-streams.org/reactive-streams-1.0.4-javadoc/org/reactivestreams"
38-
core-api = "{+java-api-root+}/apidocs/mongodb-driver-core"
3939
mongocrypt-version = "{+full-version+}"
4040
java-version = "23"
4141
mongodb-server = "MongoDB Server"

source/aggregation.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ methods, see the following resources:
114114

115115
- :manual:`Aggregation Stages </reference/operator/aggregation-pipeline/>` in the
116116
{+mdb-server+} manual
117-
- `Aggregates <{+api+}/org/mongodb/scala/model/Aggregates$.html>`__ in the API documentation
117+
- `Aggregates <{+driver-api+}/model/Aggregates$.html>`__ in the API documentation
118118

119119
.. _scala-aggregation-example:
120120

@@ -279,7 +279,7 @@ API Documentation
279279
To learn more about the methods and types discussed in this guide, see the
280280
following API documentation:
281281

282-
- `aggregate() <{+api+}/org/mongodb/scala/MongoCollection.html#aggregate[C](pipeline:Seq[org.mongodb.scala.bson.conversions.Bson])(implicite:org.mongodb.scala.bson.DefaultHelper.DefaultsTo[C,TResult],implicitct:scala.reflect.ClassTag[C]):org.mongodb.scala.AggregateObservable[C]>`__
283-
- `Aggregates <{+api+}/org/mongodb/scala/model/Aggregates$.html>`__
284-
- `explain() <{+api+}/org/mongodb/scala/AggregateObservable.html#explain[ExplainResult](verbosity:com.mongodb.ExplainVerbosity)(implicite:org.mongodb.scala.bson.DefaultHelper.DefaultsTo[ExplainResult,org.mongodb.scala.Document],implicitct:scala.reflect.ClassTag[ExplainResult]):org.mongodb.scala.SingleObservable[ExplainResult]>`__
282+
- `aggregate() <{+driver-api+}/MongoCollection.html#aggregate[C](pipeline:Seq[org.mongodb.scala.bson.conversions.Bson])(implicite:org.mongodb.scala.bson.DefaultHelper.DefaultsTo[C,TResult],implicitct:scala.reflect.ClassTag[C]):org.mongodb.scala.AggregateObservable[C]>`__
283+
- `Aggregates <{+driver-api+}/model/Aggregates$.html>`__
284+
- `explain() <{+driver-api+}/AggregateObservable.html#explain[ExplainResult](verbosity:com.mongodb.ExplainVerbosity)(implicite:org.mongodb.scala.bson.DefaultHelper.DefaultsTo[ExplainResult,org.mongodb.scala.Document],implicitct:scala.reflect.ClassTag[ExplainResult]):org.mongodb.scala.SingleObservable[ExplainResult]>`__
285285

source/connect/connection-targets.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ API Documentation
144144
To learn more about any of the methods or types discussed in this guide, see the
145145
following API documentation:
146146

147-
- `MongoClient <{+api+}/org/mongodb/scala/MongoClient$.html>`__
148-
- `MongoClientSettings <{+api+}/org/mongodb/scala/MongoClientSettings$.html>`__
149-
- `MongoClientSettings.Builder <{+core-api+}/com/mongodb/MongoClientSettings.Builder.html>`__
150-
- `ServerApi <{+core-api+}/com/mongodb/ServerApi.html>`__
147+
- `MongoClient <{+driver-api+}/MongoClient$.html>`__
148+
- `MongoClientSettings <{+driver-api+}/MongoClientSettings$.html>`__
149+
- `MongoClientSettings.Builder <{+core-api+}/MongoClientSettings.Builder.html>`__
150+
- `ServerApi <{+core-api+}/ServerApi.html>`__

source/connect/mongoclient.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,6 @@ API Documentation
127127
For more information about creating a ``MongoClient`` object with the
128128
{+driver-short+}, see the following API documentation:
129129

130-
- `MongoClient <{+api+}/org/mongodb/scala/MongoClient.html>`__
130+
- `MongoClient <{+driver-api+}/MongoClient.html>`__
131131

132-
- `MongoClientSettings <{+api+}/org/mongodb/scala/MongoClientSettings$.html>`__
132+
- `MongoClientSettings <{+driver-api+}/MongoClientSettings$.html>`__

source/connect/stable-api.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -122,10 +122,10 @@ API Documentation
122122
For more information about using the {+stable-api+} with the {+driver-short+}, see the
123123
following API documentation:
124124

125-
- `ServerApi <{+core-api+}/com/mongodb/ServerApi.html>`__
126-
- `ServerApi.Builder <{+core-api+}/com/mongodb/ServerApi.Builder.html>`__
127-
- `ServerApiVersion <{+core-api+}/com/mongodb/ServerApiVersion.html>`__
128-
- `ServerAddress <{+api+}/org/mongodb/scala/ServerAddress$.html>`__
129-
- `MongoClientSettings <{+api+}/org/mongodb/scala/MongoClientSettings$.html>`__
130-
- `MongoClientSettings.Builder <{+core-api+}/com/mongodb/MongoClientSettings.Builder.html>`__
131-
- `MongoClient <{+api+}/org/mongodb/scala/MongoClient$.html>`__
125+
- `ServerApi <{+core-api+}/ServerApi.html>`__
126+
- `ServerApi.Builder <{+core-api+}/ServerApi.Builder.html>`__
127+
- `ServerApiVersion <{+core-api+}/ServerApiVersion.html>`__
128+
- `ServerAddress <{+driver-api+}/ServerAddress$.html>`__
129+
- `MongoClientSettings <{+driver-api+}/MongoClientSettings$.html>`__
130+
- `MongoClientSettings.Builder <{+core-api+}/MongoClientSettings.Builder.html>`__
131+
- `MongoClient <{+driver-api+}/MongoClient$.html>`__

source/connect/tls.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -339,5 +339,5 @@ API Documentation
339339
For more information about any of the types discussed in this guide,
340340
see the following API documentation:
341341

342-
- `ConnectionString <{+core-api+}/com/mongodb/ConnectionString.html>`__
343-
- `MongoClientSettings <{+core-api+}/com/mongodb/MongoClientSettings.html>`__
342+
- `ConnectionString <{+core-api+}/ConnectionString.html>`__
343+
- `MongoClientSettings <{+core-api+}/MongoClientSettings.html>`__

source/databases-collections.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ preference of the collection as ``secondary``:
201201
.. tip::
202202

203203
To see the types of available read preferences, see the
204-
`API documentation <{+api+}/org/mongodb/scala/ReadPreference$.html>`__.
204+
`API documentation <{+driver-api+}/ReadPreference$.html>`__.
205205

206206
To learn more about the read and write settings, see the following guides in the
207207
{+mdb-server+} manual:
@@ -268,9 +268,9 @@ API Documentation
268268
To learn more about any of the types or methods discussed in this
269269
guide, see the following API documentation:
270270

271-
- `MongoClient <{+api+}/org/mongodb/scala/MongoClient.html>`__
272-
- `MongoDatabase <{+api+}/org/mongodb/scala/MongoDatabase.html>`__
273-
- `MongoCollection <{+api+}/org/mongodb/scala/MongoCollection.html>`__
274-
- `CreateCollectionOptions <{+api+}/org/mongodb/scala/model/package$$CreateCollectionOptions$.html>`__
275-
- `ClusterSettings <{+api+}/org/mongodb/scala/connection/ClusterSettings$.html>`__
276-
- `MongoClientSettings <{+api+}/org/mongodb/scala/MongoClientSettings$.html>`__
271+
- `MongoClient <{+driver-api+}/MongoClient.html>`__
272+
- `MongoDatabase <{+driver-api+}/MongoDatabase.html>`__
273+
- `MongoCollection <{+driver-api+}/MongoCollection.html>`__
274+
- `CreateCollectionOptions <{+driver-api+}/model/package$$CreateCollectionOptions$.html>`__
275+
- `ClusterSettings <{+driver-api+}/connection/ClusterSettings$.html>`__
276+
- `MongoClientSettings <{+driver-api+}/MongoClientSettings$.html>`__

source/databases-collections/run-command.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,6 @@ API Documentation
192192
To learn more about any of the methods or types discussed in this
193193
guide, see the following API documentation:
194194

195-
- `runCommand() <{+api+}/org/mongodb/scala/MongoDatabase.html#runCommand[TResult](command:org.mongodb.scala.bson.conversions.Bson)(implicite:org.mongodb.scala.bson.DefaultHelper.DefaultsTo[TResult,org.mongodb.scala.Document],implicitct:scala.reflect.ClassTag[TResult]):org.mongodb.scala.SingleObservable[TResult]>`__
196-
- `SingleObservable <{+api+}/org/mongodb/scala/SingleObservable.html>`__
197-
- `ReadPreference <{+api+}/org/mongodb/scala/ReadPreference$.html>`__
195+
- `runCommand() <{+driver-api+}/MongoDatabase.html#runCommand[TResult](command:org.mongodb.scala.bson.conversions.Bson)(implicite:org.mongodb.scala.bson.DefaultHelper.DefaultsTo[TResult,org.mongodb.scala.Document],implicitct:scala.reflect.ClassTag[TResult]):org.mongodb.scala.SingleObservable[TResult]>`__
196+
- `SingleObservable <{+driver-api+}/SingleObservable.html>`__
197+
- `ReadPreference <{+driver-api+}/ReadPreference$.html>`__

source/databases-collections/time-series.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@ To create a time series collection, pass the following parameters to the
6262

6363
- Name of the new collection to create
6464

65-
- `CreateCollectionOptions <{+api+}/org/mongodb/scala/model/package$$CreateCollectionOptions$.html>`__
66-
object with the `TimeSeriesOptions <{+api+}/org/mongodb/scala/model/package$$TimeSeriesOptions$.html>`__ set
65+
- `CreateCollectionOptions <{+driver-api+}/model/package$$CreateCollectionOptions$.html>`__
66+
object with the `TimeSeriesOptions <{+driver-api+}/model/package$$TimeSeriesOptions$.html>`__ set
6767
using the ``timeSeriesOptions()`` method
6868

6969
.. _scala-time-series-create-example:
@@ -176,7 +176,7 @@ API Documentation
176176
To learn more about the methods mentioned in this guide, see the following
177177
API documentation:
178178

179-
- `createCollection() <{+api+}/org/mongodb/scala/MongoDatabase.html#createCollection(clientSession:org.mongodb.scala.ClientSession,collectionName:String,options:com.mongodb.client.model.CreateCollectionOptions):org.mongodb.scala.SingleObservable[Unit]>`__
180-
- `listCollections() <{+api+}/org/mongodb/scala/MongoDatabase.html#listCollections[TResult](clientSession:org.mongodb.scala.ClientSession)(implicite:org.mongodb.scala.bson.DefaultHelper.DefaultsTo[TResult,org.mongodb.scala.Document],implicitct:scala.reflect.ClassTag[TResult]):org.mongodb.scala.ListCollectionsObservable[TResult]>`__
181-
- `insertOne() <{+api+}/org/mongodb/scala/MongoCollection.html#insertOne(clientSession:org.mongodb.scala.ClientSession,document:TResult,options:org.mongodb.scala.model.InsertOneOptions):org.mongodb.scala.SingleObservable[org.mongodb.scala.result.InsertOneResult]>`__
182-
- `insertMany() <{+api+}/org/mongodb/scala/MongoCollection.html#insertMany(clientSession:org.mongodb.scala.ClientSession,documents:Seq[_%3C:TResult],options:org.mongodb.scala.model.InsertManyOptions):org.mongodb.scala.SingleObservable[org.mongodb.scala.result.InsertManyResult]>`__
179+
- `createCollection() <{+driver-api+}/MongoDatabase.html#createCollection(clientSession:org.mongodb.scala.ClientSession,collectionName:String,options:com.mongodb.client.model.CreateCollectionOptions):org.mongodb.scala.SingleObservable[Unit]>`__
180+
- `listCollections() <{+driver-api+}/MongoDatabase.html#listCollections[TResult](clientSession:org.mongodb.scala.ClientSession)(implicite:org.mongodb.scala.bson.DefaultHelper.DefaultsTo[TResult,org.mongodb.scala.Document],implicitct:scala.reflect.ClassTag[TResult]):org.mongodb.scala.ListCollectionsObservable[TResult]>`__
181+
- `insertOne() <{+driver-api+}/MongoCollection.html#insertOne(clientSession:org.mongodb.scala.ClientSession,document:TResult,options:org.mongodb.scala.model.InsertOneOptions):org.mongodb.scala.SingleObservable[org.mongodb.scala.result.InsertOneResult]>`__
182+
- `insertMany() <{+driver-api+}/MongoCollection.html#insertMany(clientSession:org.mongodb.scala.ClientSession,documents:Seq[_%3C:TResult],options:org.mongodb.scala.model.InsertManyOptions):org.mongodb.scala.SingleObservable[org.mongodb.scala.result.InsertManyResult]>`__

source/index.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
Upgrade </upgrade>
2929
Compatibility </compatibility>
3030
View the Source <https://github.com/mongodb/mongo-java-driver>
31-
API Documentation <{+api+}/index.html>
31+
API Documentation <{+api-root+}/mongo-scala-driver/index.html>
3232
Previous Versions <https://mongodb.github.io/mongo-java-driver/>
3333

3434
Introduction

0 commit comments

Comments
 (0)