Docsp-20542 rename versioned api verbiage v5.2 (#448)

ianf-mongodb · web-flow · commit a29c9c02380c · 2022-01-31T09:24:34.000-05:00
* DOCSP-20542 rename all versioned-api verbiage and refs * fix header lengths * tweak redirects * comments back to Versioned API * * * remove duplicate redirects * stable-api.txt update * stable-api.txt headers * more tweaks to stable-api.txt * Add naming note and reference the versioned api name change * * * ** * add name change to release 5.0 notes * move naming changes section * ** * ***
diff --git a/config/redirects b/config/redirects
@@ -1897,9 +1897,12 @@ raw: /manual/core/wildcard -> ${base}/manual/core/index-wildcard/
 [v3.6-v4.4]: /${version}/reference/versioned-api -> ${base}/${version}/reference/
 [v3.6-v4.4]: /${version}/tutorial/mitigate-psa-performance-issues -> ${base}/${version}/administration/replica-set-maintenance/
 [v3.6-v4.4]: /${version}/tutorial/modify-psa-replica-set-safely -> ${base}/${version}/administration/replica-set-maintenance/
+[v3.6-v4.4]: /${version}/reference/stable-api/ -> ${base}/${version}/reference/
+[v3.6-v4.4]: /${version}/reference/stable-api-reference/ -> ${base}/${version}/reference/
 
 [v5.0-*]: /${version}/reference/read-concern-majority/#disable-read-concern-majority -> ${base}/${version}/reference/read-concern-majority/#primary-secondary-arbiter-replica-sets
-
+[v5.0-*]: /${version}/reference/versioned-api/ -> ${base}/${version}/reference/stable-api/
+[v5.0-*]: /${version}/reference/versioned-api-reference/ -> ${base}/${version}/reference/stable-api-reference/
 
 #
 # Redirects for 5.1 and greater (if pages are removed in 5.0 that used to exist in earlier versions)
diff --git a/snooty.toml b/snooty.toml
@@ -146,7 +146,7 @@ toc_landing_pages = [
    "/reference/replication",
    "/reference/security",
    "/reference/sharding",
-   "/reference/versioned-api",
+   "/reference/stable-api",
    "/release-notes/2.4",
    "/release-notes/2.6",
    "/release-notes/3.0",
diff --git a/source/core/capped-collections.txt b/source/core/capped-collections.txt
@@ -139,11 +139,11 @@ Transactions
 
 .. include:: /includes/extracts/transactions-capped-collection-change.rst
 
-Versioned API
-~~~~~~~~~~~~~
+Stable API
+~~~~~~~~~~
 
-Capped collections are not supported in :ref:`Versioned API
-<versioned-api>` V1.
+Capped collections are not supported in :ref:`Stable API
+<stable-api>` V1.
 
 Procedures
 ----------
diff --git a/source/includes/driver-examples/stable-api-java-example.java b/source/includes/driver-examples/stable-api-java-example.java
diff --git a/source/reference.txt b/source/reference.txt
@@ -79,8 +79,8 @@ Reference
 :doc:`/reference/server-sessions`
    Describes server sessions.
 
-:doc:`/reference/versioned-api`
-   Describes the Versioned API.
+:doc:`/reference/stable-api`
+   Describes the Stable API.
    
 .. seealso::
 
@@ -112,4 +112,4 @@ Reference
    /reference/default-mongodb-port
    /reference/mongodb-defaults
    /reference/server-sessions
-   /reference/versioned-api
+   /reference/stable-api
diff --git a/source/reference/command/aggregate.txt b/source/reference/command/aggregate.txt
@@ -309,10 +309,10 @@ For :dbcommand:`aggregate` operation that do not include the
 
 .. include:: /includes/extracts/4.2-changes-disconnect.rst
 
-Versioned API
--------------
+Stable API
+----------
 
-When using :ref:`Versioned API <versioned-api>` V1:
+When using :ref:`Stable API <stable-api>` V1:
 
 - You cannot use the following stages in an :dbcommand:`aggregate`
   command:
diff --git a/source/reference/command/create.txt b/source/reference/command/create.txt
@@ -400,12 +400,12 @@ Transactions
 
 .. |operation| replace:: :dbcommand:`create`
 
-Versioned API
-~~~~~~~~~~~~~
+Stable API
+~~~~~~~~~~
 
 .. versionchanged:: 5.0
 
-When using :ref:`Versioned API <versioned-api>` V1, you cannot specify
+When using :ref:`Stable API <stable-api>` V1, you cannot specify
 the following fields in a :dbcommand:`create` command:
 
 - ``autoIndexId``
diff --git a/source/reference/command/createIndexes.txt b/source/reference/command/createIndexes.txt
@@ -594,10 +594,10 @@ Collation and Index Types
 
 .. include:: /includes/extracts/collation-index-type-restrictions-addendum.rst
 
-Versioned API
-~~~~~~~~~~~~~
+Stable API
+~~~~~~~~~~
 
-When using :ref:`Versioned API <versioned-api>` V1:
+When using :ref:`Stable API <stable-api>` V1:
 
 - You cannot specify any of the following fields in the ``indexes`` array:
 
diff --git a/source/reference/command/find.txt b/source/reference/command/find.txt
@@ -550,10 +550,10 @@ Client Disconnection
 
 .. include:: /includes/extracts/4.2-changes-disconnect.rst
 
-Versioned API
-~~~~~~~~~~~~~
+Stable API
+~~~~~~~~~~
 
-When using :ref:`Versioned API <versioned-api>` V1, the following
+When using :ref:`Stable API <stable-api>` V1, the following
 :dbcommand:`find` command fields are not supported:
 
 - ``awaitData``
diff --git a/source/reference/command/setParameter.txt b/source/reference/command/setParameter.txt
@@ -39,9 +39,9 @@ do not survive server restarts. For a persistent option use the
 :option:`--setParameter <mongod --setParameter>` command line option 
 or the :setting:`setParameter` configuration file setting.
 
-Versioned API
-~~~~~~~~~~~~~
+Stable API
+~~~~~~~~~~
 
-When using :ref:`Versioned API <versioned-api>` V1 with :ref:`apiStrict
+When using :ref:`Stable API <stable-api>` V1 with :ref:`apiStrict
 <api-strict-desc>` set to ``true``, you cannot use
 :dbcommand:`setParameter` to modify server parameters.
diff --git a/source/reference/program/mongo.txt b/source/reference/program/mongo.txt
@@ -242,7 +242,7 @@ Core Options
 
    Specifies that the server will respond with :ref:`APIStrictError 
    <api-strict-resp>` if your application uses a command or behavior
-   outside of the :doc:`Versioned API </reference/versioned-api>`.
+   outside of the :doc:`Stable API </reference/stable-api>`.
 
    If you specify :option:`--apiStrict`, you must also specify 
    :option:`--apiVersion`.
diff --git a/source/reference/stable-api-reference.txt b/source/reference/stable-api-reference.txt
diff --git a/source/reference/stable-api.txt b/source/reference/stable-api.txt
@@ -1,8 +1,8 @@
-.. _versioned-api:
+.. _stable-api:
 
-=============
-Versioned API
-=============
+==========
+Stable API
+==========
 
 .. default-domain:: mongodb
 
@@ -12,19 +12,19 @@ Versioned API
    :depth: 1
    :class: singlecol
    
-What is the Versioned API, and Should You Use It?
--------------------------------------------------
+What is the Stable API, and Should You Use It?
+----------------------------------------------
 
-The MongoDB Versioned API lets you upgrade your MongoDB server at will, 
-and ensure that behavior changes between MongoDB versions do not break 
-your application.
+The MongoDB Stable API (previously labeled the Versioned API) lets you 
+upgrade your MongoDB server at will, and ensure that behavior changes 
+between MongoDB versions do not break your application.
 
-MongoDB 5.0 introduces the Versioned API for applications 
-communicating with MongoDB server products. The Versioned API allows 
+MongoDB 5.0 introduces the Stable API for applications 
+communicating with MongoDB server products. The Stable API allows 
 you to specify which version of the MongoDB API your application 
 runs against.
 
-The Versioned API provides long-term API stability for applications 
+The Stable API provides long-term API stability for applications 
 and supports more frequent releases and automatic server upgrades. This 
 allows your applications to take advantage of rapidly released 
 features without risking backwards-breaking changes.
@@ -33,11 +33,17 @@ The default behavior for your driver connection will continue to
 function as expected, even if you do not explicitly specify
 an :ref:`apiVersion <api-version-desc>`.
 
-The Versioned API encompasses the 
+The Stable API encompasses the 
 :ref:`subset of MongoDB commands <api-v1-command-list>` that 
 applications use to read and write data, create collections 
 and indexes, and perform other common tasks. 
 
+.. note::
+
+   Starting in Feburary 2022, the "Versioned API" terminology was 
+   changed to "Stable API". All concepts and features remain the same 
+   with this naming change.
+
 Backward Compatibility Guarantee
 --------------------------------
 
@@ -63,7 +69,7 @@ upper-right to set the language of the examples on this page.
 
 ----------
 
-To use the Versioned API, upgrade to the latest driver and create your 
+To use the Stable API, upgrade to the latest driver and create your 
 application's MongoClient:
 
 .. tabs-selector:: drivers
@@ -134,7 +140,7 @@ application's MongoClient:
    .. tab::
       :tabid: java-sync
 
-      .. literalinclude:: /includes/driver-examples/versioned-api-java-example.java
+      .. literalinclude:: /includes/driver-examples/stable-api-java-example.java
          :language: java-sync
          :dedent: 4
          :start-after: Start Versioned API Example 1
@@ -144,13 +150,13 @@ application's MongoClient:
 
 By default, clients are *non-strict*. A non-strict client allows you
 to run any command, regardless of whether or not it belongs to the 
-Versioned API.
+Stable API.
 
 Create a Strict Client 
 ----------------------
 
-A *strict* client rejects all commands outside of the Versioned API. 
-Attempts to use commands outside of the Versioned API will receive the 
+A *strict* client rejects all commands outside of the Stable API. 
+Attempts to use commands outside of the Stable API will receive the 
 :ref:`APIVersionError <api-vers-resp>` response.
 
 Use the sample code to create a *strict* client:
@@ -221,24 +227,24 @@ Use the sample code to create a *strict* client:
    .. tab::
       :tabid: java-sync
 
-      .. literalinclude:: /includes/driver-examples/versioned-api-java-example.java
+      .. literalinclude:: /includes/driver-examples/stable-api-java-example.java
          :language: java-sync
          :dedent: 4
          :start-after: Start Versioned API Example 2
          :end-before: End Versioned API Example 2
 
-Migrate To Versioned API Commands
----------------------------------
+Migrate To Stable API Commands
+------------------------------
 
-To migrate your application to use the Versioned API, you must:
+To migrate your application to use the Stable API, you must:
 
 #. Run your application's test suite with the new MongoClient options.
 #. Determine which commands and features you're using that are outside 
-   of the Versioned API.
-#. Migrate to alternative commands and features in the Versioned API.
+   of the Stable API.
+#. Migrate to alternative commands and features in the Stable API.
 
 Once your application uses only commands and features defined in the 
-Versioned API, you can redeploy it with the new MongoClient options 
+Stable API, you can redeploy it with the new MongoClient options 
 and be confident that future server upgrades won't negatively
 impact your application.
 
@@ -248,7 +254,7 @@ Example: :dbcommand:`count` Migration
 This example shows how to migrate an application that implements the
 :dbcommand:`count` command to an alternative method of counting 
 documents. Since the :dbcommand:`count` command does not belong to the 
-Versioned API, this application cannot use the Versioned API until the 
+Stable API, this application cannot use the Stable API until the 
 :dbcommand:`count` command is removed from the code.
 
 Use the sample code to create a ``sales`` collection in 
@@ -267,8 +273,8 @@ Use the sample code to create a ``sales`` collection in
        { "_id" : 8, "item" : "abc", "price" : 10, "quantity" : 5, "date" : ISODate("2021-03-16T20:20:13Z") }
    ])
 
-Versioned API Error Response
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Stable API Error Response
+~~~~~~~~~~~~~~~~~~~~~~~~~
 
 For example, issuing ``db.sales.count()`` results in this error:
 
@@ -283,7 +289,7 @@ For example, issuing ``db.sales.count()`` results in this error:
    }
 
 However, the :dbcommand:`aggregate` command is
-:ref:`in the Versioned API <api-v1-command-list>` and can be used to 
+:ref:`in the Stable API <api-v1-command-list>` and can be used to 
 obtain a count. Use the sample code to obtain a count from the ``sales``
 collection in :binary:`~bin.mongosh`:
 
@@ -305,10 +311,10 @@ number of documents in the collection:
 
   { "_id" : null, "count" : 8 }
 
-How To Use Commands and Features Outside of the Versioned API
--------------------------------------------------------------
+How To Use Commands and Features Outside of the Stable API
+----------------------------------------------------------
 
-To use commands and features outside of the Versioned API, you can 
+To use commands and features outside of the Stable API, you can 
 connect to your deployment with a *non-strict* client. By default,
 clients are *non-strict*.
 
@@ -380,19 +386,19 @@ Use the sample code to create a *non-strict* client:
    .. tab::
       :tabid: java-sync
 
-      .. literalinclude:: /includes/driver-examples/versioned-api-java-example.java
+      .. literalinclude:: /includes/driver-examples/stable-api-java-example.java
          :language: java-sync
          :dedent: 4
          :start-after: Start Versioned API Example 3
          :end-before: End Versioned API Example 3
 
 Using this non-strict client allows you to run commands outside of the
-Versioned API. For example, this non-strict client now allows you to 
+Stable API. For example, this non-strict client now allows you to 
 use the :dbcommand:`count` command once again.
 
 .. important:: 
 
-   Commands and features outside of the Versioned API do not have the same 
+   Commands and features outside of the Stable API do not have the same 
    backward compatibility guarantees as versioned alternatives.
 
 .. _api-v1-command-list:
@@ -404,19 +410,19 @@ API V1 protects you from API-breaking changes
 for the following commands:
 
 - :dbcommand:`abortTransaction`
-- :dbcommand:`aggregate` (with limitations) [#versioned-api-command-limitations]_
+- :dbcommand:`aggregate` (with limitations) [#stable-api-command-limitations]_
 - :dbcommand:`authenticate`
 - :dbcommand:`collMod`
 - :dbcommand:`commitTransaction`
-- :dbcommand:`create` (with limitations) [#versioned-api-command-limitations]_
-- :dbcommand:`createIndexes` (with limitations) [#versioned-api-command-limitations]_
+- :dbcommand:`create` (with limitations) [#stable-api-command-limitations]_
+- :dbcommand:`createIndexes` (with limitations) [#stable-api-command-limitations]_
 - :dbcommand:`delete`
 - :dbcommand:`drop`
 - :dbcommand:`dropDatabase`
 - :dbcommand:`dropIndexes`
 - :dbcommand:`endSessions`
-- :dbcommand:`explain` (with limitations) [#versioned-api-explain]_
-- :dbcommand:`find` (with limitations) [#versioned-api-command-limitations]_
+- :dbcommand:`explain` (with limitations) [#stable-api-explain]_
+- :dbcommand:`find` (with limitations) [#stable-api-command-limitations]_
 - :dbcommand:`findAndModify`
 - :dbcommand:`getMore`
 - :dbcommand:`insert`
@@ -429,13 +435,13 @@ for the following commands:
 - :dbcommand:`refreshSessions`
 - :dbcommand:`update`
 
-.. [#versioned-api-command-limitations]
+.. [#stable-api-command-limitations]
 
    API V1 may not support all available options for these commands.
    Refer to the specific command documentation for limitations specific
    to API V1.
 
-.. [#versioned-api-explain]
+.. [#stable-api-explain]
 
    MongoDB does not guarantee that the output of the
    :dbcommand:`explain` command will conform to the same format in
@@ -444,7 +450,7 @@ for the following commands:
 Parameters
 ----------
 
-You can specify the following optional parameters for Versioned API in 
+You can specify the following optional parameters for Stable API in 
 your application's MongoDB driver connection code. Check the MongoDB 
 driver documentation for the driver you use in your application for 
 more information:
@@ -514,7 +520,7 @@ ignored.
 API Error Responses
 ~~~~~~~~~~~~~~~~~~~
 
-This table shows error responses for problematic Versioned API requests.
+This table shows error responses for problematic Stable API requests.
 
 .. list-table::
    :widths: 25,75
@@ -558,4 +564,4 @@ This table shows error responses for problematic Versioned API requests.
    :titlesonly:
    :hidden:
 
-   /reference/versioned-api-reference
+   /reference/stable-api-reference
diff --git a/source/release-notes/5.0.txt b/source/release-notes/5.0.txt
