Azure / Azure/azure-rest-api-specs
[FEATURE REQ] Need more detailed description for ResourceUriParameter
Nobody has claimed this yet.
- Dominant language
- TypeSpec
- Stars
- 3.1k
- Forks
- 6k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 444
Description
### API Spec link
https://github.com/Azure/azure-rest-api-specs/blob/main/specification/monitor/common-types/v2/commonMonitoringTypes.json#L244
### API Spec version
2024-02-01
### Please describe the feature.
The current description for ResourceUriParameter is too sample that may cause confusions, it's better include the expected format like: https://learn.microsoft.com/en-us/rest/api/resources/resources/get-by-id?view=rest-resources-2021-04-01#uri-parameters.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open specification/monitor/common-types/v2/commonMonitoringTypes.json at line 244 and inspect the ResourceUriParameter description. Compare it with the linked Azure resource URI parameter documentation, then update the description to explain the expected format and validate that the API specification remains well formed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 38/100