CLOUDP-300821: [AtlasCLI] Update help text of commands with --file flags to clarify we will ignore not documented fields #3683
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
github-actions
bot
added
need-doc-review
|
APIx Bot |
: a message has been sent to Docs Slack channel 🚀.
gssbzn
reviewed
Feb 24, 2025
| @@ -56,7 +56,7 @@ Options | |||
| * - -f, --file | |||
| - string | |||
| - false | |||
| - Path to an optional JSON configuration file that defines invitation settings. To learn more about invitation configuration files for the Atlas CLI, see https://XXX. | |||
| - Path to an optional JSON configuration file that defines invitation settings. Note: Unsupported fields in the JSON file are ignored. To learn more about invitation configuration files for the Atlas CLI, see https://XXX. | |||
There was a problem hiding this comment.
Good catch, I've removed the URL for now, since there's no documentation yet.
I also created a DOCSP ticket to create this page: https://jira.mongodb.org/browse/DOCSP-47853
|
Coverage Report 📈
|
gssbzn
approved these changes
Feb 24, 2025
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Proposed changes
file.Loadinternal/cli/organizations/invitations/update.go,--filewas not a registered flagJira ticket: CLOUDP-300821