docs(readme): replace invalid command examples with valid ones#4
Merged
Conversation
The Quick Start, API scope/version, and Exploring Commands sections referenced commands that don't exist or use the wrong flag form: - 'iam users list' -> 'iam users search' (no list method on users) - '--userId' -> '--user-id' (kebab-case is the parser-recognised form) - 'iam users get 123' -> 'iam roles get --role-id my-role' (positional args aren't accepted, and iam users get only supports admin/v3 so the multi-scope/multi-version example never worked; iam roles get genuinely covers admin v3+v4 and public v3)
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Three sections of the README referenced commands that don't exist or use the wrong flag form:
Quick Start
iam users list->iam users search(nolistmethod on users)--userId->--user-id(kebab-case is the parser-recognised form)describe iam users list->describe iam users searchAPI scope/version examples
The previous examples used positional
iam users get 123(positional args aren't accepted) andiam users getonly supportsadmin/v3— so the--api-scope publicand--api-version v2lines would have errored at runtime. Switched toiam roles get --role-id my-role, which genuinely coversadmin (v3, v4)andpublic (v3).Exploring Commands
describe iam users list->describe iam users searchOther examples in the README (
auth,doctor,refresh-specs,profile,config,--helpchains) verified valid against the current CLI surface.