DOCSP-25339 (#2026)

* add api docs for rewrapmanydatakeys methods

* move to shared include

* broken links

* update product names, add as constants

Author: biniona-mongodb

snooty.toml

@@ -238,6 +238,9 @@ pgp-fingerprint-fmt = "E162 F504 A20C DF15 827F  718D 4B7C 549A 058F 8B6B"
 pgp-short-fingerprint = "0x4B7C549A058F8B6B"
 windows-sha256 = "C777DF7816BB8C9A760FDEA782113949408B6F39D72BE29A2551FA51E2FE0473"
 source-available = ":github:`source available and free to use <mongodb/mongo>`"
+pcre-abbr = ":abbr:`PCRE (Perl Compatible Regular Expressions)`"
+pcre = "Perl Compatible Regular Expressions"
+# In Use Encryption Constants
 csfle = "Client-Side Field Level Encryption"
 csfle-abbrev = "CSFLE"
 in-use-doc = "document with encrypted fields"
@@ -254,8 +257,6 @@ dek-abbr-no-hover = "DEK"
 cmk-abbr-no-hover = "CMK"
 key-vault-long = "Key Vault collection"
 key-vault-long-title = "Key Vault Collection"
-java-driver-version = "4.6"
-java-driver-api = "https://mongodb.github.io/mongo-java-driver/{+java-driver-version+}/apidocs"
 aws-abbr = ":abbr:`AWS (Amazon Web Services)`"
 aws-iam-abbr = ":abbr:`IAM (Identity and Access Management)`"
 aws-arn-abbr = ":abbr:`ARN (Amazon Resource Name)`"
@@ -285,9 +286,19 @@ shared-library-package = "``crypt_shared``"
 efm = "``encryptedFieldsMap``"
 auto-encrypt-options = "autoEncryptionOpts"
 title-auto-encrypt-options = "AutoEncryptionOpts"
-pcre-abbr = ":abbr:`PCRE (Perl Compatible Regular Expressions)`"
-pcre = "Perl Compatible Regular Expressions"
-
+# Driver Constants
+java-driver-full = "MongoDB Java driver"
+node-driver-full = "MongoDB Node.js driver"
+go-driver-full = "MongoDB Go driver"
+pymongo = "PyMongo"
+csharp-driver-full = "MongoDB C#/.NET driver"
+java-driver-version = "4.6"
+java-driver-api = "https://mongodb.github.io/mongo-java-driver/{+java-driver-version+}/apidocs"
+pymongo-api-docs = "https://pymongo.readthedocs.io/en/stable/api"
+node-libmongocrypt-binding-docs = "https://github.com/mongodb/libmongocrypt/tree/master/bindings"
+csharp-api-docs = "https://mongodb.github.io/mongo-csharp-driver/2.18/apidocs/html"
+java-api-docs = "https://mongodb.github.io/mongo-java-driver/4.7/apidocs"
+go-api-docs = "https://pkg.go.dev/go.mongodb.org/[email protected]"
 
 [[banners]]
 targets = [

source/core/csfle/fundamentals/keys-key-vaults.txt

@@ -158,26 +158,7 @@ client's ``MongoClient`` object, see the
 Update a {+key-vault-long-title+}
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-To add a {+dek-abbr+} to your {+key-vault-long+}, use the ``createKey`` method of a
-``ClientEncryption`` object.
-
-To delete or update a {+dek-abbr+}, use standard
-:manual:`CRUD </crud>` operations. You store a {+dek-abbr-no-hover+}
-in MongoDB as a document, and you can apply any document operation to a
-{+dek-abbr-no-hover+}.
+.. include:: /includes/in-use-encryption/update-a-key.rst
 
 To view a tutorial that shows how to create a {+dek-abbr+}, see
 the :ref:`Quick Start <csfle-local-create-dek>`.
-
-.. tip:: mongosh Specific Features
-
-   :binary:`~bin.mongosh` provides the following additional
-   methods for working with your {+key-vault-long+}:   
-  
-   - :method:`getKeyVault()`
-   - :method:`KeyVault.getKey()`
-   - :method:`KeyVault.getKeys()`
-   - :method:`KeyVault.getKeyByAltName()`
-   - :method:`KeyVault.createKey()`
-   - :method:`KeyVault.addKeyAlternateName()`
-   - :method:`KeyVault.removeKeyAlternateName()`

source/core/queryable-encryption/fundamentals/keys-key-vaults.txt

@@ -130,26 +130,7 @@ client's ``MongoClient`` object, see the
 Update a {+key-vault-long-title+}
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-To add a {+dek-abbr+} to your {+key-vault-long+}, use the ``createKey`` method of a
-``ClientEncryption`` object.
-
-To delete or update a {+dek-abbr+}, use standard
-:manual:`CRUD </crud>` operations. You store a {+dek-abbr-no-hover+}
-in MongoDB as a document, and you can apply any document operation to a
-{+dek-abbr-no-hover+}.
+.. include:: /includes/in-use-encryption/update-a-key.rst
 
 To view a tutorial that shows how to create a {+dek-abbr+}, see
 the :ref:`Quick Start <qe-local-create-dek>`.
-
-.. tip:: mongosh Specific Features
-
-   :binary:`~bin.mongosh` provides the following additional
-   methods for working with your {+key-vault-long+}:
-
-   - :method:`getKeyVault()`
-   - :method:`KeyVault.getKey()`
-   - :method:`KeyVault.getKeys()`
-   - :method:`KeyVault.getKeyByAltName()`
-   - :method:`KeyVault.createKey()`
-   - :method:`KeyVault.addKeyAlternateName()`
-   - :method:`KeyVault.removeKeyAlternateName()`

source/includes/in-use-encryption/update-a-key.rst

@@ -0,0 +1,31 @@
+To add a {+dek-abbr+} to your {+key-vault-long+}, use the ``createKey`` method of a
+``ClientEncryption`` object.
+
+To delete or update a {+dek-abbr+}, use one of the following mechanisms:
+
+- The ``rewrapManyDataKey`` method
+- Standard :manual:`CRUD </crud>` operations 
+
+To learn more about the ``rewrapManyDataKey`` method, see the documentation
+of the method for your client or driver:
+
+- :ref:`MongoDB Shell <server-keyvault-rewrap-manydatakey-method>`
+- `{+pymongo+} <{+pymongo-api-docs+}/pymongo/encryption.html#pymongo.encryption.ClientEncryption.rewrap_many_data_key>`__
+- `{+node-driver-full+} <{+node-libmongocrypt-binding-docs+}/node#RewrapManyDataKeyResult>`__
+- `{+csharp-driver-full+} <{+csharp-api-docs+}/M_MongoDB_Driver_Encryption_ClientEncryption_RewrapManyDataKey.htm>`__
+- `{+java-driver-full+} <{+java-api-docs+}/mongodb-driver-sync/com/mongodb/client/vault/ClientEncryption.html#rewrapManyDataKey(org.bson.conversions.Bson)>`__
+- `{+go-driver-full+} <{+go-api-docs+}/mongo#ClientEncryption.RewrapManyDataKey>`__
+
+.. tip:: mongosh Specific Features
+
+   :binary:`~bin.mongosh` provides the following additional
+   methods for working with your {+key-vault-long+}:
+
+   - :method:`getKeyVault()`
+   - :method:`KeyVault.getKey()`
+   - :method:`KeyVault.getKeys()`
+   - :method:`KeyVault.getKeyByAltName()`
+   - :method:`KeyVault.createKey()`
+   - :method:`KeyVault.rewrapManyDataKey()`
+   - :method:`KeyVault.addKeyAlternateName()`
+   - :method:`KeyVault.removeKeyAlternateName()`