Skip to content

Commit a8c390c

Browse files
author
Chris Cho
authored
DOCSP-20586: versioned API renamed to stable API (#789)
* DOCSP-20586: versioned API renamed to stable API
1 parent 2a55367 commit a8c390c

25 files changed

+175
-916
lines changed

snooty.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,4 @@ csharp-docs-versioned = "https://mongodb.github.io/mongo-csharp-driver/2.14"
1313

1414
java-version = "4.4"
1515
java-api = "https://mongodb.github.io/mongo-java-driver/{+java-version+}"
16+
stable-api = "Stable API"

source/c.txt

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ MongoDB C Driver
1717
Introduction
1818
------------
1919

20-
Welcome to the documentation site for the official MongoDB C driver.
21-
You can add the driver to your application to work with MongoDB in C.
22-
Download the required libraries, ``libmongoc`` and ``libbson``, from
23-
`mongoc.org <https://mongoc.org/libmongoc/current/installing.html>`__
20+
Welcome to the documentation site for the official MongoDB C driver.
21+
You can add the driver to your application to work with MongoDB in C.
22+
Download the required libraries, ``libmongoc`` and ``libbson``, from
23+
`mongoc.org <https://mongoc.org/libmongoc/current/installing.html>`__
2424
or set up a runnable project by following our tutorial.
2525

2626
- `Tutorial <http://mongoc.org/libmongoc/current/tutorial.html>`__
@@ -79,16 +79,18 @@ Connect to MongoDB Atlas
7979
See `Advanced Connections <http://mongoc.org/libmongoc/current/advanced-connections.html>`__
8080
for more ways to connect.
8181

82-
Versioned API
83-
-------------
82+
{+stable-api+}
83+
--------------
84+
85+
You can use the {+stable-api+} feature starting with MongoDB Server version
86+
5.0 and C Driver version 1.18. When you use the {+stable-api+} feature,
87+
you can update your driver or server without worrying about backward
88+
compatibility issues with any commands covered by the {+stable-api+}.
89+
90+
.. include:: /includes/stable-api-notice.rst
8491

85-
You can use the `Versioned API
86-
<https://docs.mongodb.com/v5.0/reference/versioned-api/>`__ feature
87-
starting with MongoDB Server version 5.0 and C Driver version 1.18. When
88-
you use the Versioned API feature, you can update your driver or server
89-
without worrying about backward compatibility issues with any commands
90-
covered by the Versioned API. To use this feature, construct a MongoDB
91-
client instance, specifying a version of the Versioned API:
92+
To use this feature, construct a MongoDB client instance, specifying a version
93+
of the {+stable-api+}:
9294

9395
.. code-block:: c
9496

@@ -104,7 +106,7 @@ client instance, specifying a version of the Versioned API:
104106
uri = mongoc_uri_new_with_error (uri_string, &error);
105107
client = mongoc_client_new_from_uri (uri);
106108

107-
// Set the version of the Versioned API on the client.
109+
// Set the version of the {+stable-api+} on the client.
108110
api = mongoc_server_api_new (MONGOC_SERVER_API_V1);
109111
mongoc_client_set_server_api (client, api, &error);
110112

@@ -114,7 +116,7 @@ Connect to a MongoDB Server on Your Local Machine
114116
.. include:: /includes/localhost-connection.rst
115117

116118
To test whether you can connect to your server, replace the connection
117-
string in the :ref:`Connect to MongoDB Atlas <connect-atlas-c-driver>` code
119+
string in the :ref:`Connect to MongoDB Atlas <connect-atlas-c-driver>` code
118120
example and run it.
119121

120122
Compatibility
@@ -123,7 +125,10 @@ Compatibility
123125
MongoDB Compatibility
124126
~~~~~~~~~~~~~~~~~~~~~
125127

126-
.. include:: /includes/extracts/c-driver-compatibility-matrix-mongodb.rst
128+
The following compatibility table specifies the recommended version(s) of the
129+
MongoDB C driver for use with a specific version of MongoDB.
130+
131+
The first column lists the driver version(s).
127132

128133
.. include:: /includes/mongodb-compatibility-table-c.rst
129134

@@ -132,7 +137,10 @@ MongoDB Compatibility
132137
Language Compatibility
133138
~~~~~~~~~~~~~~~~~~~~~~
134139

135-
.. include:: /includes/extracts/c-driver-compatibility-matrix-language.rst
140+
The following compatibility table specifies the recommended version(s) of the
141+
MongoDB C driver for use with a specific version of C.
142+
143+
The first column lists the driver version(s).
136144

137145
.. include:: /includes/language-compatibility-table-c.rst
138146

source/csharp.txt

Lines changed: 27 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ MongoDB C#/.NET Driver
1717
Introduction
1818
------------
1919

20-
Welcome to the documentation site for the official MongoDB C#/.NET
21-
driver. You can add the driver to your application to work with MongoDB
22-
in C#/.NET. Download it using `NuGet <https://www.nuget.org/>`__ or
20+
Welcome to the documentation site for the official MongoDB C#/.NET
21+
driver. You can add the driver to your application to work with MongoDB
22+
in C#/.NET. Download it using `NuGet <https://www.nuget.org/>`__ or
2323
set up a runnable project by following our Getting Started guide.
2424

2525
- `Getting Started <{+csharp-docs-versioned+}/getting_started/>`__
@@ -74,26 +74,31 @@ Connect to MongoDB Atlas
7474
See `Connecting <{+csharp-docs-versioned+}/reference/driver/connecting/>`__
7575
for more information.
7676

77-
Versioned API
78-
-------------
77+
{+stable-api+}
78+
--------------
79+
80+
You can use the {+stable-api+} feature starting with MongoDB Server version
81+
5.0 and C#/.NET Driver version 2.13. When you use the {+stable-api+} feature,
82+
you can update your driver or server without worrying about backward
83+
compatibility issues with any commands covered by the {+stable-api+}.
7984

80-
You can use the `Versioned API
81-
<https://docs.mongodb.com/v5.0/reference/versioned-api/>`__ feature
82-
starting with MongoDB Server version 5.0 and C#/.NET Driver version 2.13. When
83-
you use the Versioned API feature, you can update your driver or server
84-
without worrying about backward compatibility issues with any commands
85-
covered by the Versioned API. To use this feature, construct a MongoDB
86-
client instance, specifying a version of the Versioned API:
85+
.. include:: /includes/stable-api-notice.rst
86+
87+
To use this feature, construct a MongoDB client instance, specifying a version
88+
of the {+stable-api+}:
8789

8890
.. code-block:: csharp
8991

9092
// Replace <connection string> with your MongoDB deployment's connection string.
9193
var settings = MongoClientSettings.FromConnectionString("<connection string>");
9294

93-
// Set the version of the Versioned API on the client.
95+
// Set the version of the {+stable-api+} on the client.
9496
settings.ServerApi = new ServerApi(ServerApiVersion.V1);
9597
var client = new MongoClient(settings);
9698

99+
See the MongoDB Server reference on the :manual:`{+stable-api+} </reference/stable-api/>`
100+
for more information.
101+
97102
Connect to a MongoDB Server on Your Local Machine
98103
-------------------------------------------------
99104

@@ -109,12 +114,20 @@ Compatibility
109114
MongoDB Compatibility
110115
~~~~~~~~~~~~~~~~~~~~~
111116

117+
The following compatibility table specifies the recommended version(s) of the
118+
MongoDB C#/.NET driver for use with a specific version of MongoDB.
119+
120+
The first column lists the driver version(s).
121+
112122
.. include:: /includes/mongodb-compatibility-table-csharp.rst
113123

114124
Language Compatibility
115125
~~~~~~~~~~~~~~~~~~~~~~
116126

117-
.. include:: /includes/extracts/csharp-driver-compatibility-matrix-language.rst
127+
The following compatibility table specifies the recommended version(s) of the
128+
MongoDB C#/.NET driver for use with a specific version of .NET.
129+
130+
The first column lists the driver version(s).
118131

119132
.. include:: /includes/language-compatibility-table-csharp.rst
120133

source/cxx.txt

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ MongoDB C++ Driver
1717
Introduction
1818
------------
1919

20-
Welcome to the documentation site for the official MongoDB C++ driver.
21-
You can add the driver to your application to work with MongoDB using
22-
the C++11 or later standard. Download the library, ``mongocxx``,
23-
from `mongocxx.org <http://mongocxx.org/mongocxx-v3/installation/>`__
20+
Welcome to the documentation site for the official MongoDB C++ driver.
21+
You can add the driver to your application to work with MongoDB using
22+
the C++11 or later standard. Download the library, ``mongocxx``,
23+
from `mongocxx.org <http://mongocxx.org/mongocxx-v3/installation/>`__
2424
or set up a runnable project by following our tutorial.
2525

2626
- `Tutorial <http://mongocxx.org/mongocxx-v3/tutorial/>`__
@@ -78,7 +78,10 @@ Compatibility
7878
MongoDB Compatibility
7979
~~~~~~~~~~~~~~~~~~~~~
8080

81-
.. include:: /includes/extracts/cpp-driver-compatibility-matrix-mongodb.rst
81+
The following compatibility table specifies the recommended version(s) of the
82+
MongoDB C++ driver for use with a specific version of MongoDB.
83+
84+
The first column lists the driver version(s).
8285

8386
.. include:: /includes/mongodb-compatibility-table-cxx.rst
8487

@@ -87,7 +90,10 @@ MongoDB Compatibility
8790
Language Compatibility
8891
~~~~~~~~~~~~~~~~~~~~~~
8992

90-
.. include:: /includes/extracts/cpp-driver-compatibility-matrix-language.rst
93+
The following compatibility table specifies the recommended version(s) of the
94+
MongoDB C++ driver for use with a specific version of C++.
95+
96+
The first column lists the driver version(s).
9197

9298
.. include:: /includes/language-compatibility-table-cxx.rst
9399

source/go.txt

Lines changed: 0 additions & 111 deletions
This file was deleted.

source/includes/connection-snippets/go-connection.go

Lines changed: 0 additions & 38 deletions
This file was deleted.

0 commit comments

Comments
 (0)