microsoft / microsoft/api-guidelines
Add guidance for handling of unrecognized query/header parameter or body property
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 23.3k
- Forks
- 2.7k
- PR merge metrics
- No merged PRs in 30d
Description
What is the expected / recommended behavior of a service for a request that contains a query or header parameter that it does not recognize? What about an unexpected body property?
And what if the param / property is recognized but only for a later api-version than the one specified in the request?
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 with the issue questions about unrecognized query or header parameters, unexpected body properties, and parameters introduced in later API versions. Review the surrounding API Guidelines structure and existing guidance, then document the recommended behavior for each case; done means the guidance resolves all three scenarios consistently.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100