Skip to content

Commit ecf5d23

Browse files
mongoKartrustagir
authored andcommitted
DOCSP-48687 - Standardize API source constants (#89)
(cherry picked from commit a388439)
1 parent 46b8634 commit ecf5d23

38 files changed

+332
-332
lines changed

snooty.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ full-version = "{+version-number+}.0"
3030
version = "v{+version-number+}"
3131
mdb-server = "MongoDB Server"
3232
stable-api = "Stable API"
33-
api = "https://mongodb.github.io/mongo-java-driver/{+version-number+}/apidocs/mongodb-driver-kotlin-sync/mongodb-driver-kotlin-sync"
34-
java-api = "https://mongodb.github.io/mongo-java-driver/{+version-number+}"
35-
core-api = "{+java-api+}/apidocs/mongodb-driver-core"
33+
api-root = "https://mongodb.github.io/mongo-java-driver/{+version-number+}/apidocs"
34+
driver-api = "{+api-root+}/mongodb-driver-kotlin-sync/mongodb-driver-kotlin-sync/com.mongodb.kotlin.client"
35+
core-api = "{+api-root+}/mongodb-driver-core/com/mongodb"
3636
kotlin-docs = "https://kotlinlang.org"
3737
serialization-version = "1.6.0"
3838
kotlinx-dt-version = "0.6.1"

source/agg-exp-ops.txt

Lines changed: 139 additions & 139 deletions
Large diffs are not rendered by default.

source/aggregation.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -216,5 +216,5 @@ API Documentation
216216
For more information about executing aggregation operations with the {+driver-short+},
217217
see the following API documentation:
218218

219-
- `aggregate() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/aggregate.html>`__
220-
- `AggregateIterable <{+api+}/com.mongodb.kotlin.client/-aggregate-iterable/index.html>`__
219+
- `aggregate() <{+driver-api+}/-mongo-collection/aggregate.html>`__
220+
- `AggregateIterable <{+driver-api+}/-aggregate-iterable/index.html>`__

source/api.txt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@ API Documentation
88
:titlesonly:
99
:maxdepth: 1
1010

11-
{+language+} Sync Driver <{+java-api+}/apidocs/mongodb-driver-kotlin-sync/index.html>
12-
BSON kotlinx.serialization <{+java-api+}/apidocs/bson-kotlinx/index.html>
13-
{+language+} Driver Extensions <{+java-api+}/apidocs/mongodb-driver-kotlin-extensions/index.html>
14-
Driver Core <{+core-api+}/index.html>
11+
{+language+} Sync Driver <{+api-root+}/mongodb-driver-kotlin-sync/index.html>
12+
BSON kotlinx.serialization <{+api-root+}/bson-kotlinx/index.html>
13+
{+language+} Driver Extensions <{+api-root+}/mongodb-driver-kotlin-extensions/index.html>
14+
Driver Core <{+api-root+}/mongodb-driver-core/index.html>
1515

16-
- `{+language+} Sync Driver <{+java-api+}/apidocs/mongodb-driver-kotlin-sync/index.html>`__ -
16+
- `{+language+} Sync Driver <{+api-root+}/mongodb-driver-kotlin-sync/index.html>`__ -
1717
classes for the current synchronous driver API.
18-
- `BSON kotlinx.serialization <{+java-api+}/apidocs/bson-kotlinx/index.html>`__ -
18+
- `BSON kotlinx.serialization <{+api-root+}/bson-kotlinx/index.html>`__ -
1919
classes for encoding and decoding between Kotlin data classes and the BSON data
2020
format using :github:`kotlinx.serialization <Kotlin/kotlinx.serialization>`.
2121
- `{+language+} Driver Extensions
22-
<{+java-api+}/apidocs/mongodb-driver-kotlin-extensions/index.html>`__ -
22+
<{+api-root+}/mongodb-driver-kotlin-extensions/index.html>`__ -
2323
classes that extend the core builder classes to support :ref:`data
2424
classes <kotlin-sync-builders-data-classes>`.
25-
- `Driver Core <{+core-api+}/index.html>`__ - classes that
25+
- `Driver Core <{+api-root+}/mongodb-driver-core/index.html>`__ - classes that
2626
contain essential driver functionality.

source/builders.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,13 @@ efficiently build queries and aggregations.
3333
To learn more about the available builder classes and methods, see the
3434
following API documentation sections:
3535

36-
- `Accumulators <{+core-api+}/com/mongodb/client/model/Accumulators.html>`__
37-
- `Aggregates <{+core-api+}/com/mongodb/client/model/Aggregates.html>`__
38-
- `Filters <{+core-api+}/com/mongodb/client/model/Filters.html>`__
39-
- `Indexes <{+core-api+}/com/mongodb/client/model/Indexes.html>`__
40-
- `Projections <{+core-api+}/com/mongodb/client/model/Projections.html>`__
41-
- `Sorts <{+core-api+}/com/mongodb/client/model/Sorts.html>`__
42-
- `Updates <{+core-api+}/com/mongodb/client/model/Updates.html>`__
36+
- `Accumulators <{+core-api+}/client/model/Accumulators.html>`__
37+
- `Aggregates <{+core-api+}/client/model/Aggregates.html>`__
38+
- `Filters <{+core-api+}/client/model/Filters.html>`__
39+
- `Indexes <{+core-api+}/client/model/Indexes.html>`__
40+
- `Projections <{+core-api+}/client/model/Projections.html>`__
41+
- `Sorts <{+core-api+}/client/model/Sorts.html>`__
42+
- `Updates <{+core-api+}/client/model/Updates.html>`__
4343

4444
Why Use Builders?
4545
-----------------

source/builders/builders-data-classes.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -259,4 +259,4 @@ API Documentation
259259
-----------------
260260

261261
- `{+driver-short+} Extensions
262-
<{+core-api+}/apidocs/mongodb-driver-kotlin-extensions/index.html>`__
262+
<{+api-root+}/mongodb-driver-kotlin-extensions/index.html>`__

source/connect/connection-options.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -341,9 +341,9 @@ API Documentation
341341
To learn more about the classes and methods mentioned in this guide, see
342342
the following API documentation:
343343

344-
- `MongoClientSettings <{+java-api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.html>`__
345-
- `MongoClientSettings.Builder <{+java-api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html>`__
346-
- `ConnectionString <{+java-api+}/apidocs/mongodb-driver-core/com/mongodb/ConnectionString.html>`__
347-
- `SocketSettings <{+java-api+}/apidocs/mongodb-driver-core/com/mongodb/connection/SocketSettings.html>`__
348-
- `ClusterSettings <{+java-api+}/apidocs/mongodb-driver-core/com/mongodb/connection/ClusterSettings.html>`__
349-
- `MongoCredential <{+java-api+}/apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html>`__
344+
- `MongoClientSettings <{+core-api+}/MongoClientSettings.html>`__
345+
- `MongoClientSettings.Builder <{+core-api+}/MongoClientSettings.Builder.html>`__
346+
- `ConnectionString <{+core-api+}/ConnectionString.html>`__
347+
- `SocketSettings <{+core-api+}/connection/SocketSettings.html>`__
348+
- `ClusterSettings <{+core-api+}/connection/ClusterSettings.html>`__
349+
- `MongoCredential <{+core-api+}/MongoCredential.html>`__

source/connect/mongoclient.txt

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

129-
- `MongoClient <{+api+}/mongodb-driver-kotlin-sync/com.mongodb.kotlin.client/-mongo-client/index.html>`__
130-
- `MongoClientSettings <{+core-api+}com/mongodb/MongoClientSettings.html>`__
129+
- `MongoClient <{+driver-api+}/-mongo-client/index.html>`__
130+
- `MongoClientSettings <{+core-api+}/MongoClientSettings.html>`__

source/connect/stable-api.txt

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

126-
- `ServerApi <{+core-api+}/com/mongodb/ServerApi.html>`__
127-
- `ServerApi.Builder <{+core-api+}/com/mongodb/ServerApi.Builder.html>`__
128-
- `ServerApiVersion <{+core-api+}/com/mongodb/ServerApiVersion.html>`__
129-
- `ServerAddress <{+core-api+}/com/mongodb/ServerAddress.html>`__
130-
- `MongoClientSettings <{+core-api+}/com/mongodb/MongoClientSettings.html>`__
131-
- `MongoClientSettings.Builder <{+core-api+}/com/mongodb/MongoClientSettings.Builder.html>`__
132-
- `MongoClient <{+api+}/com.mongodb.kotlin.client/-mongo-client/index.html>`__
133-
- `MongoClient.create() <{+api+}/com.mongodb.kotlin.client/-mongo-client/-factory/create.html>`__
126+
- `ServerApi <{+core-api+}/ServerApi.html>`__
127+
- `ServerApi.Builder <{+core-api+}/ServerApi.Builder.html>`__
128+
- `ServerApiVersion <{+core-api+}/ServerApiVersion.html>`__
129+
- `ServerAddress <{+core-api+}/ServerAddress.html>`__
130+
- `MongoClientSettings <{+core-api+}/MongoClientSettings.html>`__
131+
- `MongoClientSettings.Builder <{+core-api+}/MongoClientSettings.Builder.html>`__
132+
- `MongoClient <{+driver-api+}/-mongo-client/index.html>`__
133+
- `MongoClient.create() <{+driver-api+}/-mongo-client/-factory/create.html>`__

source/connect/tls.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -325,5 +325,5 @@ API Documentation
325325
For more information about any of the methods or types discussed in this guide,
326326
see the following API documentation:
327327

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

0 commit comments

Comments
 (0)