Skip to content

Commit ff8739d

Browse files
[Backport v5.4] DOCSP-48687 - Standardize API source constants (#120)
Co-authored-by: Mike Woofter <[email protected]>
1 parent 6f8244d commit ff8739d

27 files changed

+73
-73
lines changed

snooty.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ driver-short = "Java Reactive Streams driver"
2323
driver-long = "MongoDB Java Reactive Streams Driver"
2424
version = "5.4"
2525
full-version = "{+version+}.0"
26-
api = "https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs"
27-
rs-driver-api = "{+api+}/mongodb-driver-reactivestreams/com/mongodb/reactivestreams/client"
28-
core-api = "{+api+}/mongodb-driver-core/com/mongodb"
26+
api-root = "https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs"
27+
driver-api = "{+api-root+}/mongodb-driver-reactivestreams/com/mongodb/reactivestreams/client"
28+
core-api = "{+api-root+}/mongodb-driver-core/com/mongodb"
2929
rs-docs = "https://www.reactive-streams.org/reactive-streams-1.0.4-javadoc/org/reactivestreams"
3030
driver-source-gh = "https://github.com/mongodb/mongo-java-driver"
3131
java-rs = "Java Reactive Streams"

source/connect-to-mongo/choose-connection-target.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,4 +142,4 @@ API Documentation
142142
To learn more about creating a ``MongoClient`` instance in the {+driver-short+},
143143
see the following API documentation:
144144

145-
- `MongoClient <{+rs-driver-api+}/MongoClients.html>`__
145+
- `MongoClient <{+driver-api+}/MongoClients.html>`__

source/connect-to-mongo/connection-options.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -304,7 +304,7 @@ General Configuration
304304

305305
* - **uuidRepresentation**
306306
- | Sets the mechanism the {+driver-short+} uses to encode instances of
307-
| UUID. See the `Uuid Representation <{+api+}/bson/org/bson/UuidRepresentation.html>`__ API documentation for a list of all
307+
| UUID. See the `Uuid Representation <{+api-root+}/bson/org/bson/UuidRepresentation.html>`__ API documentation for a list of all
308308
| valid options.
309309
|
310310
| **Data Type**: {+string-data-type+}

source/connect-to-mongo/create-a-mongo-client.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,4 +117,4 @@ API Documentation
117117
To learn more about creating a ``MongoClient`` instance in the {+driver-short+},
118118
see the following API documentation:
119119

120-
- `MongoClient <{+rs-driver-api+}/MongoClients.html>`__
120+
- `MongoClient <{+driver-api+}/MongoClients.html>`__

source/connect-to-mongo/network-compression.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ API Documentation
9292
To learn more about any of the methods or types discussed in this
9393
guide, see the following API documentation:
9494

95-
- `MongoClient <{+rs-driver-api+}/MongoClient.html>`__
95+
- `MongoClient <{+driver-api+}/MongoClient.html>`__
9696
- `createSnappyCompressor() <{+core-api+}/MongoCompressor.html#createSnappyCompressor()>`__
97-
- `createZlibCompressor() <{+api+}//mongodb-driver-core/com/mongodb/MongoCompressor.html#createZlibCompressor()>`__
97+
- `createZlibCompressor() <{+api-root+}//mongodb-driver-core/com/mongodb/MongoCompressor.html#createZlibCompressor()>`__
9898
- `createZstdCompressor() <{+core-api+}/MongoCompressor.html#createZstdCompressor()>`__

source/connect-to-mongo/stable-api.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,4 +128,4 @@ following API documentation:
128128
- `ServerAddress <{+core-api+}/ServerAddress.html>`__
129129
- `MongoClientSettings <{+core-api+}/MongoClientSettings.html>`__
130130
- `MongoClientSettings.Builder <{+core-api+}/MongoClientSettings.Builder.html>`__
131-
- `MongoClients <{+rs-driver-api+}/MongoClients.html>`__
131+
- `MongoClients <{+driver-api+}/MongoClients.html>`__

source/data-formats/time-series.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ API Documentation
165165
To learn more about the methods mentioned in this guide, see the following
166166
API documentation:
167167

168-
- `createCollection() <{+rs-driver-api+}/MongoDatabase.html#createCollection(java.lang.String)>`__
169-
- `listCollections() <{+rs-driver-api+}/MongoDatabase.html#listCollections()>`__
170-
- `insertOne() <{+rs-driver-api+}/MongoCollection.html#insertOne(TDocument)>`__
171-
- `insertMany() <{+rs-driver-api+}/MongoCollection.html#insertMany(java.util.List)>`__
168+
- `createCollection() <{+driver-api+}/MongoDatabase.html#createCollection(java.lang.String)>`__
169+
- `listCollections() <{+driver-api+}/MongoDatabase.html#listCollections()>`__
170+
- `insertOne() <{+driver-api+}/MongoCollection.html#insertOne(TDocument)>`__
171+
- `insertMany() <{+driver-api+}/MongoCollection.html#insertMany(java.util.List)>`__

source/index.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ MongoDB Java Reactive Streams Documentation
4040
Issues & Help </issues-and-help>
4141
Compatibility </compatibility>
4242
Upgrade </upgrade>
43-
API Documentation <{+api+}/mongodb-driver-reactivestreams/>
43+
API Documentation <{+api-root+}/mongodb-driver-reactivestreams/>
4444

4545
Overview
4646
--------
@@ -135,7 +135,7 @@ API Documentation
135135
-----------------
136136

137137
For detailed information about types and methods in the {+driver-short+}, see
138-
the `API documentation <{+api+}/mongodb-driver-reactivestreams/>`__.
138+
the `API documentation <{+api-root+}/mongodb-driver-reactivestreams/>`__.
139139

140140
If you need to make synchronous calls between your application and MongoDB, use
141141
the :driver:`MongoDB Java Driver </java/sync/current/>` instead of the

source/monitoring.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -418,7 +418,7 @@ API Documentation
418418
For more information about the classes and methods mentioned in this document, see
419419
the following API Documentation:
420420

421-
- `MongoClients <{+rs-driver-api+}/MongoClients.html>`__
421+
- `MongoClients <{+driver-api+}/MongoClients.html>`__
422422
- `MongoClientSettings <{+core-api+}/MongoClientSettings.html>`__
423423
- `CommandListener <{+core-api+}/event/CommandListener.html>`__
424424
- `CommandStartedEvent <{+core-api+}/event/CommandStartedEvent.html>`__

source/read-write-configuration.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -195,12 +195,12 @@ API Documentation
195195
To learn more about any of the methods or types discussed in this
196196
guide, see the following API documentation:
197197

198-
- `WriteConcern <{+api+}//mongodb-driver-core/com/mongodb/WriteConcern.html>`__
199-
- `MongoDatabase.withWriteConcern <{+rs-driver-api+}/MongoDatabase.html#withWriteConcern(com.mongodb.WriteConcern)>`__
200-
- `MongoCollection.withWriteConcern <{+rs-driver-api+}/MongoCollection.html#withWriteConcern(com.mongodb.WriteConcern)>`__
198+
- `WriteConcern <{+api-root+}//mongodb-driver-core/com/mongodb/WriteConcern.html>`__
199+
- `MongoDatabase.withWriteConcern <{+driver-api+}/MongoDatabase.html#withWriteConcern(com.mongodb.WriteConcern)>`__
200+
- `MongoCollection.withWriteConcern <{+driver-api+}/MongoCollection.html#withWriteConcern(com.mongodb.WriteConcern)>`__
201201
- `ReadConcern <{+core-api+}/ReadConcern.html>`__
202-
- `MongoDatabase.withReadConcern <{+rs-driver-api+}/MongoDatabase.html#withReadConcern(com.mongodb.ReadConcern)>`__
203-
- `MongoCollection.withReadConcern <{+rs-driver-api+}/MongoCollection.html#withReadPreference(com.mongodb.ReadPreference)>`__
202+
- `MongoDatabase.withReadConcern <{+driver-api+}/MongoDatabase.html#withReadConcern(com.mongodb.ReadConcern)>`__
203+
- `MongoCollection.withReadConcern <{+driver-api+}/MongoCollection.html#withReadPreference(com.mongodb.ReadPreference)>`__
204204
- `ReadPreference <{+core-api+}/ReadPreference.html>`__
205-
- `MongoDatabase.withReadPreference <{+rs-driver-api+}/MongoDatabase.html#withReadPreference(com.mongodb.ReadPreference)>`__
206-
- `MongoDatabase.withReadPreference <{+rs-driver-api+}/MongoCollection.html#withReadPreference(com.mongodb.ReadPreference)>`__
205+
- `MongoDatabase.withReadPreference <{+driver-api+}/MongoDatabase.html#withReadPreference(com.mongodb.ReadPreference)>`__
206+
- `MongoDatabase.withReadPreference <{+driver-api+}/MongoCollection.html#withReadPreference(com.mongodb.ReadPreference)>`__

0 commit comments

Comments
 (0)