[Feature Request] Help message should show a link to the underlying REST API
- Dominant language
- Python
- Stars
- 4.6k
- Forks
- 3.5k
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 60
Description
**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 (https://github.com/Azure/azure-cli/issues/17332)
1. The permission required to call this API (https://github.com/Azure/azure-cli/issues/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**
Contributor guide
Assessment
This issue has not been assessed yet.