Skip to content

Update api links for 5.5 link changes #217

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 1 commit 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 @@ -20,16 +20,16 @@ sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"
driver = "kotlin"
driver-short = "Kotlin driver"
driver-long = "MongoDB Kotlin Driver"
version = "5.4"
version = "5.5"
full-version = "{+version+}.0"
language = "Kotlin"
mdb-server = "MongoDB server"
kotlin-docs = "https://kotlinlang.org"

package-name-org = "mongodb-org"
api-root = "https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs"
core-api = "{+api-root+}/mongodb-driver-core/com/mongodb"
driver-api = "{+api-root+}/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine"
core-api = "{+api-root+}/driver-core/com/mongodb"
driver-api = "{+api-root+}/driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine"
stable-api = "Stable API"
mongocrypt-version = "{+full-version+}"
snappyVersion = "org.xerial.snappy:snappy-java:1.1.8.4"
Expand Down
17 changes: 7 additions & 10 deletions source/api-documentation.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,19 @@ API Documentation
:titlesonly:
:maxdepth: 1

{+language+} Coroutine Driver <{+api-root+}/driver-kotlin-coroutine/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+} Coroutine Driver <{+api-root+}/mongodb-driver-kotlin-coroutine/index.html>
{+language+} Sync Driver <{+api-root+}/mongodb-driver-kotlin-sync/index.html>
{+language+} Driver Extensions <{+api-root+}/driver-kotlin-extensions/index.html>
Driver Core <{+api-root+}/driver-core/index.html>

- `{+language+} Coroutine Driver <{+api-root+}/driver-kotlin-coroutine/index.html>`__ -
classes for the current driver API using coroutines.
- `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-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.
- `{+language+} Coroutine Driver <{+api-root+}/mongodb-driver-kotlin-coroutine/index.html>`__ -
classes for the current driver API using coroutines.
- `{+language+} Sync Driver <{+api-root+}/mongodb-driver-kotlin-sync/index.html>`__ -
classes for the current synchronous driver API.
2 changes: 1 addition & 1 deletion source/fundamentals/builders/builders-data-classes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -246,4 +246,4 @@ API Documentation
-----------------

- `{+driver-short+} Extensions
<{+api-root+}/mongodb-driver-kotlin-extensions/index.html>`__
<{+api-root+}/driver-kotlin-extensions/index.html>`__
5 changes: 3 additions & 2 deletions source/fundamentals/connection/socks5.txt
Original file line number Diff line number Diff line change
Expand Up @@ -110,5 +110,6 @@ following API documentation:

- `MongoClientSettings.Builder <{+core-api+}/MongoClientSettings.Builder.html>`__
- `SocketSettings.Builder <{+core-api+}/connection/SocketSettings.Builder.html>`__
- `MongoClient.create() <{+api-root+}/mongodb-driver-sync/com/mongodb/client/MongoClients.html#create(com.mongodb.MongoClientSettings)>`__
- `ProxySettings.Builder <{+core-api+}/connection/ProxySettings.Builder.html>`__
- `MongoClient.create() <{+driver-api+}/-mongo-client/-factory/index.html>`__
- `ProxySettings.Builder
<{+core-api+}/connection/ProxySettings.Builder.html>`__
4 changes: 2 additions & 2 deletions source/fundamentals/databases-collections.txt
Original file line number Diff line number Diff line change
Expand Up @@ -171,8 +171,8 @@ Drop a Collection
-----------------

You can remove a collection from the database using the
`MongoCollection.drop()
<{+api-root+}/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#drop()>`__ method:
`MongoCollection.drop() <{+driver-api+}/-mongo-collection/drop.html>`__
method:

.. literalinclude:: /examples/generated/DatabaseCollectionsTest.snippet.drop-collections.kt
:language: kotlin
Expand Down
13 changes: 8 additions & 5 deletions source/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Fundamentals
API Documentation
-----------------

The MongoDB Kotlin driver API documentation contains several libraries
The {+driver-short+} API documentation contains several libraries
organized by functionality. For detailed information about classes and
methods in each library, see the following table for their descriptions
and links to the API documentation.
Expand All @@ -83,17 +83,20 @@ and links to the API documentation.
* - Library
- Description

* - `Kotlin Coroutine Driver <{+api-root+}/driver-kotlin-coroutine/index.html>`__
- Coroutine API

* - `BSON <{+api-root+}/bson/index.html>`__
- Base BSON classes

* - `BSON Record Codec <{+api-root+}/bson-record-codec/index.html>`__
- Classes that support records

* - `Core <{+api-root+}/mongodb-driver-core/index.html>`__
- Shared core classes
* - `Driver Extensions <{+api-root+}/driver-kotlin-extensions/index.html>`__
- Classes that support using data classes with builders

* - `Kotlin Driver <{+api-root+}/mongodb-driver-kotlin-coroutine/index.html>`__
- API
* - `Core <{+api-root+}/driver-core/index.html>`__
- Shared core classes between JVM drivers

FAQ
---
Expand Down
2 changes: 1 addition & 1 deletion source/usage-examples/deleteMany.txt
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,4 @@ page, see the following API Documentation:

- `deleteMany() <{+driver-api+}/-mongo-collection/delete-many.html>`__
- `DeleteResult <{+core-api+}/client/result/DeleteResult.html>`__
- `drop() <{+api-root+}/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#drop()>`__
- `drop() <{+driver-api+}/-mongo-collection/drop.html>`__
2 changes: 1 addition & 1 deletion source/whats-new.txt
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ improvements, and fixes:
- Support for using builders class methods directly with data class
properties. To learn more, see the :ref:`kotlin-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