Merge pull request #20 from mongodben/DOCSP-29239

(DOCSP-29239): Kotlin Stable API page

Author: mongodben

examples/src/test/kotlin/StableApiTest.kt

@@ -0,0 +1,55 @@
+
+import com.mongodb.ConnectionString
+import com.mongodb.MongoClientSettings
+import com.mongodb.ServerApi
+import com.mongodb.ServerApiVersion
+import com.mongodb.kotlin.client.coroutine.MongoClient
+import io.github.cdimascio.dotenv.dotenv
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.TestInstance
+import kotlin.test.assertEquals
+
+
+@TestInstance(TestInstance.Lifecycle.PER_CLASS)
+internal class StableApiTest {
+
+    companion object {
+        val dotenv = dotenv()
+        val CONNECTION_URI_PLACEHOLDER = dotenv["MONGODB_CONNECTION_URI"]
+    }
+    @Test
+    fun connectToStableApiTest() {
+        // :snippet-start: connect-to-stable-api
+        val serverApi = ServerApi.builder()
+            .version(ServerApiVersion.V1)
+            .build()
+
+        // Replace the uri string placeholder with your MongoDB deployment's connection string
+        val uri = CONNECTION_URI_PLACEHOLDER
+
+        val settings = MongoClientSettings.builder()
+            .applyConnectionString(ConnectionString(uri))
+            .serverApi(serverApi)
+            .build()
+
+        val client = MongoClient.create(settings)
+        // :snippet-end:
+        client.close()
+        assert(settings.serverApi?.version == ServerApiVersion.V1)
+    }
+
+    @Test
+    fun stableApiSettingsTest() {
+        // :snippet-start: stable-api-settings
+        val serverApi = ServerApi.builder()
+            .version(ServerApiVersion.V1)
+            .strict(true)
+            .deprecationErrors(true)
+            .build()
+        // :snippet-end:
+        assert(serverApi.version == ServerApiVersion.V1)
+        assertEquals(true, serverApi.strict.get())
+        assertEquals(true, serverApi.deprecationErrors.get())
+    }
+
+}

source/examples/generated/StableApiTest.snippet.connect-to-stable-api.kt

@@ -0,0 +1,13 @@
+val serverApi = ServerApi.builder()
+    .version(ServerApiVersion.V1)
+    .build()
+
+// Replace the uri string placeholder with your MongoDB deployment's connection string
+val uri = CONNECTION_URI_PLACEHOLDER
+
+val settings = MongoClientSettings.builder()
+    .applyConnectionString(ConnectionString(uri))
+    .serverApi(serverApi)
+    .build()
+
+val client = MongoClient.create(settings)

source/examples/generated/StableApiTest.snippet.stable-api-settings.kt

@@ -0,0 +1,5 @@
+val serverApi = ServerApi.builder()
+    .version(ServerApiVersion.V1)
+    .strict(true)
+    .deprecationErrors(true)
+    .build()

source/fundamentals.txt

@@ -9,6 +9,7 @@ Fundamentals
    :maxdepth: 1
 
    /fundamentals/connection
+   /fundamentals/stable-api
    /fundamentals/databases-collections
    /fundamentals/data-formats
    /fundamentals/crud
@@ -21,7 +22,6 @@ Fundamentals
 .. TODO : add back in after MVP
    .. /fundamentals/auth
    .. /fundamentals/enterprise-auth
-   .. /fundamentals/stable-api
    .. /fundamentals/collations
    .. /fundamentals/gridfs
    .. /fundamentals/csfle

source/fundamentals/stable-api.txt

@@ -69,14 +69,11 @@ following operations:
 - Construct a ``MongoClientSettings`` instance using the
   ``MongoClientSettings.Builder`` class.
 - Specify a server to connect to using a ``ServerAddress`` instance.
-- Instantiate a ``MongoClient`` using the ``MongoClients.create()`` method
+- Instantiate a ``MongoClient`` using the ``MongoClient.create()`` method
   and pass your ``MongoClientSettings`` instance as a parameter.
 
-.. literalinclude:: /includes/fundamentals/code-snippets/StableApiExample.java
-   :start-after: start serverAPIVersion
-   :end-before: end serverAPIVersion
-   :language: java
-   :dedent:
+.. literalinclude:: /examples/generated/StableApiTest.snippet.connect-to-stable-api.kt
+   :language: kotlin
 
 .. warning::
 
@@ -95,14 +92,14 @@ following operations:
 For more information on the methods and classes referenced in this
 section, see the following API Documentation:
 
-- `ServerApi <{+api+}/apidocs/mongodb-driver-core/com/mongodb/ServerApi.html>`__
-- `ServerApi.Builder <{+api+}/apidocs/mongodb-driver-core/com/mongodb/ServerApi.Builder.html>`__
-- `ServerApiVersion <{+api+}/apidocs/mongodb-driver-core/com/mongodb/ServerApiVersion.html>`__
-- `ServerAddress <{+api+}/apidocs/mongodb-driver-core/com/mongodb/ServerAddress.html>`__
-- `MongoClientSettings <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.html>`__
-- `MongoClientSettings.Builder <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html>`__
-- `MongoClients.create() <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/MongoClients.html#create(com.mongodb.MongoClientSettings)>`__
-- `MongoClient <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/MongoClient.html>`__
+- `ServerApi <TODO:(DOCSP-29169)>`__
+- `ServerApi.Builder <TODO:(DOCSP-29169)>`__
+- `ServerApiVersion <TODO:(DOCSP-29169)>`__
+- `ServerAddress <TODO:(DOCSP-29169)>`__
+- `MongoClientSettings <TODO:(DOCSP-29169)>`__
+- `MongoClientSettings.Builder <TODO:(DOCSP-29169)>`__
+- `MongoClient.create() <TODO:(DOCSP-29169)>`__
+- `MongoClient <TODO:(DOCSP-29169)>`__
 
 .. _versioned-api-options:
 .. _stable-api-options:
@@ -134,15 +131,12 @@ described in the following table.
 The following example shows how you can set the two options on an instance
 of ``ServerApi`` by chaining methods on the ``ServerApi.Builder``:
 
-.. literalinclude:: /includes/fundamentals/code-snippets/StableApiExample.java
-   :start-after: start apiVersionOptions
-   :end-before: end apiVersionOptions
-   :language: java
-   :dedent:
+.. literalinclude:: /examples/generated/StableApiTest.snippet.stable-api-settings.kt
+   :language: kotlin
 
 For more information on the options in this section, see the following
 API Documentation: 
 
-- `strict() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/ServerApi.Builder.html#strict(boolean)>`__
-- `deprecationErrors() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/ServerApi.Builder.html#>`__
+- `strict() <TODO:(DOCSP-29169)>`__
+- `deprecationErrors() <TODO:(DOCSP-29169)>`__
 

source/includes/fundamentals-sections.rst

@@ -12,7 +12,6 @@ Fundamentals section:
 - :doc:`Monitor Driver Events </fundamentals/monitoring>`
 
 .. TODO : add back in after MVP
-
 .. - :doc:`Authenticate with MongoDB </fundamentals/auth>`
 .. - :doc:`Transform your Data </fundamentals/aggregation>`
 .. - :doc:`Sort Using Collations </fundamentals/collations>`