GODRIVER-2567 CSFLE/QE Naming #1820
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mongodb-drivers-pr-bot
bot
added
the
review-priority-low
API Change ReportNo changes found! |
prestonvasquez
requested changes
Sep 19, 2024
mongo/doc.go
Outdated
| // Note: Auto encryption is an enterprise- and Atlas-only feature. | ||
| // | ||
| // The libmongocrypt C library is required when using client-side encryption. Specific versions of libmongocrypt | ||
| // The libmongocrypt C library is required when using client-side field level encryption. Specific versions of libmongocrypt |
There was a problem hiding this comment.
Can we extend the doc.go file to include this information from the C PR: https://github.com/mongodb/mongo-c-driver/pull/1255/files#diff-36bfd348aee753ebb9428c3b6d64ebf7fdf3bcdccd3a8338acd480bb70a66f7bR33-R37
The AutoEncryptionOptions are here: https://github.com/mongodb/mongo-go-driver/blob/master/mongo/options/autoencryptionoptions.go
prestonvasquez
requested changes
Sep 23, 2024
mongo/doc.go
Outdated
Comment on lines
111
to
113
| // - The supported algorithms documented in autoencryptionoptions.go do not apply to both features. | ||
| // - SetEncryptedFieldsMap only applies to Queryable Encryption. | ||
| // - SetSchemaMap only applies to CSFLE. |
There was a problem hiding this comment.
Suggest simplifying this:
// - AutoEncryptionOptions.SetEncryptedFieldsMap only applies to Queryable Encryption.
// - AutoEncryptionOptions.SetSchemaMap only applies to CSFLE.
prestonvasquez
approved these changes
Sep 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
GODRIVER-2567
Summary
There is a distinct difference between Queryable Encryption and Client-Side Field Level Encryption made in the Server docs. Drivers must update their docs to reflect correct terminology as-needed.
Both features CSFLE and QE are nested under "In Use Encryption" rather than "Client Side Encryption". Please verify and rename any documents to follow this convention.
Background & Motivation