Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature Request] Help message should show a link to the underlying REST API #30570

Open
jiasli opened this issue Dec 23, 2024 · 1 comment
Open
Assignees
Labels
Azure CLI Team The command of the issue is owned by Azure CLI team feature-request
Milestone

Comments

@jiasli
Copy link
Member

jiasli commented Dec 23, 2024

Related command

Is your feature request related to a problem? Please describe.
Azure CLI internally calls REST APIs to do its job. However, the Azure CLI documentation (both in-tool and online) lacks the information of which REST APIs are called. This can only be retrieved by inspecting the --debug log.

Showing a link to the under API is helpful to tell:

  1. The output JSON format (no response format for cli calls anywhere in the docs #17332)
  2. The permission required to call this API (No permission clarification for az ad commands #22362)

Describe the solution you'd like
Help message should show a link to the underlying REST API.

Describe alternatives you've considered
Document the output JSON format and required permission, but it is very hard to maintain and synchronize with the underlying API.

Additional context

@yonzhan
Copy link
Collaborator

yonzhan commented Dec 23, 2024

Feature Request

@yonzhan yonzhan added feature-request Azure CLI Team The command of the issue is owned by Azure CLI team labels Dec 23, 2024
@yonzhan yonzhan added this to the Backlog milestone Dec 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Azure CLI Team The command of the issue is owned by Azure CLI team feature-request
Projects
None yet
Development

No branches or pull requests

2 participants