DOCSP-48687 - Standardize API source constants

snooty.toml

@@ -30,9 +30,9 @@ full-version = "{+version-number+}.0"
 version = "v{+version-number+}"
 mdb-server = "MongoDB Server"
 stable-api = "Stable API"
-api = "https://mongodb.github.io/mongo-java-driver/{+version-number+}/apidocs/mongodb-driver-kotlin-sync/mongodb-driver-kotlin-sync"
-java-api = "https://mongodb.github.io/mongo-java-driver/{+version-number+}"
-core-api = "{+java-api+}/apidocs/mongodb-driver-core"
+api-root = "https://mongodb.github.io/mongo-java-driver/{+version-number+}/apidocs"
+driver-api = "{+api-root+}/mongodb-driver-kotlin-sync/mongodb-driver-kotlin-sync/com.mongodb.kotlin.client"
+core-api = "{+api-root+}/mongodb-driver-core/com/mongodb"
 kotlin-docs = "https://kotlinlang.org"
 serialization-version = "1.6.0"
 kotlinx-dt-version = "0.6.1"

source/aggregation.txt

@@ -216,5 +216,5 @@ API Documentation
 For more information about executing aggregation operations with the {+driver-short+},
 see the following API documentation:
 
-- `aggregate() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/aggregate.html>`__
-- `AggregateIterable <{+api+}/com.mongodb.kotlin.client/-aggregate-iterable/index.html>`__
+- `aggregate() <{+driver-api+}/-mongo-collection/aggregate.html>`__
+- `AggregateIterable <{+driver-api+}/-aggregate-iterable/index.html>`__

source/api.txt

@@ -8,19 +8,19 @@ API Documentation
    :titlesonly:
    :maxdepth: 1
 
-   {+language+} Sync Driver <{+java-api+}/apidocs/mongodb-driver-kotlin-sync/index.html>
-   BSON kotlinx.serialization <{+java-api+}/apidocs/bson-kotlinx/index.html>
-   {+language+} Driver Extensions <{+java-api+}/apidocs/mongodb-driver-kotlin-extensions/index.html>
-   Driver Core <{+core-api+}/index.html>
+   {+language+} Sync Driver <{+api-root+}/mongodb-driver-kotlin-sync/index.html>
+   BSON kotlinx.serialization <{+api-root+}/bson-kotlinx/index.html>
+   {+language+} Driver Extensions <{+api-root+}/mongodb-driver-kotlin-extensions/index.html>
+   Driver Core <{+api-root+}/mongodb-driver-core/index.html>
 
-- `{+language+} Sync Driver <{+java-api+}/apidocs/mongodb-driver-kotlin-sync/index.html>`__ -
+- `{+language+} Sync Driver <{+api-root+}/mongodb-driver-kotlin-sync/index.html>`__ -
   classes for the current synchronous driver API.
-- `BSON kotlinx.serialization <{+java-api+}/apidocs/bson-kotlinx/index.html>`__ -
+- `BSON kotlinx.serialization <{+api-root+}/bson-kotlinx/index.html>`__ -
   classes for encoding and decoding between Kotlin data classes and the BSON data
   format using :github:`kotlinx.serialization <Kotlin/kotlinx.serialization>`.
 - `{+language+} Driver Extensions
-  <{+java-api+}/apidocs/mongodb-driver-kotlin-extensions/index.html>`__ -
+  <{+api-root+}/mongodb-driver-kotlin-extensions/index.html>`__ -
   classes that extend the core builder classes to support :ref:`data
   classes <kotlin-sync-builders-data-classes>`.
-- `Driver Core <{+core-api+}/index.html>`__ - classes that
+- `Driver Core <{+api-root+}/mongodb-driver-core/index.html>`__ - classes that
   contain essential driver functionality.

source/builders.txt

@@ -33,13 +33,13 @@ efficiently build queries and aggregations.
 To learn more about the available builder classes and methods, see the
 following API documentation sections:
 
-- `Accumulators <{+core-api+}/com/mongodb/client/model/Accumulators.html>`__
-- `Aggregates <{+core-api+}/com/mongodb/client/model/Aggregates.html>`__
-- `Filters <{+core-api+}/com/mongodb/client/model/Filters.html>`__
-- `Indexes <{+core-api+}/com/mongodb/client/model/Indexes.html>`__
-- `Projections <{+core-api+}/com/mongodb/client/model/Projections.html>`__
-- `Sorts <{+core-api+}/com/mongodb/client/model/Sorts.html>`__
-- `Updates <{+core-api+}/com/mongodb/client/model/Updates.html>`__
+- `Accumulators <{+core-api+}/client/model/Accumulators.html>`__
+- `Aggregates <{+core-api+}/client/model/Aggregates.html>`__
+- `Filters <{+core-api+}/client/model/Filters.html>`__
+- `Indexes <{+core-api+}/client/model/Indexes.html>`__
+- `Projections <{+core-api+}/client/model/Projections.html>`__
+- `Sorts <{+core-api+}/client/model/Sorts.html>`__
+- `Updates <{+core-api+}/client/model/Updates.html>`__
 
 Why Use Builders?
 -----------------

source/builders/builders-data-classes.txt

@@ -259,4 +259,4 @@ API Documentation
 -----------------
 
 - `{+driver-short+} Extensions
-  <{+core-api+}/apidocs/mongodb-driver-kotlin-extensions/index.html>`__
+  <{+api-root+}/mongodb-driver-kotlin-extensions/index.html>`__

source/connect/connection-options.txt

@@ -341,9 +341,9 @@ API Documentation
 To learn more about the classes and methods mentioned in this guide, see
 the following API documentation:
 
-- `MongoClientSettings <{+java-api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.html>`__
-- `MongoClientSettings.Builder <{+java-api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html>`__
-- `ConnectionString <{+java-api+}/apidocs/mongodb-driver-core/com/mongodb/ConnectionString.html>`__
-- `SocketSettings <{+java-api+}/apidocs/mongodb-driver-core/com/mongodb/connection/SocketSettings.html>`__
-- `ClusterSettings <{+java-api+}/apidocs/mongodb-driver-core/com/mongodb/connection/ClusterSettings.html>`__
-- `MongoCredential <{+java-api+}/apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html>`__
+- `MongoClientSettings <{+core-api+}/MongoClientSettings.html>`__
+- `MongoClientSettings.Builder <{+core-api+}/MongoClientSettings.Builder.html>`__
+- `ConnectionString <{+core-api+}/ConnectionString.html>`__
+- `SocketSettings <{+core-api+}/connection/SocketSettings.html>`__
+- `ClusterSettings <{+core-api+}/connection/ClusterSettings.html>`__
+- `MongoCredential <{+core-api+}/MongoCredential.html>`__

source/connect/mongoclient.txt

@@ -126,5 +126,5 @@ API Documentation
 For more information about creating a ``MongoClient`` object with the 
 {+driver-short+}, see the following API documentation: 
 
-- `MongoClient <{+api+}/mongodb-driver-kotlin-sync/com.mongodb.kotlin.client/-mongo-client/index.html>`__
-- `MongoClientSettings <{+core-api+}com/mongodb/MongoClientSettings.html>`__
+- `MongoClient <{+driver-api+}/-mongo-client/index.html>`__
+- `MongoClientSettings <{+core-api+}/MongoClientSettings.html>`__

source/connect/stable-api.txt

@@ -123,11 +123,11 @@ API Documentation
 For more information about using the {+stable-api+} with the {+driver-short+}, see the 
 following API documentation: 
 
-- `ServerApi <{+core-api+}/com/mongodb/ServerApi.html>`__
-- `ServerApi.Builder <{+core-api+}/com/mongodb/ServerApi.Builder.html>`__
-- `ServerApiVersion <{+core-api+}/com/mongodb/ServerApiVersion.html>`__
-- `ServerAddress <{+core-api+}/com/mongodb/ServerAddress.html>`__
-- `MongoClientSettings <{+core-api+}/com/mongodb/MongoClientSettings.html>`__
-- `MongoClientSettings.Builder <{+core-api+}/com/mongodb/MongoClientSettings.Builder.html>`__
-- `MongoClient <{+api+}/com.mongodb.kotlin.client/-mongo-client/index.html>`__
-- `MongoClient.create() <{+api+}/com.mongodb.kotlin.client/-mongo-client/-factory/create.html>`__
+- `ServerApi <{+core-api+}/ServerApi.html>`__
+- `ServerApi.Builder <{+core-api+}/ServerApi.Builder.html>`__
+- `ServerApiVersion <{+core-api+}/ServerApiVersion.html>`__
+- `ServerAddress <{+core-api+}/ServerAddress.html>`__
+- `MongoClientSettings <{+core-api+}/MongoClientSettings.html>`__
+- `MongoClientSettings.Builder <{+core-api+}/MongoClientSettings.Builder.html>`__
+- `MongoClient <{+driver-api+}/-mongo-client/index.html>`__
+- `MongoClient.create() <{+driver-api+}/-mongo-client/-factory/create.html>`__

source/connect/tls.txt

@@ -325,5 +325,5 @@ API Documentation
 For more information about any of the methods or types discussed in this guide,
 see the following API documentation:
 
-- `ConnectionString <{+core-api+}/com/mongodb/ConnectionString.html>`__
-- `MongoClientSettings <{+core-api+}/com/mongodb/MongoClientSettings.html>`__
+- `ConnectionString <{+core-api+}/ConnectionString.html>`__
+- `MongoClientSettings <{+core-api+}/MongoClientSettings.html>`__

source/data-formats/bson.txt

@@ -35,12 +35,12 @@ MongoDB and BSON
 ----------------
 
 You can work with BSON data in your {+driver-short+} application by using one of the
-following object types that implements the `BSON interface <{+java-api+}/apidocs/bson/org/bson/conversions/Bson.html>`__:
+following object types that implements the `BSON interface <{+api-root+}/bson/org/bson/conversions/Bson.html>`__:
 
-- `Document <{+java-api+}/apidocs/bson/org/bson/Document.html>`__ (BSON library package)
-- `BsonDocument <{+java-api+}/apidocs/bson/org/bson/BsonDocument.html>`__ (BSON library package)
-- `RawBsonDocument <{+java-api+}/apidocs/bson/org/bson/RawBsonDocument.html>`__ (BSON library package)
-- `JsonObject <{+java-api+}/apidocs/bson/org/bson/json/JsonObject.html>`__ (BSON library package)
+- `Document <{+api-root+}/bson/org/bson/Document.html>`__ (BSON library package)
+- `BsonDocument <{+api-root+}/bson/org/bson/BsonDocument.html>`__ (BSON library package)
+- `RawBsonDocument <{+api-root+}/bson/org/bson/RawBsonDocument.html>`__ (BSON library package)
+- `JsonObject <{+api-root+}/bson/org/bson/json/JsonObject.html>`__ (BSON library package)
 
 .. _install-bson-library:
 

source/data-formats/codecs.txt

@@ -142,13 +142,13 @@ your ``Codec`` in your registry.
 To learn more about the classes and interfaces mentioned in this section, see the
 following API documentation:
 
-- `Codec <{+java-api+}/apidocs/bson/org/bson/codecs/Codec.html>`__
-- `BsonWriter <{+java-api+}/apidocs/bson/org/bson/BsonWriter.html>`__
-- `BsonBinaryWriter <{+java-api+}/apidocs/bson/org/bson/BsonBinaryWriter.html>`__
-- `EncoderContext <{+java-api+}/apidocs/bson/org/bson/codecs/EncoderContext.html>`__
-- `BsonReader <{+java-api+}/apidocs/bson/org/bson/BsonReader.html>`__
-- `DecoderContext <{+java-api+}/apidocs/bson/org/bson/codecs/DecoderContext.html>`__
-- `BsonBinaryReader <{+java-api+}/apidocs/bson/org/bson/BsonBinaryReader.html>`__
+- `Codec <{+api-root+}/bson/org/bson/codecs/Codec.html>`__
+- `BsonWriter <{+api-root+}/bson/org/bson/BsonWriter.html>`__
+- `BsonBinaryWriter <{+api-root+}/bson/org/bson/BsonBinaryWriter.html>`__
+- `EncoderContext <{+api-root+}/bson/org/bson/codecs/EncoderContext.html>`__
+- `BsonReader <{+api-root+}/bson/org/bson/BsonReader.html>`__
+- `DecoderContext <{+api-root+}/bson/org/bson/codecs/DecoderContext.html>`__
+- `BsonBinaryReader <{+api-root+}/bson/org/bson/BsonBinaryReader.html>`__
 
 .. _kotlin-sync-codecregistry:
 
@@ -195,8 +195,8 @@ registered, the ``codecRegistry.get()`` method raises a
 For more information about the classes and interfaces in this section, see the
 following API documentation:
 
-- `CodecRegistries <{+java-api+}/apidocs/bson/org/bson/codecs/configuration/CodecRegistries.html>`__
-- `IntegerCodec <{+java-api+}/apidocs/bson/org/bson/codecs/IntegerCodec.html>`__
+- `CodecRegistries <{+api-root+}/bson/org/bson/codecs/configuration/CodecRegistries.html>`__
+- `IntegerCodec <{+api-root+}/bson/org/bson/codecs/IntegerCodec.html>`__
 
 .. _kotlin-sync-codecprovider:
 
@@ -251,8 +251,8 @@ following example:
 For more information about the classes and interfaces in this section, see
 the following API documentation:
 
-- `CodecProvider <{+java-api+}/apidocs/bson/org/bson/codecs/configuration/CodecProvider.html>`__
-- `getCodecRegistry() <{+java-api+}/apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#getCodecRegistry()>`__
+- `CodecProvider <{+api-root+}/bson/org/bson/codecs/configuration/CodecProvider.html>`__
+- `getCodecRegistry() <{+api-root+}/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#getCodecRegistry()>`__
 
 BsonTypeClassMap
 ~~~~~~~~~~~~~~~~
@@ -306,7 +306,7 @@ instance with the ``Set`` class:
 
 For a complete list of the default mappings, view the
 `BsonTypeClassMap
-<{+java-api+}/apidocs/bson/org/bson/codecs/BsonTypeClassMap.html>`__ API
+<{+api-root+}/bson/org/bson/codecs/BsonTypeClassMap.html>`__ API
 documentation.
 
 .. _kotlin-sync-codec-custom-example:
@@ -386,5 +386,5 @@ retrieves data by using the ``Monolight`` class:
 For more information about the methods and classes mentioned in this section,
 see the following API documentation:
 
-- `withCodecRegistry() <{+java-api+}/apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#withCodecRegistry(org.bson.codecs.configuration.CodecRegistry)>`__
-- `fromRegistries() <{+java-api+}/apidocs/bson/org/bson/codecs/configuration/CodecRegistries.html#fromRegistries(org.bson.codecs.configuration.CodecRegistry...)>`__
+- `withCodecRegistry() <{+api-root+}/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#withCodecRegistry(org.bson.codecs.configuration.CodecRegistry)>`__
+- `fromRegistries() <{+api-root+}/bson/org/bson/codecs/configuration/CodecRegistries.html#fromRegistries(org.bson.codecs.configuration.CodecRegistry...)>`__

source/data-formats/data-format-data-class.txt

@@ -133,7 +133,7 @@ You can use the following annotations on data classes:
 
 To learn more these property annotations,
 see to the `org.bson.codecs.pojo.annotations
-<{+java-api+}/apidocs/bson/org/bson/codecs/pojo/annotations/package-summary.html>`__
+<{+api-root+}/bson/org/bson/codecs/pojo/annotations/package-summary.html>`__
 Package API documentation.
 
 Annotated Data Class Example

source/data-formats/serialization.txt

@@ -96,7 +96,7 @@ dependencies to your project by using either :guilabel:`Gradle` or
    and the codec registry to support {+language+} data classes, but it does
    not support certain POJO annotations such as ``BsonDiscriminator``,
    ``BsonExtraElements``, and ``BsonConstructor``. To learn more, see
-   the `bson-kotlin API documentation <{+java-api+}/apidocs/bson-kotlin/index.html>`__.
+   the `bson-kotlin API documentation <{+api-root+}/bson-kotlin/index.html>`__.
 
    Generally, we recommend that you install and use the faster
    ``bson-kotlinx`` library for codec configuration.
@@ -188,10 +188,10 @@ see the following API documentation:
   <{+kotlin-docs+}/api/kotlinx-datetime/kotlinx-datetime/kotlinx.datetime/-instant/>`__ in the {+language+} documentation
 
 - `BsonEncoder
-  <{+java-api+}/apidocs/bson-kotlinx/bson-kotlinx/org.bson.codecs.kotlinx/-bson-encoder/index.html>`__
+  <{+api-root+}/bson-kotlinx/bson-kotlinx/org.bson.codecs.kotlinx/-bson-encoder/index.html>`__
 
 - `BsonDecoder
-  <{+java-api+}/apidocs/bson-kotlinx/bson-kotlinx/org.bson.codecs.kotlinx/-bson-decoder/index.html>`__
+  <{+api-root+}/bson-kotlinx/bson-kotlinx/org.bson.codecs.kotlinx/-bson-decoder/index.html>`__
 
 .. _kotlin-sync-custom-codec:
 
@@ -211,7 +211,7 @@ dependency. See the :ref:`kotlin-sync-add-serialization` section of this
 guide for installation instructions.
 
 You can define your codec by using the `KotlinSerializerCodec.create()
-<{+java-api+}/apidocs/bson-kotlinx/bson-kotlinx/org.bson.codecs.kotlinx/-kotlin-serializer-codec/-companion/index.html>`__
+<{+api-root+}/bson-kotlinx/bson-kotlinx/org.bson.codecs.kotlinx/-kotlin-serializer-codec/-companion/index.html>`__
 method, then you can add the codec to the registry.
 
 Custom Codec Example
@@ -231,13 +231,13 @@ To learn more about the methods and classes mentioned in this section,
 see the following API documentation:
 
 - `KotlinSerializerCodec
-  <{+java-api+}/apidocs/bson-kotlinx/bson-kotlinx/org.bson.codecs.kotlinx/-kotlin-serializer-codec/index.html>`__
+  <{+api-root+}/bson-kotlinx/bson-kotlinx/org.bson.codecs.kotlinx/-kotlin-serializer-codec/index.html>`__
 
 - `KotlinSerializerCodec.create()
-  <{+java-api+}/apidocs/bson-kotlinx/bson-kotlinx/org.bson.codecs.kotlinx/-kotlin-serializer-codec/-companion/create.html>`__
+  <{+api-root+}/bson-kotlinx/bson-kotlinx/org.bson.codecs.kotlinx/-kotlin-serializer-codec/-companion/create.html>`__
 
 - `BsonConfiguration
-  <{+java-api+}/apidocs/bson-kotlinx/bson-kotlinx/org.bson.codecs.kotlinx/-bson-configuration/index.html>`__
+  <{+api-root+}/bson-kotlinx/bson-kotlinx/org.bson.codecs.kotlinx/-bson-configuration/index.html>`__
 
 .. _kotlin-sync-polymorphic:
 

source/data-formats/time-series.txt

@@ -62,8 +62,8 @@ To create a time series collection, pass the following parameters to the
 
 - The name of the new collection to create
 
-- A `CreateCollectionOptions <{+core-api+}/com/mongodb/client/model/CreateCollectionOptions.html>`__
-  object with the `TimeSeriesOptions <{+core-api+}/com/mongodb/client/model/TimeSeriesOptions.html>`__ set
+- A `CreateCollectionOptions <{+core-api+}/client/model/CreateCollectionOptions.html>`__
+  object with the `TimeSeriesOptions <{+core-api+}/client/model/TimeSeriesOptions.html>`__ set
   using the ``timeSeriesOptions()`` method
 
 .. _kotlin-sync-time-series-create-example:
@@ -174,7 +174,7 @@ API Documentation
 To learn more about the methods mentioned in this guide, see the following
 API documentation:
 
-- `createCollection() <{+api+}/com.mongodb.kotlin.client/-mongo-database/create-collection.html>`__
-- `listCollections() <{+api+}/com.mongodb.kotlin.client/-mongo-database/list-collections.html>`__
-- `insertOne() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/insert-one.html>`__
-- `insertMany() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/insert-many.html>`__
+- `createCollection() <{+driver-api+}/-mongo-database/create-collection.html>`__
+- `listCollections() <{+driver-api+}/-mongo-database/list-collections.html>`__
+- `insertOne() <{+driver-api+}/-mongo-collection/insert-one.html>`__
+- `insertMany() <{+driver-api+}/-mongo-collection/insert-many.html>`__

source/indexes/atlas-search-index.txt

@@ -62,15 +62,15 @@ Create a Search Index
 ---------------------
 
 You can use the `createSearchIndex()
-<{+api+}/com.mongodb.kotlin.client/-mongo-collection/create-search-index.html>`__
+<{+driver-api+}/-mongo-collection/create-search-index.html>`__
 method to create a single Atlas Search index. You *cannot* use this method to
 create a Vector Search index.
 
 You can use the `createSearchIndexes()
-<{+api+}/com.mongodb.kotlin.client/-mongo-collection/create-search-indexes.html>`__
+<{+driver-api+}/-mongo-collection/create-search-indexes.html>`__
 method to create multiple Atlas Search or Vector Search
 indexes. You must create a `SearchIndexModel
-<{+core-api+}/com/mongodb/client/model/SearchIndexModel.html>`__
+<{+core-api+}/client/model/SearchIndexModel.html>`__
 instance for each index, then pass a list of ``SearchIndexModel``
 instances to the ``createSearchIndexes()`` method.
 
@@ -101,7 +101,7 @@ List Search Indexes
 -------------------
 
 You can use the
-`listSearchIndexes() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/list-search-indexes.html>`__
+`listSearchIndexes() <{+driver-api+}/-mongo-collection/list-search-indexes.html>`__
 method to return all Atlas Search indexes in a collection.
 
 The following code example shows how to print a list of the search indexes in
@@ -119,7 +119,7 @@ Update a Search Index
 ---------------------
 
 You can use the
-`updateSearchIndex() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/update-search-index.html>`__
+`updateSearchIndex() <{+driver-api+}/-mongo-collection/update-search-index.html>`__
 method to update an Atlas Search index.
 
 The following code shows how to update a search index:
@@ -136,7 +136,7 @@ Delete a Search Index
 ---------------------
 
 You can use the
-`dropSearchIndex() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/drop-search-index.html>`__
+`dropSearchIndex() <{+driver-api+}/-mongo-collection/drop-search-index.html>`__
 method to delete an Atlas Search index.
 
 The following code shows how to delete a search index from a collection:

source/indexes/compound-index.txt

@@ -93,6 +93,6 @@ API Documentation
 To learn more about any of the methods discussed in this guide, see the following API
 documentation:
 
-- `find() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/find.html>`__
-- `filter() <{+api+}/com.mongodb.kotlin.client/-find-iterable/filter.html>`__
-- `sort() <{+api+}/com.mongodb.kotlin.client/-find-iterable/sort.html>`__
+- `find() <{+driver-api+}/-mongo-collection/find.html>`__
+- `filter() <{+driver-api+}/-find-iterable/filter.html>`__
+- `sort() <{+driver-api+}/-find-iterable/sort.html>`__