Skip to content

Commit 517eb50

Browse files
Chris Choschmalliso
authored andcommitted
DOCSP-20583: versioned API renamed to stable API (#223)
* DOCSP-20583: versioned API renamed to stable API
1 parent 573d178 commit 517eb50

File tree

4 files changed

+29
-22
lines changed

4 files changed

+29
-22
lines changed

snooty.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,4 @@ sink-connector="MongoDB Kafka sink connector"
1919
source-connector="MongoDB Kafka source connector"
2020
connector_driver_url_base="https://docs.mongodb.com/drivers/java/sync/v{+connector_driver_version+}/"
2121
pipeline-size = "2.4 GB"
22+
stable-api = "Stable API"

source/sink-connector/configuration-properties/mongodb-connection.txt

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -73,25 +73,25 @@ Settings
7373
- | **Type:** string
7474
|
7575
| **Description:**
76-
| The Versioned API version you want to use with your MongoDB
77-
server. For more information on the Versioned API and versions of
78-
the server that support it, see the :manual:`Versioned API </reference/versioned-api/>`
76+
| The {+stable-api+} version you want to use with your MongoDB
77+
server. For more information on the {+stable-api+} and versions of
78+
the server that support it, see the :manual:`{+stable-api+} </reference/stable-api/>`
7979
MongoDB server manual guide.
8080
|
8181
| **Default**: ``""``
82-
| **Accepted Values**: An empty string or a valid Versioned API version.
82+
| **Accepted Values**: An empty string or a valid {+stable-api+} version.
8383

8484
* - **server.api.deprecationErrors**
8585
- | **Type:** boolean
8686
|
8787
| **Description:**
8888
| When set to ``true``, if the connector calls a command on your
89-
MongoDB instance that's deprecated in the declared Versioned API
89+
MongoDB instance that's deprecated in the declared {+stable-api+}
9090
version, it raises an exception.
9191
| You can set the API version with the ``server.api.version``
92-
configuration option. For more information on the Versioned API, see
92+
configuration option. For more information on the {+stable-api+}, see
9393
the MongoDB manual entry on the
94-
:manual:`Versioned API </reference/versioned-api/>`.
94+
:manual:`{+stable-api+} </reference/stable-api/>`.
9595
|
9696
| **Default**: ``false``
9797
| **Accepted Values**: ``true`` or ``false``
@@ -101,12 +101,12 @@ Settings
101101
|
102102
| **Description:**
103103
| When set to ``true``, if the connector calls a command on your
104-
MongoDB instance that's not covered in the declared Versioned API
104+
MongoDB instance that's not covered in the declared {+stable-api+}
105105
version, it raises an exception.
106106
| You can set the API version with the ``server.api.version``
107-
configuration option. For more information on the Versioned API, see
107+
configuration option. For more information on the {+stable-api+}, see
108108
the MongoDB manual entry on the
109-
:manual:`Versioned API </reference/versioned-api/>`.
109+
:manual:`{+stable-api+} </reference/stable-api/>`.
110110
|
111111
| **Default**: ``false``
112112
| **Accepted Values**: ``true`` or ``false``

source/source-connector/configuration-properties/mongodb-connection.txt

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Settings
3131

3232
.. list-table::
3333
:header-rows: 1
34-
:widths: 40 60
34+
:widths: 45 55
3535

3636
* - Name
3737
- Description
@@ -81,25 +81,25 @@ Settings
8181
- | **Type:** string
8282
|
8383
| **Description:**
84-
| The Versioned API version you want to use with your MongoDB
85-
cluster. For more information on the Versioned API and versions of
86-
MongoDB Server that support it, see the :manual:`Versioned API </reference/versioned-api/>`
84+
| The {+stable-api+} version you want to use with your MongoDB
85+
cluster. For more information on the {+stable-api+} and versions of
86+
MongoDB Server that support it, see the :manual:`{+stable-api+} </reference/stable-api/>`
8787
guide.
8888
|
8989
| **Default**: ``""``
90-
| **Accepted Values**: An empty string or a valid Versioned API version.
90+
| **Accepted Values**: An empty string or a valid {+stable-api+} version.
9191

9292
* - **server.api.deprecationErrors**
9393
- | **Type:** boolean
9494
|
9595
| **Description:**
9696
| When set to ``true``, if the connector calls a command on your
97-
MongoDB instance that's deprecated in the declared Versioned API
97+
MongoDB instance that's deprecated in the declared {+stable-api+}
9898
version, it raises an exception.
9999
| You can set the API version with the ``server.api.version``
100-
configuration option. For more information on the Versioned API, see
100+
configuration option. For more information on the {+stable-api+}, see
101101
the MongoDB manual entry on the
102-
:manual:`Versioned API </reference/versioned-api/>`.
102+
:manual:`{+stable-api+} </reference/stable-api/>`.
103103
|
104104
| **Default**: ``false``
105105
| **Accepted Values**: ``true`` or ``false``
@@ -109,12 +109,12 @@ Settings
109109
|
110110
| **Description:**
111111
| When set to ``true``, if the connector calls a command on your
112-
MongoDB instance that's not covered in the declared Versioned API
112+
MongoDB instance that's not covered in the declared {+stable-api+}
113113
version, it raises an exception.
114114
| You can set the API version with the ``server.api.version``
115-
configuration option. For more information on the Versioned API, see
115+
configuration option. For more information on the {+stable-api+}, see
116116
the MongoDB manual entry on the
117-
:manual:`Versioned API </reference/versioned-api/>`.
117+
:manual:`{+stable-api+} </reference/stable-api/>`.
118118
|
119119
| **Default**: ``false``
120120
| **Accepted Values**: ``true`` or ``false``

source/whats-new.txt

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,15 @@ Bug Fixes
4040
What's New in 1.6
4141
-----------------
4242

43-
- Added support for :manual:`Versioned API </reference/versioned-api/>` to
43+
- Added support for :manual:`{+stable-api+} </reference/stable-api/>` to
4444
force the server to run operations with behavior compatible with the
4545
specified API version
46+
47+
.. note::
48+
49+
Starting from Feburary 2022, the **Versioned API** is known the **{+stable-api+}**.
50+
All concepts and features remain the same with this naming change.
51+
4652
- Added error handling properties for the
4753
:ref:`sink connector <sink-configuration-error-handling>`
4854
and :ref:`source connector <source-configuration-error-handling>`

0 commit comments

Comments
 (0)