Skip to content

Commit deab125

Browse files
authored
PHPLIB-786: Rename "Versioned API" to "Stable API" in docs (#888)
1 parent 1366148 commit deab125

File tree

3 files changed

+9
-10
lines changed

3 files changed

+9
-10
lines changed

source/includes/apiargs-MongoDBClient-method-construct-driverOptions.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ name: serverApi
4545
type: :php:`MongoDB\\Driver\\ServerApi <class.mongodb-driver-serverapi>`
4646
description: |
4747
Used to declare an API version on the client. See the
48-
:manual:`Versioned API tutorial </tutorial/versioned-api>` for usage.
48+
:manual:`Stable API tutorial </tutorial/stable-api>` for usage.
4949
5050
.. versionadded:: 1.9
5151
interface: phpmethod

source/tutorial.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@ Tutorials
1515
/tutorial/indexes
1616
/tutorial/tailable-cursor
1717
/tutorial/example-data
18-
/tutorial/versioned-api
18+
/tutorial/stable-api

source/tutorial/versioned-api.txt renamed to source/tutorial/stable-api.txt

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
=============
2-
Versioned API
3-
=============
1+
==========
2+
Stable API
3+
==========
44

55
.. default-domain:: mongodb
66

@@ -10,7 +10,7 @@ Versioned API
1010
:depth: 1
1111
:class: singlecol
1212

13-
Declaring an API version
13+
Declaring an API Version
1414
------------------------
1515

1616
To declare an API version, pass a ``serverApi`` driver option when creating your
@@ -43,10 +43,9 @@ Strict API
4343
----------
4444

4545
By default, declaring an API version guarantees behavior for commands that are
46-
part of the versioned API, but does not forbid using commands that are not part
46+
part of the stable API, but does not forbid using commands that are not part
4747
of the API version. To only allow commands and options that are part of the
48-
versioned API, specify the ``strict`` option when creating the
49-
specify the ``strict`` option when creating the
48+
stable API, specify the ``strict`` option when creating the
5049
:php:`MongoDB\\Driver\\ServerApi <class.mongodb-driver-serverapi>` instance:
5150

5251
.. code-block:: php
@@ -83,7 +82,7 @@ testing to ensure a smooth transition to a future API version.
8382

8483
At the time of this writing, no part of API version "1" has been deprecated.
8584

86-
Usage with the command helper
85+
Usage with the Command Helper
8786
-----------------------------
8887

8988
When using the :phpmethod:`MongoDB\\Database::command()` method to run arbitrary

0 commit comments

Comments
 (0)