[Backport v5.4] DOCSP-48687 - Standardize API source constants

snooty.toml

@@ -23,9 +23,9 @@ driver-short = "Java Reactive Streams driver"
 driver-long = "MongoDB Java Reactive Streams Driver"
 version = "5.4"
 full-version = "{+version+}.0"
-api = "https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs"
-rs-driver-api = "{+api+}/mongodb-driver-reactivestreams/com/mongodb/reactivestreams/client"
-core-api = "{+api+}/mongodb-driver-core/com/mongodb"
+api-root = "https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs"
+driver-api = "{+api-root+}/mongodb-driver-reactivestreams/com/mongodb/reactivestreams/client"
+core-api = "{+api-root+}/mongodb-driver-core/com/mongodb"
 rs-docs = "https://www.reactive-streams.org/reactive-streams-1.0.4-javadoc/org/reactivestreams"
 driver-source-gh = "https://github.com/mongodb/mongo-java-driver"
 java-rs = "Java Reactive Streams"

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

@@ -142,4 +142,4 @@ API Documentation
 To learn more about creating a ``MongoClient`` instance in the {+driver-short+},
 see the following API documentation:
 
-- `MongoClient <{+rs-driver-api+}/MongoClients.html>`__ 
+- `MongoClient <{+driver-api+}/MongoClients.html>`__ 

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

@@ -304,7 +304,7 @@ General Configuration
 
    * - **uuidRepresentation**
      - | Sets the mechanism the {+driver-short+} uses to encode instances of
-       | UUID. See the `Uuid Representation <{+api+}/bson/org/bson/UuidRepresentation.html>`__ API documentation for a list of all
+       | UUID. See the `Uuid Representation <{+api-root+}/bson/org/bson/UuidRepresentation.html>`__ API documentation for a list of all
        | valid options.
        |
        | **Data Type**: {+string-data-type+}

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

@@ -117,4 +117,4 @@ API Documentation
 To learn more about creating a ``MongoClient`` instance in the {+driver-short+},
 see the following API documentation:
 
-- `MongoClient <{+rs-driver-api+}/MongoClients.html>`__ 
+- `MongoClient <{+driver-api+}/MongoClients.html>`__ 

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

@@ -92,7 +92,7 @@ API Documentation
 To learn more about any of the methods or types discussed in this
 guide, see the following API documentation:
 
-- `MongoClient <{+rs-driver-api+}/MongoClient.html>`__
+- `MongoClient <{+driver-api+}/MongoClient.html>`__
 - `createSnappyCompressor() <{+core-api+}/MongoCompressor.html#createSnappyCompressor()>`__
-- `createZlibCompressor() <{+api+}//mongodb-driver-core/com/mongodb/MongoCompressor.html#createZlibCompressor()>`__
+- `createZlibCompressor() <{+api-root+}//mongodb-driver-core/com/mongodb/MongoCompressor.html#createZlibCompressor()>`__
 - `createZstdCompressor() <{+core-api+}/MongoCompressor.html#createZstdCompressor()>`__

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

@@ -128,4 +128,4 @@ following API documentation:
 - `ServerAddress <{+core-api+}/ServerAddress.html>`__
 - `MongoClientSettings <{+core-api+}/MongoClientSettings.html>`__
 - `MongoClientSettings.Builder <{+core-api+}/MongoClientSettings.Builder.html>`__
-- `MongoClients <{+rs-driver-api+}/MongoClients.html>`__
+- `MongoClients <{+driver-api+}/MongoClients.html>`__

source/data-formats/time-series.txt

@@ -165,7 +165,7 @@ API Documentation
 To learn more about the methods mentioned in this guide, see the following
 API documentation:
 
-- `createCollection() <{+rs-driver-api+}/MongoDatabase.html#createCollection(java.lang.String)>`__
-- `listCollections() <{+rs-driver-api+}/MongoDatabase.html#listCollections()>`__
-- `insertOne() <{+rs-driver-api+}/MongoCollection.html#insertOne(TDocument)>`__
-- `insertMany() <{+rs-driver-api+}/MongoCollection.html#insertMany(java.util.List)>`__
+- `createCollection() <{+driver-api+}/MongoDatabase.html#createCollection(java.lang.String)>`__
+- `listCollections() <{+driver-api+}/MongoDatabase.html#listCollections()>`__
+- `insertOne() <{+driver-api+}/MongoCollection.html#insertOne(TDocument)>`__
+- `insertMany() <{+driver-api+}/MongoCollection.html#insertMany(java.util.List)>`__

source/index.txt

@@ -40,7 +40,7 @@ MongoDB Java Reactive Streams Documentation
    Issues & Help </issues-and-help>
    Compatibility </compatibility>
    Upgrade </upgrade>
-   API Documentation <{+api+}/mongodb-driver-reactivestreams/>
+   API Documentation <{+api-root+}/mongodb-driver-reactivestreams/>
 
 Overview
 --------
@@ -135,7 +135,7 @@ API Documentation
 -----------------
 
 For detailed information about types and methods in the {+driver-short+}, see
-the `API documentation <{+api+}/mongodb-driver-reactivestreams/>`__.
+the `API documentation <{+api-root+}/mongodb-driver-reactivestreams/>`__.
 
 If you need to make synchronous calls between your application and MongoDB, use
 the :driver:`MongoDB Java Driver </java/sync/current/>` instead of the

source/monitoring.txt

@@ -418,7 +418,7 @@ API Documentation
 For more information about the classes and methods mentioned in this document, see
 the following API Documentation:
 
-- `MongoClients <{+rs-driver-api+}/MongoClients.html>`__
+- `MongoClients <{+driver-api+}/MongoClients.html>`__
 - `MongoClientSettings <{+core-api+}/MongoClientSettings.html>`__
 - `CommandListener <{+core-api+}/event/CommandListener.html>`__
 - `CommandStartedEvent <{+core-api+}/event/CommandStartedEvent.html>`__

source/read-write-configuration.txt

@@ -195,12 +195,12 @@ API Documentation
 To learn more about any of the methods or types discussed in this
 guide, see the following API documentation:
 
-- `WriteConcern <{+api+}//mongodb-driver-core/com/mongodb/WriteConcern.html>`__
-- `MongoDatabase.withWriteConcern <{+rs-driver-api+}/MongoDatabase.html#withWriteConcern(com.mongodb.WriteConcern)>`__
-- `MongoCollection.withWriteConcern <{+rs-driver-api+}/MongoCollection.html#withWriteConcern(com.mongodb.WriteConcern)>`__
+- `WriteConcern <{+api-root+}//mongodb-driver-core/com/mongodb/WriteConcern.html>`__
+- `MongoDatabase.withWriteConcern <{+driver-api+}/MongoDatabase.html#withWriteConcern(com.mongodb.WriteConcern)>`__
+- `MongoCollection.withWriteConcern <{+driver-api+}/MongoCollection.html#withWriteConcern(com.mongodb.WriteConcern)>`__
 - `ReadConcern <{+core-api+}/ReadConcern.html>`__
-- `MongoDatabase.withReadConcern <{+rs-driver-api+}/MongoDatabase.html#withReadConcern(com.mongodb.ReadConcern)>`__
-- `MongoCollection.withReadConcern <{+rs-driver-api+}/MongoCollection.html#withReadPreference(com.mongodb.ReadPreference)>`__
+- `MongoDatabase.withReadConcern <{+driver-api+}/MongoDatabase.html#withReadConcern(com.mongodb.ReadConcern)>`__
+- `MongoCollection.withReadConcern <{+driver-api+}/MongoCollection.html#withReadPreference(com.mongodb.ReadPreference)>`__
 - `ReadPreference <{+core-api+}/ReadPreference.html>`__
-- `MongoDatabase.withReadPreference <{+rs-driver-api+}/MongoDatabase.html#withReadPreference(com.mongodb.ReadPreference)>`__
-- `MongoDatabase.withReadPreference <{+rs-driver-api+}/MongoCollection.html#withReadPreference(com.mongodb.ReadPreference)>`__
+- `MongoDatabase.withReadPreference <{+driver-api+}/MongoDatabase.html#withReadPreference(com.mongodb.ReadPreference)>`__
+- `MongoDatabase.withReadPreference <{+driver-api+}/MongoCollection.html#withReadPreference(com.mongodb.ReadPreference)>`__

source/read/change-streams.txt

@@ -244,7 +244,7 @@ API Documentation
 To learn more about any of the methods or types discussed in this
 guide, see the following API documentation:
 
-- `MongoClient.watch() <{+rs-driver-api+}/MongoClient.html#watch()>`__
-- `MongoCollection.watch() <{+rs-driver-api+}/MongoCollection.html#watch()>`__
-- `MongoDatabase.watch() <{+rs-driver-api+}/MongoDatabase.html#watch()>`__
-- `ChangeStreamPublisher <{+rs-driver-api+}/ChangeStreamPublisher.html>`__
+- `MongoClient.watch() <{+driver-api+}/MongoClient.html#watch()>`__
+- `MongoCollection.watch() <{+driver-api+}/MongoCollection.html#watch()>`__
+- `MongoDatabase.watch() <{+driver-api+}/MongoDatabase.html#watch()>`__
+- `ChangeStreamPublisher <{+driver-api+}/ChangeStreamPublisher.html>`__

source/read/count-documents.txt

@@ -227,6 +227,6 @@ API Documentation
 To learn more about any of the methods or types discussed in this
 guide, see the following API documentation:
 
-- `countDocuments() <{+rs-driver-api+}/MongoCollection.html#countDocuments()>`__
-- `estimatedDocumentCount() <{+rs-driver-api+}/MongoCollection.html#estimatedDocumentCount()>`__
-- `Collation <{+rs-driver-api+}/FindPublisher.html#collation(com.mongodb.client.model.Collation)>`__
+- `countDocuments() <{+driver-api+}/MongoCollection.html#countDocuments()>`__
+- `estimatedDocumentCount() <{+driver-api+}/MongoCollection.html#estimatedDocumentCount()>`__
+- `Collation <{+driver-api+}/FindPublisher.html#collation(com.mongodb.client.model.Collation)>`__

source/read/cursors.txt

@@ -103,6 +103,6 @@ API Documentation
 To learn more about any of the methods or types discussed in this
 guide, see the following API documentation:
 
-- `find() <{+rs-driver-api+}/MongoCollection.html#find()>`__
-- `FindPublisher <{+rs-driver-api+}/FindPublisher.html>`__
+- `find() <{+driver-api+}/MongoCollection.html#find()>`__
+- `FindPublisher <{+driver-api+}/FindPublisher.html>`__
 - `CursorType <{+core-api+}/CursorType.html>`__

source/read/distinct.txt

@@ -135,7 +135,7 @@ The following table describes some methods you can use to customize the
      - | Sets the maximum amount of time to allow the operation to run, in milliseconds.
 
 For a complete list of methods you can use to modify the ``distinct()`` method, see
-the `DistinctPublisher <{+rs-driver-api+}/DistinctPublisher.html>`__ API documentation.
+the `DistinctPublisher <{+driver-api+}/DistinctPublisher.html>`__ API documentation.
 
 The following example retrieves the distinct values of the ``name`` field for
 all documents that have a ``borough`` field value of ``"Bronx"`` and a
@@ -171,5 +171,5 @@ API Documentation
 To learn more about any of the methods or types discussed in this
 guide, see the following API documentation:
 
-- `distinct() <{+rs-driver-api+}/MongoCollection.html#distinct(java.lang.String,java.lang.Class)>`__
-- `DistinctPublisher <{+rs-driver-api+}/DistinctPublisher.html>`__
+- `distinct() <{+driver-api+}/MongoCollection.html#distinct(java.lang.String,java.lang.Class)>`__
+- `DistinctPublisher <{+driver-api+}/DistinctPublisher.html>`__

source/read/retrieve-data.txt

@@ -170,7 +170,7 @@ time of 10 seconds:
            .blockLast();
 
 For a full list of available arguments, see the
-`API documentation <{+rs-driver-api+}/FindPublisher.html>`__
+`API documentation <{+driver-api+}/FindPublisher.html>`__
 for the ``FindPublisher`` interface.
 
 .. _java-rs-retrieve-additional-information:
@@ -189,6 +189,6 @@ API Documentation
 To learn more about any of the methods or types discussed in this
 guide, see the following API documentation:
 
-- `find() <{+rs-driver-api+}/MongoCollection.html#find()>`__
-- `FindPublisher <{+rs-driver-api+}/FindPublisher.html>`__
-- `Collation <{+rs-driver-api+}/FindPublisher.html#collation(com.mongodb.client.model.Collation)>`__
+- `find() <{+driver-api+}/MongoCollection.html#find()>`__
+- `FindPublisher <{+driver-api+}/FindPublisher.html>`__
+- `Collation <{+driver-api+}/FindPublisher.html#collation(com.mongodb.client.model.Collation)>`__

source/read/specify-a-query.txt

@@ -265,5 +265,5 @@ API Documentation
 To learn more about any of the methods or types discussed in this
 guide, see the following API documentation:
 
-- `find() <{+rs-driver-api+}/MongoCollection.html#find()>`__
-- `FindPublisher <{+rs-driver-api+}/FindPublisher.html>`__
+- `find() <{+driver-api+}/MongoCollection.html#find()>`__
+- `FindPublisher <{+driver-api+}/FindPublisher.html>`__

source/read/specify-documents-to-return.txt

@@ -173,8 +173,8 @@ API Documentation
 To learn more about any of the methods or types discussed in this
 guide, see the following API documentation:
 
-- `FindPublisher <{+rs-driver-api+}/FindPublisher.html>`__
-- `find() <{+rs-driver-api+}/MongoCollection.html#find()>`__
-- `limit() <{+rs-driver-api+}/FindPublisher.html#limit(int)>`__
-- `sort() <{+rs-driver-api+}/FindPublisher.html#sort(org.bson.conversions.Bson)>`__
-- `skip() <{+rs-driver-api+}/FindPublisher.html#skip(int)>`__
+- `FindPublisher <{+driver-api+}/FindPublisher.html>`__
+- `find() <{+driver-api+}/MongoCollection.html#find()>`__
+- `limit() <{+driver-api+}/FindPublisher.html#limit(int)>`__
+- `sort() <{+driver-api+}/FindPublisher.html#sort(org.bson.conversions.Bson)>`__
+- `skip() <{+driver-api+}/FindPublisher.html#skip(int)>`__

source/read/specify-fields-return.txt

@@ -162,5 +162,5 @@ API Documentation
 To learn more about any of the methods or types discussed in this
 guide, see the following API Documentation:
 
-- `find() <{+rs-driver-api+}/MongoCollection.html#find()>`__
-- `FindPublisher <{+rs-driver-api+}/FindPublisher.html>`__
+- `find() <{+driver-api+}/MongoCollection.html#find()>`__
+- `FindPublisher <{+driver-api+}/FindPublisher.html>`__

source/security/enterprise-authentication.txt

@@ -154,11 +154,11 @@ You might need to specify one or more of the following additional
       instance, and pass the property name and value as parameters. Use the
       property name constants defined in the ``MongoCredential`` class:
 
-      - `SERVICE_NAME_KEY <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html#SERVICE_NAME_KEY>`__
-      - `CANONICALIZE_HOST_NAME_KEY <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html#CANONICALIZE_HOST_NAME_KEY>`__
-      - `JAVA_SUBJECT_KEY <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html#JAVA_SUBJECT_KEY>`__
-      - `JAVA_SASL_CLIENT_PROPERTIES_KEY <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html#JAVA_SASL_CLIENT_PROPERTIES_KEY>`__
-      - `JAVA_SUBJECT_PROVIDER_KEY <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html#JAVA_SUBJECT_PROVIDER_KEY>`__
+      - `SERVICE_NAME_KEY <{+api-root+}/apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html#SERVICE_NAME_KEY>`__
+      - `CANONICALIZE_HOST_NAME_KEY <{+api-root+}/apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html#CANONICALIZE_HOST_NAME_KEY>`__
+      - `JAVA_SUBJECT_KEY <{+api-root+}/apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html#JAVA_SUBJECT_KEY>`__
+      - `JAVA_SASL_CLIENT_PROPERTIES_KEY <{+api-root+}/apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html#JAVA_SASL_CLIENT_PROPERTIES_KEY>`__
+      - `JAVA_SUBJECT_PROVIDER_KEY <{+api-root+}/apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html#JAVA_SUBJECT_PROVIDER_KEY>`__
 
       Select the :guilabel:`SERVICE_NAME_KEY` or :guilabel:`JAVA_SUBJECT_KEY` tab to
       see how to specify the corresponding property:

source/whats-new.txt

@@ -67,7 +67,7 @@ and features:
    .. replacement:: vector-type-example-link
 
       To learn about this type, see the
-      `BinaryVector <{+api+}/bson/org/bson/BinaryVector.html>`__
+      `BinaryVector <{+api-root+}/bson/org/bson/BinaryVector.html>`__
       API documentation.
 
    .. replacement:: update-replace-example-link

source/write/bulk-writes.txt

@@ -584,7 +584,7 @@ guide, see the following API documentation:
 - Collection Bulk Write
 
   - `bulkWrite()
-    <{+rs-driver-api+}/MongoCollection.html#bulkWrite(com.mongodb.reactivestreams.client.ClientSession,java.util.List)>`__
+    <{+driver-api+}/MongoCollection.html#bulkWrite(com.mongodb.reactivestreams.client.ClientSession,java.util.List)>`__
   - `InsertOneModel <{+core-api+}/client/model/InsertOneModel.html>`__
   - `UpdateOneModel <{+core-api+}/client/model/UpdateOneModel.html>`__
   - `UpdateManyModel <{+core-api+}/client/model/UpdateManyModel.html>`__
@@ -598,7 +598,7 @@ guide, see the following API documentation:
 - Client Bulk Write
 
   - `bulkWrite()
-    <{+rs-driver-api+}/MongoCluster.html#bulkWrite(java.util.List,com.mongodb.client.model.bulk.ClientBulkWriteOptions)>`__
+    <{+driver-api+}/MongoCluster.html#bulkWrite(java.util.List,com.mongodb.client.model.bulk.ClientBulkWriteOptions)>`__
   - `ClientNamespacedWriteModel <{+core-api+}/client/model/bulk/ClientNamespacedWriteModel.html>`__
   - `MongoNamespace <{+core-api+}/MongoNamespace.html>`__
   - `ClientBulkWriteOptions <{+core-api+}/client/model/bulk/ClientBulkWriteOptions.html>`__

source/write/insert-documents.txt

@@ -201,10 +201,10 @@ API Documentation
 To learn more about any of the methods or types discussed in this
 guide, see the following API documentation:
 
-- `insertOne() <{+rs-driver-api+}/MongoCollection.html#insertOne(com.mongodb.reactivestreams.client.ClientSession,TDocument)>`__
+- `insertOne() <{+driver-api+}/MongoCollection.html#insertOne(com.mongodb.reactivestreams.client.ClientSession,TDocument)>`__
 - `insertMany()
-  <{+rs-driver-api+}/MongoCollection.html#insertMany(com.mongodb.reactivestreams.client.ClientSession,java.util.List)>`__
+  <{+driver-api+}/MongoCollection.html#insertMany(com.mongodb.reactivestreams.client.ClientSession,java.util.List)>`__
 - `InsertOneOptions <{+core-api+}/client/model/InsertOneOptions.html>`__
 - `InsertManyOptions
   <{+core-api+}/client/model/InsertManyOptions.html>`__
-- `BsonValue <{+api+}/bson/org/bson/BsonValue.html>`__
+- `BsonValue <{+api-root+}/bson/org/bson/BsonValue.html>`__

source/write/replace-documents.txt

@@ -218,8 +218,8 @@ API Documentation
 To learn more about any of the methods or types discussed in this
 guide, see the following API documentation:
 
-- `replaceOne() <{+rs-driver-api+}/MongoCollection.html#replaceOne(org.bson.conversions.Bson,TDocument)>`__
+- `replaceOne() <{+driver-api+}/MongoCollection.html#replaceOne(org.bson.conversions.Bson,TDocument)>`__
 - `ReplaceOptions
   <{+core-api+}/client/model/ReplaceOptions.html>`__
 - `UpdateResult <{+core-api+}/client/result/UpdateResult.html>`__
-- `BsonValue <{+api+}/bson/org/bson/BsonValue.html>`__
+- `BsonValue <{+api-root+}/bson/org/bson/BsonValue.html>`__

source/write/run-command.txt

@@ -67,4 +67,4 @@ API Documentation
 ~~~~~~~~~~~~~~~~~
 
 To learn more about the ``runCommand()`` method, see the
-`runCommand() API documentation <{+rs-driver-api+}/MongoDatabase.html#runCommand(org.bson.conversions.Bson)>`__.
+`runCommand() API documentation <{+driver-api+}/MongoDatabase.html#runCommand(org.bson.conversions.Bson)>`__.

source/write/transactions.txt

@@ -135,8 +135,8 @@ API Documentation
 To learn more about any of the types or methods discussed in this
 guide, see the following API Documentation:
 
-- `MongoClient <{+rs-driver-api+}/MongoClient.html>`__
-- `startSession() <{+rs-driver-api+}/MongoClient.html#startSession()>`__
-- `startTransaction() <{+rs-driver-api+}/ClientSession.html#startTransaction()>`__
-- `abortTransaction() <{+rs-driver-api+}/ClientSession.html#abortTransaction()>`__
-- `commitTransaction() <{+rs-driver-api+}/ClientSession.html#commitTransaction()>`__
+- `MongoClient <{+driver-api+}/MongoClient.html>`__
+- `startSession() <{+driver-api+}/MongoClient.html#startSession()>`__
+- `startTransaction() <{+driver-api+}/ClientSession.html#startTransaction()>`__
+- `abortTransaction() <{+driver-api+}/ClientSession.html#abortTransaction()>`__
+- `commitTransaction() <{+driver-api+}/ClientSession.html#commitTransaction()>`__

source/write/write-delete-documents.txt

@@ -176,13 +176,13 @@ API Documentation
 To learn more about any of the methods or types discussed in this
 guide, see the following API documentation:
 
-- `deleteOne() <{+rs-driver-api+}/MongoCollection.html#deleteOne(com.mongodb.reactivestreams.client.ClientSession,org.bson.conversions.Bson)>`__
+- `deleteOne() <{+driver-api+}/MongoCollection.html#deleteOne(com.mongodb.reactivestreams.client.ClientSession,org.bson.conversions.Bson)>`__
 - `deleteMany()
-  <{+rs-driver-api+}/MongoCollection.html#deleteMany(com.mongodb.reactivestreams.client.ClientSession,org.bson.conversions.Bson)>`__
+  <{+driver-api+}/MongoCollection.html#deleteMany(com.mongodb.reactivestreams.client.ClientSession,org.bson.conversions.Bson)>`__
 - `DeleteOptions
   <{+core-api+}/client/model/DeleteOptions.html>`__
 - `BsonValue
-  <{+api+}/bson/org/bson/BsonValue.html>`__
+  <{+api-root+}/bson/org/bson/BsonValue.html>`__
 - `Collation
   <{+core-api+}/client/model/Collation.html>`__