DOCSP-48687 - Standardize API Source Constants (#666)

Author: mongoKart

snooty.toml

@@ -30,8 +30,9 @@ version = "5.4"
 full-version = "{+version+}.0"
 mdb-server = "MongoDB Server"
 package-name-org = "mongodb-org"
-api = "https://mongodb.github.io/mongo-java-driver/{+version+}"
-core-api = "https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/mongodb-driver-core"
+api-root = "https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs"
+driver-api = "{+api-root+}/mongodb-driver-sync/com/mongodb/client"
+core-api = "{+api-root+}/mongodb-driver-core/com/mongodb"
 stable-api = "Stable API"
 mongocrypt-version = "{+full-version+}"
 nettyVersion = "io.netty:netty-all:4.1.87.Final"

source/aggregation.txt

@@ -74,7 +74,7 @@ Aggregation operations have some :manual:`limitations </core/aggregation-pipelin
   of 16 megabytes.
 
 - Pipeline stages have a memory limit of 100 megabytes by default. If required, you can exceed this limit by using
-  the `allowDiskUse <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/AggregateIterable.html#allowDiskUse(java.lang.Boolean)>`__
+  the `allowDiskUse <{+driver-api+}/AggregateIterable.html#allowDiskUse(java.lang.Boolean)>`__
   method.
 
   .. important:: ``$graphLookup`` exception

source/aggregation/aggregation-examples.txt

@@ -73,7 +73,7 @@ To perform an aggregation, pass a list of aggregation stages to the
 ``MongoCollection.aggregate()`` method.
 
 The Java driver provides the
-`Aggregates <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html>`__
+`Aggregates <{+core-api+}/client/model/Aggregates.html>`__
 helper class that contains builders for aggregation stages.
 
 In the following example, the aggregation pipeline:
@@ -106,8 +106,8 @@ The preceding aggregation produces the following results:
 For more information about the methods and classes mentioned in this section,
 see the following API Documentation:
 
-- `MongoCollection.aggregate() <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#aggregate(java.util.List)>`__
-- `Aggregates.match <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html#match(org.bson.conversions.Bson)>`__
+- `MongoCollection.aggregate() <{+driver-api+}/MongoCollection.html#aggregate(java.util.List)>`__
+- `Aggregates.match <{+core-api+}/client/model/Aggregates.html#match(org.bson.conversions.Bson)>`__
 
 Explain Aggregation Example
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -161,9 +161,9 @@ following resources:
 
 - :manual:`Explain Output </reference/explain-results/>` Server Manual Entry
 - :manual:`Query Plans </core/query-plans/>` Server Manual Entry
-- `ExplainVerbosity <{+api+}/apidocs/mongodb-driver-core/com/mongodb/ExplainVerbosity>`__ API Documentation
-- `explain() <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/FindIterable.html#explain()>`__ API Documentation
-- `AggregateIterable <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/AggregateIterable.html>`__ API Documentation
+- `ExplainVerbosity <{+core-api+}/ExplainVerbosity>`__ API Documentation
+- `explain() <{+driver-api+}/FindIterable.html#explain()>`__ API Documentation
+- `AggregateIterable <{+driver-api+}/AggregateIterable.html>`__ API Documentation
 
 Aggregation Expression Example
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -224,7 +224,7 @@ The preceding aggregation produces the following results:
 For more information about the methods and classes mentioned in this section,
 see the following API Documentation:
 
-- `Accumulators <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html>`__
-- `$group <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html#group(TExpression,java.util.List)>`__
-- `$project <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html#project(org.bson.conversions.Bson)>`__
-- `Projections <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Projections.html>`__
+- `Accumulators <{+core-api+}/client/model/Accumulators.html>`__
+- `$group <{+core-api+}/client/model/Aggregates.html#group(TExpression,java.util.List)>`__
+- `$project <{+core-api+}/client/model/Aggregates.html#project(org.bson.conversions.Bson)>`__
+- `Projections <{+core-api+}/client/model/Projections.html>`__

source/aggregation/aggregation-expression-operations.txt

@@ -7,26 +7,26 @@ API Documentation
 .. meta::
    :description: Read the API documentation for the {+driver-long+} and related packages.
 
-- `BSON <{+api+}/apidocs/bson/index.html>`__ - classes for working with the 
+- `BSON <{+api-root+}/bson/index.html>`__ - classes for working with the 
   BSON data format.
-- `BSON Record Codec <{+api+}/apidocs/bson-record-codec/index.html>`__ - 
+- `BSON Record Codec <{+api-root+}/bson-record-codec/index.html>`__ - 
   classes for encoding and decoding between Java records and the BSON data 
   format.
-- `Core <{+api+}/apidocs/mongodb-driver-core/index.html>`__ - classes that
+- `Core <{+api-root+}/mongodb-driver-core/index.html>`__ - classes that
   contain essential driver functionality.
-- `Java Driver (modern API) <{+api+}/apidocs/mongodb-driver-sync/index.html>`__ -
+- `Java Driver (modern API) <{+api-root+}/mongodb-driver-sync/index.html>`__ -
   classes for the current driver API.
-- `Java Driver (legacy API) <{+api+}/apidocs/mongodb-driver-legacy/index.html>`__ -
+- `Java Driver (legacy API) <{+api-root+}/mongodb-driver-legacy/index.html>`__ -
   classes that support the legacy driver API. To learn how to upgrade from the
   legacy API to the modern API from the :ref:`<java-legacy-api>` documentation.
 
 .. toctree::
    :titlesonly:
    :maxdepth: 1
 
-    BSON <{+api+}/apidocs/bson/index.html>
-    BSON Record Codec <{+api+}/apidocs/bson-record-codec/index.html>
-    Core <{+api+}/apidocs/mongodb-driver-core/index.html>
-    Java Driver (modern API) <{+api+}/apidocs/mongodb-driver-sync/index.html>
-    Java Driver (legacy API) <{+api+}/apidocs/mongodb-driver-legacy/index.html>
+    BSON <{+api-root+}/bson/index.html>
+    BSON Record Codec <{+api-root+}/bson-record-codec/index.html>
+    Core <{+api-root+}/mongodb-driver-core/index.html>
+    Java Driver (modern API) <{+api-root+}/mongodb-driver-sync/index.html>
+    Java Driver (legacy API) <{+api-root+}/mongodb-driver-legacy/index.html>
 

source/api-documentation.txt

@@ -102,6 +102,6 @@ API Documentation
 To learn more about the methods mentioned in this guide, see
 the following API documentation:
 
-- `MongoCollection.aggregate() <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#aggregate(java.util.List)>`__
-- `Aggregates.search() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html#search(com.mongodb.client.model.search.SearchCollector)>`__
-- `Aggregates.project() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html#project(org.bson.conversions.Bson)>`__
+- `MongoCollection.aggregate() <{+driver-api+}/MongoCollection.html#aggregate(java.util.List)>`__
+- `Aggregates.search() <{+core-api+}/client/model/Aggregates.html#search(com.mongodb.client.model.search.SearchCollector)>`__
+- `Aggregates.project() <{+core-api+}/client/model/Aggregates.html#project(org.bson.conversions.Bson)>`__

source/atlas-search.txt

@@ -93,15 +93,15 @@ To learn more about the methods and types mentioned in this
 guide, see the following API documentation:
 
 - `Aggregates.vectorSearch()
-  <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html#vectorSearch(com.mongodb.client.model.search.FieldSearchPath,java.lang.Iterable,java.lang.String,long,com.mongodb.client.model.search.VectorSearchOptions)>`__
+  <{+core-api+}/client/model/Aggregates.html#vectorSearch(com.mongodb.client.model.search.FieldSearchPath,java.lang.Iterable,java.lang.String,long,com.mongodb.client.model.search.VectorSearchOptions)>`__
 
 - `FieldSearchPath
-  <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/search/FieldSearchPath.html>`__
+  <{+core-api+}/client/model/search/FieldSearchPath.html>`__
 
 - `VectorSearchOptions
-  <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/search/VectorSearchOptions.html>`__
+  <{+core-api+}/client/model/search/VectorSearchOptions.html>`__
 
 - `Projections.metaVectorSearchScore()
-  <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Projections.html#metaVectorSearchScore(java.lang.String)>`__
+  <{+core-api+}/client/model/Projections.html#metaVectorSearchScore(java.lang.String)>`__
 
-- `BinaryVector <{+api+}/apidocs/bson/org/bson/BinaryVector.html>`__
+- `BinaryVector <{+api-root+}/bson/org/bson/BinaryVector.html>`__

source/atlas-vector-search.txt

@@ -24,7 +24,7 @@ Aggregates Builders
 Overview
 --------
 
-In this guide, you can learn how to use the `Aggregates <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates>`__
+In this guide, you can learn how to use the `Aggregates <{+core-api+}/client/model/Aggregates>`__
 class which provides static factory methods that build :manual:`aggregation pipeline
 stages </meta/aggregation-quick-reference/#stages>` in the MongoDB Java driver.
 
@@ -258,7 +258,7 @@ for each distinct grouping.
 
 .. tip::
 
-   The driver includes the `Accumulators <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html>`__
+   The driver includes the `Accumulators <{+core-api+}/client/model/Accumulators.html>`__
    class with static factory methods for each of the supported accumulators.
 
 The following example creates a pipeline stage that groups documents by the value
@@ -327,7 +327,7 @@ the lowest three ``imdb.rating`` values for movies, grouped by ``year``:
    :language: java
    :dedent:
 
-See the `minN() API documentation <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html#minN(java.lang.String,InExpression,NExpression)>`__
+See the `minN() API documentation <{+core-api+}/client/model/Accumulators.html#minN(java.lang.String,InExpression,NExpression)>`__
 for more information.
 
 .. _java_aggregates_max_n:
@@ -347,7 +347,7 @@ return the highest two ``imdb.rating`` values for movies, grouped by ``year``:
    :language: java
    :dedent:
 
-See the `maxN() API documentation <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html#maxN(java.lang.String,InExpression,NExpression)>`__
+See the `maxN() API documentation <{+core-api+}/client/model/Accumulators.html#maxN(java.lang.String,InExpression,NExpression)>`__
 for more information.
 
 .. _java_aggregates_first_n:
@@ -375,7 +375,7 @@ into the stage, grouped by ``year``:
    :language: java
    :dedent:
 
-See the `firstN() API documentation <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html#firstN(java.lang.String,InExpression,NExpression)>`__
+See the `firstN() API documentation <{+core-api+}/client/model/Accumulators.html#firstN(java.lang.String,InExpression,NExpression)>`__
 for more information.
 
 .. _java_aggregates_last_n:
@@ -396,7 +396,7 @@ the stage, grouped by ``year``:
    :language: java
    :dedent:
 
-See the `lastN() API documentation <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html#lastN(java.lang.String,InExpression,NExpression)>`__
+See the `lastN() API documentation <{+core-api+}/client/model/Accumulators.html#lastN(java.lang.String,InExpression,NExpression)>`__
 for more information.
 
 .. _java_aggregates_top:
@@ -417,7 +417,7 @@ the ``title`` and ``imdb.rating`` values for the top rated movies based on the
    :language: java
    :dedent:
 
-See the `top() API documentation <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html#top(java.lang.String,org.bson.conversions.Bson,OutExpression)>`__
+See the `top() API documentation <{+core-api+}/client/model/Accumulators.html#top(java.lang.String,org.bson.conversions.Bson,OutExpression)>`__
 for more information.
 
 .. _java_aggregates_top_n:
@@ -445,7 +445,7 @@ the ``title`` and ``runtime`` values of the three longest movies based on the
    :language: java
    :dedent:
 
-See the `topN() API documentation <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html#topN(java.lang.String,org.bson.conversions.Bson,OutExpression,NExpression)>`__
+See the `topN() API documentation <{+core-api+}/client/model/Accumulators.html#topN(java.lang.String,org.bson.conversions.Bson,OutExpression,NExpression)>`__
 for more information.
 
 .. _java_aggregates_bottom:
@@ -466,7 +466,7 @@ return the ``title`` and ``runtime`` values of the shortest movie based on the
    :language: java
    :dedent:
 
-See the `bottom() API documentation <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html#bottom(java.lang.String,org.bson.conversions.Bson,OutExpression)>`__
+See the `bottom() API documentation <{+core-api+}/client/model/Accumulators.html#bottom(java.lang.String,org.bson.conversions.Bson,OutExpression)>`__
 for more information.
 
 .. _java_aggregates_bottom_n:
@@ -493,7 +493,7 @@ based on the ``imdb.rating`` value, grouped by ``year``:
    :language: java
    :dedent:
 
-See the `bottomN() API documentation <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html#bottomN(java.lang.String,org.bson.conversions.Bson,OutExpression,NExpression)>`__
+See the `bottomN() API documentation <{+core-api+}/client/model/Accumulators.html#bottomN(java.lang.String,org.bson.conversions.Bson,OutExpression,NExpression)>`__
 for more information.
 
 Unwind
@@ -734,7 +734,7 @@ into a bucket called "monster" for monstrously large screen sizes:
 
 .. tip::
 
-   The driver includes the `Accumulators <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html>`__
+   The driver includes the `Accumulators <{+core-api+}/client/model/Accumulators.html>`__
    class with static factory methods for each of the supported accumulators.
 
 .. literalinclude:: /includes/fundamentals/code-snippets/builders/AggBuilders.java
@@ -771,7 +771,7 @@ in a new field called ``avgPrice``:
 
 .. tip::
 
-   The driver includes the `Accumulators <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html>`__
+   The driver includes the `Accumulators <{+core-api+}/client/model/Accumulators.html>`__
    class with static factory methods for each of the supported accumulators.
 
 .. literalinclude:: /includes/fundamentals/code-snippets/builders/AggBuilders.java
@@ -811,7 +811,7 @@ on a specified span of documents in a collection.
 
 .. tip:: Window Functions
 
-   The driver includes the `Windows <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Windows.html>`__
+   The driver includes the `Windows <{+core-api+}/client/model/Windows.html>`__
    class with static factory methods for building windowed computations.
 
 The following example creates a pipeline stage that computes the
@@ -876,7 +876,7 @@ which contain ``ts`` values every 15 minutes between the existing documents:
    Document{{ position=Document{{coordinates=[-47.9, 47.6]}}, ts=Mon Mar 05 08:45:00 EST 1984 }}
    Document{{ _id=5553b..., position=Document{{type=Point, coordinates=[-47.9, 47.6]}}, ts=Mon Mar 05 09:00:00 EST 1984, ... }}
 
-See the `densify package API documentation <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/densify/package-summary.html>`__
+See the `densify package API documentation <{+core-api+}/client/model/densify/package-summary.html>`__
 for more information.
 
 Fill
@@ -928,7 +928,7 @@ by the aggregate stage:
    Document{{_id=6308b..., hour=2, temperature=23.5C, air_pressure=29.75}}
    Document{{_id=6308c..., hour=3, temperature=23.6C, air_pressure=29.76}}
 
-See the `fill package API documentation <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/fill/package-summary.html>`__
+See the `fill package API documentation <{+core-api+}/client/model/fill/package-summary.html>`__
 for more information.
 
 Atlas Full-Text Search
@@ -955,7 +955,7 @@ field for text that contains the word "Future":
    :dedent:
 
 Learn more about the builders from the
-`search package API documentation <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/search/package-summary.html>`__.
+`search package API documentation <{+core-api+}/client/model/search/package-summary.html>`__.
 
 Atlas Search Metadata
 ---------------------
@@ -982,4 +982,4 @@ aggregation stage:
    :dedent:
 
 Learn more about this helper from the
-`searchMeta() API documentation <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html#searchMeta(com.mongodb.client.model.search.SearchCollector)>`__.
+`searchMeta() API documentation <{+core-api+}/client/model/Aggregates.html#searchMeta(com.mongodb.client.model.search.SearchCollector)>`__.