CLOUDP-319370: Add curl and atlascli samples to the OAS #722
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
This reverts commit 14fdfdc.
blva
reviewed
May 20, 2025
blva
reviewed
May 20, 2025
| return codeSample{ | ||
| Lang: "cURL", | ||
| Label: "Atlas CLI", | ||
| Source: "atlas api " + op.OperationID + " --help", |
There was a problem hiding this comment.
more of a q for @jeroenvervaeke or maybe @andreaangiolillo already checked this, are there any OperationIDs/apis not included in auto-gen that we should account for here and filter them out?
blva
reviewed
May 20, 2025
blva
approved these changes
May 20, 2025
andreaangiolillo
added a commit
that referenced
this pull request
May 20, 2025
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.
Proposed changes
Jira ticket: CLOUDP-319370
This PR adds curl and Atlas CLI examples to our OpenAPI specification. You can view the generated OpenAPI spec at this link. If you compare it to the current MongoDB documentation, you’ll notice that the new version includes an additional Request Sample section with both a curl request and an Atlas CLI example.
Examples: