Skip to content

Update api links for 5.5 link changes #95

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 8, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions snooty.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"
driver-long = "MongoDB Kotlin Sync Driver"
driver-short = "Kotlin Sync driver"
language = "Kotlin"
version-number = "5.4"
version-number = "5.5"
full-version = "{+version-number+}.0"
version = "v{+version-number+}"
mdb-server = "MongoDB Server"
stable-api = "Stable API"
api-root = "https://mongodb.github.io/mongo-java-driver/{+version-number+}/apidocs"
driver-api = "{+api-root+}/mongodb-driver-kotlin-sync/mongodb-driver-kotlin-sync/com.mongodb.kotlin.client"
core-api = "{+api-root+}/mongodb-driver-core/com/mongodb"
driver-api = "{+api-root+}/driver-kotlin-sync/mongodb-driver-kotlin-sync/com.mongodb.kotlin.client"
core-api = "{+api-root+}/driver-core/com/mongodb"
kotlin-docs = "https://kotlinlang.org"
serialization-version = "1.6.0"
kotlinx-dt-version = "0.6.1"
Expand Down
12 changes: 6 additions & 6 deletions source/api.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,19 @@ API Documentation
:titlesonly:
:maxdepth: 1

{+language+} Sync Driver <{+api-root+}/mongodb-driver-kotlin-sync/index.html>
{+language+} Sync Driver <{+api-root+}/driver-kotlin-sync/index.html>
BSON kotlinx.serialization <{+api-root+}/bson-kotlinx/index.html>
{+language+} Driver Extensions <{+api-root+}/mongodb-driver-kotlin-extensions/index.html>
Driver Core <{+api-root+}/mongodb-driver-core/index.html>
{+language+} Driver Extensions <{+api-root+}/driver-kotlin-extensions/index.html>
Driver Core <{+api-root+}/driver-core/index.html>

- `{+language+} Sync Driver <{+api-root+}/mongodb-driver-kotlin-sync/index.html>`__ -
- `{+language+} Sync Driver <{+api-root+}/driver-kotlin-sync/index.html>`__ -
classes for the current synchronous driver API.
- `BSON kotlinx.serialization <{+api-root+}/bson-kotlinx/index.html>`__ -
classes for encoding and decoding between Kotlin data classes and the BSON data
format using :github:`kotlinx.serialization <Kotlin/kotlinx.serialization>`.
- `{+language+} Driver Extensions
<{+api-root+}/mongodb-driver-kotlin-extensions/index.html>`__ -
<{+api-root+}/driver-kotlin-extensions/index.html>`__ -
classes that extend the core builder classes to support :ref:`data
classes <kotlin-sync-builders-data-classes>`.
- `Driver Core <{+api-root+}/mongodb-driver-core/index.html>`__ - classes that
- `Driver Core <{+api-root+}/driver-core/index.html>`__ - classes that
contain essential driver functionality.
2 changes: 1 addition & 1 deletion source/builders/builders-data-classes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -259,4 +259,4 @@ API Documentation
-----------------

- `{+driver-short+} Extensions
<{+api-root+}/mongodb-driver-kotlin-extensions/index.html>`__
<{+api-root+}/driver-kotlin-extensions/index.html>`__
7 changes: 4 additions & 3 deletions source/data-formats/codecs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ For more information about the classes and interfaces in this section, see
the following API documentation:

- `CodecProvider <{+api-root+}/bson/org/bson/codecs/configuration/CodecProvider.html>`__
- `getCodecRegistry() <{+api-root+}/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#getCodecRegistry()>`__
- `getCodecRegistry() <{+core-api+}/MongoClientSettings.html#getCodecRegistry()>`__

BsonTypeClassMap
~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -386,5 +386,6 @@ retrieves data by using the ``Monolight`` class:
For more information about the methods and classes mentioned in this section,
see the following API documentation:

- `withCodecRegistry() <{+api-root+}/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#withCodecRegistry(org.bson.codecs.configuration.CodecRegistry)>`__
- `fromRegistries() <{+api-root+}/bson/org/bson/codecs/configuration/CodecRegistries.html#fromRegistries(org.bson.codecs.configuration.CodecRegistry...)>`__
- `withCodecRegistry() <{+driver-api+}/-mongo-collection/with-codec-registry.html>`__
- `fromRegistries()
<{+api-root+}/bson/org/bson/codecs/configuration/CodecRegistries.html#fromRegistries(org.bson.codecs.configuration.CodecRegistry...)>`__
2 changes: 1 addition & 1 deletion source/security/enterprise-auth.txt
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ to improve performance.

To cache Kerberos tickets by process, you must specify the ``JAVA_SUBJECT_PROVIDER``
mechanism property and provide a
`KerberosSubjectProvider <https://mongodb.github.io/mongo-java-driver/4.2/apidocs/mongodb-driver-core/com/mongodb/KerberosSubjectProvider.html#%3Cinit%3E()>`__
`KerberosSubjectProvider <{+core-api+}/KerberosSubjectProvider.html>`__
in your ``MongoCredential`` instance. The code to configure the Kotlin driver to cache Kerberos tickets
by process should resemble the following:

Expand Down
2 changes: 1 addition & 1 deletion source/whats-new.txt
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ improvements, and fixes:
- Support for using builders class methods directly with data class
properties. To learn more, see the :ref:`kotlin-sync-builders-data-classes`
guide. This functionality is supported by the `{+driver-short+}
Extensions package <{+api-root+}/mongodb-driver-kotlin-extensions/index.html>`__
Extensions package <{+api-root+}/driver-kotlin-extensions/index.html>`__
published with this release.

- Implements a *client* bulk write API that allows you to perform write
Expand Down
Loading