CDRIVER-4489 update URI documentation for authMechanismProperties #1941
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
kevinAlbs
reviewed
Mar 20, 2025
kevinAlbs
approved these changes
Mar 20, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Followup to #1896 which updates API documentation for relevant URI options (CDRIVER-4489). Additionally deprecates old GSSAPI URI options in favor of using
authMechanismPropertiesinstead (CDRIVER-5933).This PR also preemptively adds the warning required by the Authentication spec:
The wording is adjusted to indicate that mongoc will interpret the presence of a comma as a key-value pair delimiter. More importantly, in contrast to the spec and associated spec tests, percent-encoded commas will be permitted as an extension to improve user experience, as they do not interfere with the parsing of
authMechanismPropertiesor the connection string as implied by the spec. This requires upcoming changes which are separate from this PR.Aside: ReStructuredText is painpainpain. 🫠