Docsp-20542 rename versioned api verbiage v5.0 (#449)

* 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

* **

* ***

Author: ianf-mongodb

config/redirects

@@ -1877,9 +1877,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)

snooty.toml

@@ -145,7 +145,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",

source/core/capped-collections.txt

@@ -139,6 +139,12 @@ Transactions
 
 .. include:: /includes/extracts/transactions-capped-collection-change.rst
 
+Stable API
+~~~~~~~~~~
+
+Capped collections are not supported in :ref:`Stable API
+<stable-api>` V1.
+
 Procedures
 ----------
 

source/includes/driver-examples/stable-api-java-example.java

@@ -0,0 +1,67 @@
+private static MongoClient setApiVersionParam(String connectionString) {
+    // Start Versioned API Example 1
+    MongoClient client = MongoClients.create(
+            MongoClientSettings.builder()
+            .applyConnectionString(new ConnectionString(<connection string>))
+            .serverApi(
+                    ServerApi.builder()
+                    .version(ServerApiVersion.V1)
+                    .build()
+                    ).build()
+            );
+
+    return client;
+    // End Versioned API Example 1
+}
+
+private static MongoClient setApiVersionStrict(String connectionString) {
+    // Start Versioned API Example 2
+    MongoClient client = MongoClients.create(
+            MongoClientSettings.builder()
+            .applyConnectionString(new ConnectionString(<connection string>))
+            .serverApi(
+                    ServerApi.builder()
+                    .version(ServerApiVersion.V1)
+                    .strict(true)
+                    .build()
+                    ).build()
+            );
+
+    return client;
+    // End Versioned API Example 2
+}
+
+private static MongoClient setApiVersionNotStrict(String connectionString) {
+    // Start Versioned API Example 3
+    MongoClient client = MongoClients.create(
+            MongoClientSettings.builder()
+            .applyConnectionString(new ConnectionString(<connection string>))
+            .serverApi(
+                    ServerApi.builder()
+                    .version(ServerApiVersion.V1)
+                    .strict(false)
+                    .build()
+                    ).build()
+            );
+    // End Versioned API Example 3
+    return client;
+
+}
+
+private static MongoClient setApiVersionDeprecationErrors(String connectionString) {
+    // Start Versioned API Example 4
+    MongoClient client = MongoClients.create(
+            MongoClientSettings.builder()
+            .applyConnectionString(new ConnectionString(<connection string>))
+            .serverApi(
+                    ServerApi.builder()
+                    .version(ServerApiVersion.V1)
+                    .deprecationErrors(true)
+                    .build()
+                    ).build()
+            );
+
+    // End Versioned API Example 4
+    return client;
+}
+

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

source/reference/command/aggregate.txt

@@ -309,6 +309,25 @@ For :dbcommand:`aggregate` operation that do not include the
 
 .. include:: /includes/extracts/4.2-changes-disconnect.rst
 
+Stable API
+----------
+
+When using :ref:`Stable API <stable-api>` V1:
+
+- You cannot use the following stages in an :dbcommand:`aggregate`
+  command:
+
+  - :pipeline:`$currentOp`
+  - :pipeline:`$indexStats`
+  - :pipeline:`$listLocalSessions`
+  - :pipeline:`$listSessions`
+  - :pipeline:`$planCacheStats`
+  - :pipeline:`$search`
+
+- When using the :pipeline:`$collStats` stage, you can only use the
+  ``count`` field. No other :pipeline:`$collStats` fields are
+  available.
+
 Example
 -------
 

source/reference/command/create.txt

@@ -400,6 +400,21 @@ Transactions
 
 .. |operation| replace:: :dbcommand:`create`
 
+Stable API
+~~~~~~~~~~
+
+.. versionchanged:: 5.0
+
+When using :ref:`Stable API <stable-api>` V1, you cannot specify
+the following fields in a :dbcommand:`create` command:
+
+- ``autoIndexId``
+- ``capped``
+- ``indexOptionDefaults``
+- ``max``
+- ``size``
+- ``storageEngine``
+
 Access Control
 --------------
 

source/reference/command/createIndexes.txt

@@ -594,6 +594,21 @@ Collation and Index Types
 
 .. include:: /includes/extracts/collation-index-type-restrictions-addendum.rst
 
+Stable API
+~~~~~~~~~~
+
+When using :ref:`Stable API <stable-api>` V1:
+
+- You cannot specify any of the following fields in the ``indexes`` array:
+
+  - ``background``
+  - ``bucketSize``
+  - ``sparse``
+  - ``storageEngine``
+
+- You cannot create :ref:`geoHaystack <index-geohaystack-index>` or
+  :ref:`text <index-feature-text>` indexes.
+
 Behavior
 --------
 

source/reference/command/find.txt

@@ -545,6 +545,21 @@ Client Disconnection
 
 .. include:: /includes/extracts/4.2-changes-disconnect.rst
 
+Stable API
+~~~~~~~~~~
+
+When using :ref:`Stable API <stable-api>` V1, the following
+:dbcommand:`find` command fields are not supported:
+
+- ``awaitData``
+- ``max``
+- ``min``
+- ``noCursorTimeout``
+- ``oplogReplay``
+- ``returnKey``
+- ``showRecordId``
+- ``tailable``
+
 
 Examples
 --------

source/reference/command/setParameter.txt

@@ -32,3 +32,20 @@ setParameter
    For the available parameters, including examples, see
    :doc:`/reference/parameters`.
 
+Behavior
+--------
+
+Persistence
+~~~~~~~~~~~
+
+Commands issued by the admin command :dbcommand:`setParameter`
+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.
+
+Stable API
+~~~~~~~~~~
+
+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.

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`.