From 13f676aa98c5f6e567a58b8d924deaf9601cb644 Mon Sep 17 00:00:00 2001 From: Jeremy Mikola Date: Fri, 11 Feb 2022 14:40:50 -0500 Subject: [PATCH] PHPLIB-786: Rename "Versioned API" to "Stable API" in docs --- ...goDBClient-method-construct-driverOptions.yaml | 2 +- docs/tutorial.txt | 2 +- .../{versioned-api.txt => stable-api.txt} | 15 +++++++-------- 3 files changed, 9 insertions(+), 10 deletions(-) rename docs/tutorial/{versioned-api.txt => stable-api.txt} (90%) diff --git a/docs/includes/apiargs-MongoDBClient-method-construct-driverOptions.yaml b/docs/includes/apiargs-MongoDBClient-method-construct-driverOptions.yaml index f47e56ba1..5d30540d8 100644 --- a/docs/includes/apiargs-MongoDBClient-method-construct-driverOptions.yaml +++ b/docs/includes/apiargs-MongoDBClient-method-construct-driverOptions.yaml @@ -45,7 +45,7 @@ name: serverApi type: :php:`MongoDB\\Driver\\ServerApi ` description: | Used to declare an API version on the client. See the - :manual:`Versioned API tutorial ` for usage. + :manual:`Stable API tutorial ` for usage. .. versionadded:: 1.9 interface: phpmethod diff --git a/docs/tutorial.txt b/docs/tutorial.txt index 6ad6400ab..cca3ee345 100644 --- a/docs/tutorial.txt +++ b/docs/tutorial.txt @@ -15,4 +15,4 @@ Tutorials /tutorial/indexes /tutorial/tailable-cursor /tutorial/example-data - /tutorial/versioned-api + /tutorial/stable-api diff --git a/docs/tutorial/versioned-api.txt b/docs/tutorial/stable-api.txt similarity index 90% rename from docs/tutorial/versioned-api.txt rename to docs/tutorial/stable-api.txt index ebe971d11..1220f0326 100644 --- a/docs/tutorial/versioned-api.txt +++ b/docs/tutorial/stable-api.txt @@ -1,6 +1,6 @@ -============= -Versioned API -============= +========== +Stable API +========== .. default-domain:: mongodb @@ -10,7 +10,7 @@ Versioned API :depth: 1 :class: singlecol -Declaring an API version +Declaring an API Version ------------------------ To declare an API version, pass a ``serverApi`` driver option when creating your @@ -43,10 +43,9 @@ Strict API ---------- By default, declaring an API version guarantees behavior for commands that are -part of the versioned API, but does not forbid using commands that are not part +part of the stable API, but does not forbid using commands that are not part of the API version. To only allow commands and options that are part of the -versioned API, specify the ``strict`` option when creating the -specify the ``strict`` option when creating the +stable API, specify the ``strict`` option when creating the :php:`MongoDB\\Driver\\ServerApi ` instance: .. code-block:: php @@ -83,7 +82,7 @@ testing to ensure a smooth transition to a future API version. At the time of this writing, no part of API version "1" has been deprecated. -Usage with the command helper +Usage with the Command Helper ----------------------------- When using the :phpmethod:`MongoDB\\Database::command()` method to run arbitrary