microsoft / microsoft/api-guidelines
[Azure REST API Guidelines]: Add correlation header guidance
Open
Nobody has claimed this yet.
Azure Guidelines
- Dominant language
- No language data
- Stars
- 23.3k
- Forks
- 2.7k
- PR merge metrics
- No merged PRs in 30d
Description
Our guidelines should suggest x-ms-client-request-id for correlation with customer support.
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
Start by reading the REST API guidelines and locate the section covering correlation or request headers. Add guidance recommending x-ms-client-request-id for customer-support correlation, then verify that the wording fits the surrounding guidance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100