Skip to content

Commit 8a2d7b4

Browse files
authored
docsp-34995 - update api urls (#146)
* update api urls
1 parent ac77e57 commit 8a2d7b4

31 files changed

+161
-159
lines changed

snooty.toml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,13 @@ language = "C#"
2626
mongo-community = "MongoDB Community Edition"
2727
mongo-enterprise = "MongoDB Enterprise Edition"
2828
docs-branch = "master" # always set this to the docs branch (i.e. master, 1.7, 1.8, etc.)
29-
version-number = "2.22" # always set this to the driver branch (i.e. 1.7.0, 1.8.0, etc.)
29+
version-number = "2.23"
30+
patch-version-number = "{+version-number+}.0" # always set this to the driver branch (i.e. 1.7.0, 1.8.0, etc.)
3031
version = "v{+version-number+}"
3132
example = "https://raw.githubusercontent.com/mongodb/docs-csharp/{+docs-branch+}/source/includes/code-examples"
3233
stable-api = "Stable API"
3334
api-root = "https://mongodb.github.io/mongo-csharp-driver/{+version-number+}/html"
35+
new-api-root = "https://mongodb.github.io/mongo-csharp-driver/{+patch-version-number+}/api"
3436
bool-data-type = "``boolean``"
3537
string-data-type = "``string``"
3638
int-data-type = "``integer``"

source/faq.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ Why Does the Driver Throw a Timeout During Server Selection?
118118
Each driver operation requires that you choose a healthy server
119119
satisfying the :manual:`server selection criteria
120120
</core/read-preference-mechanics>`. If you do not select an appropriate
121-
server within the `server selection timeout <{+api-root+}/P_MongoDB_Driver_MongoServerSettings_ServerSelectionTimeout.htm>`__, the driver throws a
121+
server within the `server selection timeout <{+new-api-root+}/MongoDB.Driver.Legacy/MongoDB.Driver.MongoServerSettings.html#MongoDB_Driver_MongoServerSettings_ServerSelectionTimeout>`__, the driver throws a
122122
server selection timeout exception. The exception looks similar to the
123123
following:
124124

source/fundamentals/authentication.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -394,8 +394,8 @@ API Documentation
394394
To learn more about any of the methods or types discussed in this
395395
guide, see the following API Documentation:
396396

397-
- `MongoCredential() <{+api-root+}/T_MongoDB_Driver_MongoCredential.htm>`__
398-
- `MongoClient() <{+api-root+}/T_MongoDB_Driver_MongoClient.htm>`__
399-
- `MongoClientSettings <{+api-root+}/T_MongoDB_Driver_MongoClientSettings.htm>`__
400-
- `CreateCredential() <{+api-root+}/M_MongoDB_Driver_MongoCredential_CreateCredential_1.htm>`__
401-
- `CreateMongoX509Credential() <{+api-root+}/M_MongoDB_Driver_MongoCredential_CreateMongoX509Credential.htm>`__
397+
- `MongoCredential() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCredential.html>`__
398+
- `MongoClient() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClient.html>`__
399+
- `MongoClientSettings <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__
400+
- `CreateCredential() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCredential.html#MongoDB_Driver_MongoCredential_CreateCredential_System_String_System_String_System_Security_SecureString_>`__
401+
- `CreateMongoX509Credential() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCredential.html#MongoDB_Driver_MongoCredential_CreateMongoX509Credential_System_String_>`__

source/fundamentals/bson.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ API Documentation
220220
To learn more about any of the methods or types discussed in this
221221
guide, see the following API documentation:
222222

223-
- `BsonDocument <{+api-root+}/T_MongoDB_Bson_BsonDocument.htm>`__
224-
- `BsonElement <{+api-root+}/T_MongoDB_Bson_BsonElement.htm>`__
225-
- `BsonBinaryReader <{+api-root+}/T_MongoDB_Bson_IO_BsonBinaryReader.htm>`__
226-
- `BsonBinaryWriter <{+api-root+}/T_MongoDB_Bson_IO_BsonBinaryWriter.htm>`__
223+
- `BsonDocument <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BsonDocument.html>`__
224+
- `BsonElement <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BsonElement.html>`__
225+
- `BsonBinaryReader <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.IO.BsonBinaryReader.html>`__
226+
- `BsonBinaryWriter <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.IO.BsonBinaryWriter.html>`__

source/fundamentals/builders.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,7 @@ The preceding example creates the following pipeline:
313313
You can add stages to your pipeline that don't have corresponding type-safe
314314
methods in the ``PipelineDefinitionBuilder`` interface by providing your query
315315
as a ``BsonDocument`` to the `AppendStage() method
316-
<{+api-root+}/M_MongoDB_Driver_PipelineDefinitionBuilder_AppendStage__3.htm>`__.
316+
<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.PipelineDefinitionBuilder.html#MongoDB_Driver_PipelineDefinitionBuilder_AppendStage__3_MongoDB_Driver_PipelineDefinition___0___1__MongoDB_Driver_PipelineStageDefinition___1___2__MongoDB_Bson_Serialization_IBsonSerializer___2__>`__.
317317

318318
.. code-block:: csharp
319319

@@ -354,9 +354,9 @@ API Documentation
354354
To learn more about any of the methods or types discussed in this
355355
guide, see the following API Documentation:
356356

357-
- `FilterDefinitionBuilder <{+api-root+}/T_MongoDB_Driver_FilterDefinitionBuilder_1.htm>`__
358-
- `ProjectionDefinitionBuilder <{+api-root+}/T_MongoDB_Driver_ProjectionDefinitionBuilder_1.htm>`__
359-
- `SortDefinitionBuilder <{+api-root+}/T_MongoDB_Driver_SortDefinitionBuilder_1.htm>`__
360-
- `UpdateDefinitionBuilder <{+api-root+}/T_MongoDB_Driver_UpdateDefinitionBuilder_1.htm>`__
361-
- `IndexKeysDefinitionBuilder <{+api-root+}/T_MongoDB_Driver_IndexKeysDefinitionBuilder_1.htm>`__
362-
- `PipelineDefinitionBuilder <{+api-root+}/T_MongoDB_Driver_PipelineDefinitionBuilder.htm>`__
357+
- `FilterDefinitionBuilder <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.FilterDefinitionBuilder-1.html>`__
358+
- `ProjectionDefinitionBuilder <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ProjectionDefinitionBuilder-1.html>`__
359+
- `SortDefinitionBuilder <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.SortDefinitionBuilder-1.html>`__
360+
- `UpdateDefinitionBuilder <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.html>`__
361+
- `IndexKeysDefinitionBuilder <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IndexKeysDefinitionBuilder-1.html>`__
362+
- `PipelineDefinitionBuilder <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.PipelineDefinitionBuilder.html>`__

source/fundamentals/connection/connection-options.txt

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -94,14 +94,14 @@ relevant options.
9494
* - **AutoEncryptionOptions**
9595
- | Settings for automatic client-side encryption.
9696
|
97-
| **Data Type**: `AutoEncryptionOptions <{+api-root+}/T_MongoDB_Driver_Encryption_AutoEncryptionOptions.htm>`__
97+
| **Data Type**: `AutoEncryptionOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Encryption.AutoEncryptionOptions.html>`__
9898
| **Default**: ``null``
9999
| **Connection URI Example**: {+not-available+}
100100

101101
* - **ClusterConfigurator**
102102
- | Low-level configuration options for sockets, TLS, cluster, and others.
103103
|
104-
| **Data Type**: Action<`ClusterBuilder <{+api-root+}/T_MongoDB_Driver_Core_Configuration_ClusterBuilder.htm>`__>
104+
| **Data Type**: Action<`ClusterBuilder <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Configuration.ClusterBuilder.html>`__>
105105
| **Default**: ``null``
106106
| **Connection URI Example**: {+not-available+}
107107

@@ -110,7 +110,7 @@ relevant options.
110110
| or received from the server. The driver uses the first of these compression types
111111
| that the server supports.
112112
|
113-
| **Data Type**: `CompressorConfiguration <{+api-root+}/T_MongoDB_Driver_Core_Configuration_CompressorConfiguration.htm>`__
113+
| **Data Type**: `CompressorConfiguration <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Configuration.CompressorConfiguration.html>`__
114114
| **Default**: ``null``
115115
| **Connection URI Example**: ``compressors=snappy,zstd``
116116

@@ -131,7 +131,7 @@ relevant options.
131131
| :ref:`authentication mechanisms <csharp-authentication-mechanisms>` for available
132132
| authentication mechanisms.
133133
|
134-
| **Data Type**: `MongoCredential <{+api-root+}/T_MongoDB_Driver_MongoCredential.htm>`__
134+
| **Data Type**: `MongoCredential <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCredential.html>`__
135135
| **Default**: ``null``
136136
| **Connection URI Example**:
137137

@@ -190,7 +190,7 @@ relevant options.
190190
* - **LinqProvider**
191191
- | The LINQ provider to use.
192192
|
193-
| **Data Type**: `LinqProvider <{+api-root+}/T_MongoDB_Driver_Linq_LinqProvider.htm>`__
193+
| **Data Type**: `LinqProvider <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Linq.LinqProvider.html>`__
194194
| **Default**: ``LinqProvider.V3``
195195
| **Connection URI Example**: {+not-available+}
196196

@@ -219,7 +219,7 @@ relevant options.
219219
* - **LoggingSettings**
220220
- | The settings used for :ref:`logging. <csharp-logging>`
221221
|
222-
| **Data Type**: `LoggingSettings <{+api-root+}/T_MongoDB_Driver_Core_Configuration_LoggingSettings.htm>`__
222+
| **Data Type**: `LoggingSettings <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Configuration.LoggingSettings.html>`__
223223
| **Default**: ``null``
224224
| **Connection URI Example**: {+not-available+}
225225

@@ -266,7 +266,7 @@ relevant options.
266266
- | The client's default read concern.
267267
| See :ref:`read concern <read-concern>` for more information.
268268
|
269-
| **Data Type**: `ReadConcern <{+api-root+}/T_MongoDB_Driver_ReadConcern.htm>`__
269+
| **Data Type**: `ReadConcern <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ReadConcern.html>`__
270270
| **Default**: ``ReadConcern.Default``
271271
| **Connection URI Example**: ``readConcernLevel=local``
272272

@@ -285,7 +285,7 @@ relevant options.
285285
| still be eligible for server selection. Specifying ``-1`` means no maximum.
286286
| See :ref:`read preference <read-preference>` for more information.
287287
|
288-
| **Data Type**: `ReadPreference <{+api-root+}/T_MongoDB_Driver_ReadPreference.htm>`__
288+
| **Data Type**: `ReadPreference <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ReadPreference.html>`__
289289
| **Default**: ``ReadPreference.Primary``
290290
| **Connection URI Example**:
291291

@@ -336,14 +336,14 @@ relevant options.
336336
| try to use the DNS seed list format, the {+driver-short+} will throw an
337337
| exception.
338338
|
339-
| **Data Type**: `ConnectionStringScheme <{+api-root+}/T_MongoDB_Driver_Core_Configuration_ConnectionStringScheme.htm>`__
339+
| **Data Type**: `ConnectionStringScheme <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Configuration.ConnectionStringScheme.html>`__
340340
| **Default**: ``ConnectionStringScheme.MongoDB``
341341
| **Connection URI Example**: ``mongodb+srv://``
342342

343343
* - **Server**
344344
- | The host and port number where MongoDB is running.
345345
|
346-
| **Data Type**: `MongoServerAddress <{+api-root+}/T_MongoDB_Driver_MongoServerAddress.htm>`__
346+
| **Data Type**: `MongoServerAddress <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoServerAddress.html>`__
347347
| **Default**: ``localhost:27017``
348348
| **Connection URI Example**: ``mongodb://sample.host:27017``
349349

@@ -352,14 +352,14 @@ relevant options.
352352
| :manual:`the MongoDB Manual</reference/stable-api>` for more information about
353353
| Stable API versioning.
354354
|
355-
| **Data Type**: `ServerApi <{+api-root+}/T_MongoDB_Driver_ServerApi.htm>`__
355+
| **Data Type**: `ServerApi <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ServerApi.html>`__
356356
| **Default**: ``null``
357357
| **Connection URI Example**: {+not-available+}
358358

359359
* - **Servers**
360360
- | The cluster members where MongoDB is running.
361361
|
362-
| **Data Type**: IEnumerable<`MongoServerAddress <{+api-root+}/T_MongoDB_Driver_MongoServerAddress.htm>`__>
362+
| **Data Type**: IEnumerable<`MongoServerAddress <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoServerAddress.html>`__>
363363
| **Default**: ``localhost:27017``
364364
| **Connection URI Example**: ``mongodb://sample.host1:27017,sample.host2:27017``
365365

@@ -398,7 +398,7 @@ relevant options.
398398
| ``AllowInsecureTls`` is set to ``true``, the {+driver-short+} will throw
399399
| an exception.
400400
|
401-
| **Data Type**: `SslSettings <{+api-root+}/T_MongoDB_Driver_SslSettings.htm>`__
401+
| **Data Type**: `SslSettings <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.SslSettings.html>`__
402402
| **Default**: ``null``
403403
| **Connection URI Example**: ``tlsDisableCertificateRevocationCheck=false``
404404

@@ -424,7 +424,7 @@ relevant options.
424424
| journaling, for the client.
425425
| See :ref:`write concern <wc-j>` for more information.
426426
|
427-
| **Data Type**: `WriteConcern <{+api-root+}/T_MongoDB_Driver_WriteConcern.htm>`__
427+
| **Data Type**: `WriteConcern <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.WriteConcern.html>`__
428428
| **Default**: ``WriteConcern.Acknowledged``
429429
| **Connection URI Example**: ``w=majority&wTimeoutMS=0&journal=true``
430430

source/fundamentals/connection/network-compression.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ specify the algorithms you want to use in one of the following ways:
5252
:tabid: mongoclientsettings
5353

5454
To enable compression by using
55-
`MongoClientSettings <{+api-root+}/T_MongoDB_Driver_MongoClientSettings.htm>`__,
55+
`MongoClientSettings <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__,
5656
set the ``Compressors`` property of your ``MongoClientSettings`` object to a
5757
``List`` of one or more ``CompressorConfiguration`` objects. Each
5858
``CompressorConfiguration`` object in the ``List`` represents an algorithm you

source/fundamentals/connection/tls.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,4 +225,4 @@ API Documentation
225225
To learn more about any of the connection options discussed in this
226226
guide, see the following API documentation:
227227

228-
- `MongoClientSettings <{+api-root+}/T_MongoDB_Driver_MongoClientSettings.htm>`__
228+
- `MongoClientSettings <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__

source/fundamentals/crud/read-operations/count.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ API Documentation
240240
To learn more about any of the methods or types discussed in this
241241
guide, see the following API Documentation:
242242

243-
- `CountDocuments() <{+api-root+}/M_MongoDB_Driver_IMongoCollection_1_CountDocuments.htm>`__
244-
- `CountOptions <{+api-root+}/T_MongoDB_Driver_CountOptions.htm>`__
245-
- `EstimatedDocumentCount() <{+api-root+}/M_MongoDB_Driver_MongoCollectionBase_1_EstimatedDocumentCount.htm>`__
246-
- `EstimatedDocumentCountOptions <{+api-root+}/T_MongoDB_Driver_EstimatedDocumentCountOptions.htm>`__
243+
- `CountDocuments() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.html#MongoDB_Driver_IMongoCollection_1_CountDocuments_MongoDB_Driver_FilterDefinition__0__MongoDB_Driver_CountOptions_System_Threading_CancellationToken_>`__
244+
- `CountOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.CountOptions.html>`__
245+
- `EstimatedDocumentCount() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCollectionBase-1.html>`__
246+
- `EstimatedDocumentCountOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.EstimatedDocumentCountOptions.html>`__

source/fundamentals/crud/read-operations/retrieve.txt

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@ You can configure the commonly used options with the following methods:
211211
- | Sets the maximum execution time on the server for this operation.
212212

213213
To see a full list of available options, see
214-
`FindOptions Properties <{+api-root+}/Properties_T_MongoDB_Driver_FindOptions.htm>`__.
214+
`FindOptions Properties <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.FindOptions.html>`__.
215215

216216
Example
217217
~~~~~~~
@@ -288,11 +288,11 @@ API Documentation
288288
To learn more about any of the methods or types discussed in this
289289
guide, see the following API Documentation:
290290

291-
- `Find() <{+api-root+}/Overload_MongoDB_Driver_IMongoCollectionExtensions_Find.htm>`__
292-
- `FirstOrDefault() <{+api-root+}/M_MongoDB_Driver_IFindFluentExtensions_FirstOrDefault__2.htm>`__
293-
- `FirstOrDefaultAsync() <{+api-root+}/M_MongoDB_Driver_IAsyncCursorSourceExtensions_FirstOrDefaultAsync__1.htm>`__
294-
- `FindOptions <{+api-root+}/T_MongoDB_Driver_FindOptions.htm>`__
295-
- `ToList() <{+api-root+}/M_MongoDB_Driver_IAsyncCursorSourceExtensions_ToList__1.htm>`__
296-
- `ToListAsync() <{+api-root+}/M_MongoDB_Driver_IAsyncCursorSourceExtensions_ToListAsync__1.htm>`__
297-
- `ToCursor() <{+api-root+}/M_MongoDB_Driver_IAsyncCursorSource_1_ToCursor.htm>`__
298-
- `ToCursorAsync() <{+api-root+}/M_MongoDB_Driver_IAsyncCursorSource_1_ToCursorAsync.htm>`__
291+
- `Find() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollectionExtensions.html#MongoDB_Driver_IMongoCollectionExtensions_Find__1_MongoDB_Driver_IMongoCollection___0__MongoDB_Driver_FilterDefinition___0__MongoDB_Driver_FindOptions_>`__
292+
- `FirstOrDefault() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IFindFluentExtensions.html#MongoDB_Driver_IFindFluentExtensions_FirstOrDefault__2_MongoDB_Driver_IFindFluent___0___1__System_Threading_CancellationToken_>`__
293+
- `FirstOrDefaultAsync() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IAsyncCursorSourceExtensions.html#MongoDB_Driver_IAsyncCursorSourceExtensions_FirstOrDefaultAsync__1_MongoDB_Driver_IAsyncCursorSource___0__System_Threading_CancellationToken_>`__
294+
- `FindOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.FindOptions.html>`__
295+
- `ToList() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IAsyncCursorSourceExtensions.html#MongoDB_Driver_IAsyncCursorSourceExtensions_ToList__1_MongoDB_Driver_IAsyncCursorSource___0__System_Threading_CancellationToken_>`__
296+
- `ToListAsync() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IAsyncCursorSourceExtensions.html#MongoDB_Driver_IAsyncCursorSourceExtensions_FirstOrDefaultAsync__1_MongoDB_Driver_IAsyncCursorSource___0__System_Threading_CancellationToken_>`__
297+
- `ToCursor() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IAsyncCursorSource-1.html#MongoDB_Driver_IAsyncCursorSource_1_ToCursor_System_Threading_CancellationToken_>`__
298+
- `ToCursorAsync() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IAsyncCursorSource-1.html#MongoDB_Driver_IAsyncCursorSource_1_ToCursorAsync_System_Threading_CancellationToken_>`__

0 commit comments

Comments
 (0)