GODRIVER-2758: Add documentation examples #1759
Merged
Conversation
This file contains 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
pmeredit
commented
Aug 15, 2024
mongo/client_examples_test.go
Outdated
| // Azure Kubernetes Service (AKS), you can use the `azidentity package` | ||
| // (https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity) | ||
| // to fetch the credentials. In each case, the OIDCCallback function should return | ||
| // the AccessToken from the azidentity package. |
There was a problem hiding this comment.
I wasn't sure how to actually add an example for this because I didn't want to add the azidentity package to the go driver go.mod file.
There was a problem hiding this comment.
Yeah, I think what you have makes sense.
pmeredit
force-pushed
the
GODRIVER-2758
branch
from
3500d8e
to
3a21e18
Compare
API Change ReportNo changes found! |
blink1073
reviewed
Aug 16, 2024
Co-authored-by: Steven Silvester <steve.silvester@mongodb.com>
|
Two spelling errors and one addition needed to mongo/client_examples_test.go:605: AKS ==> ASK |
|
Once this is approved, I will add the same examples for https://jira.mongodb.org/browse/GODRIVER-3174 |
blink1073
added
priority-2-medium
blink1073
added
priority-1-high
|
Build and static checks are passing, I'll merge and cherry-pick. |
blink1073
pushed a commit
to blink1073/mongo-go-driver
that referenced
this pull request
Sep 11, 2024
Co-authored-by: Steven Silvester <steve.silvester@mongodb.com> Co-authored-by: Matt Dale <9760375+matthewdale@users.noreply.github.com> (cherry picked from commit 485e74d)
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.
GODRIVER-2758
Summary
Add documentation examples for OIDC using (hopefully) a style consistent with go driver's other documentation examples
Background & Motivation
OIDC epic