Add guidance for handling of unrecognized query/header parameter or body property
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Domain
- api, documentation
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.
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?
- Dominant language
- No language data
- Stars
- 23.3k
- Forks
- 2.7k
- PR merge metrics
- No merged PRs in 30d
Getting set up
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.
More from microsoft/api-guidelines
-
Difficulty 1/5 1-3 hours Newbie friendliness 68/100
microsoft/api-guidelines#571 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
microsoft/api-guidelines#595 · 1 comment ·
-
Difficulty 5/5 Over a week Newbie friendliness 5/100
microsoft/api-guidelines#570 ·
-
ImOpen
Difficulty 5/5 Over a week Newbie friendliness 10/100
microsoft/api-guidelines#562 ·
-
Difficulty 5/5 Over a week Newbie friendliness 1/100
microsoft/api-guidelines#560 ·
All issues in microsoft/api-guidelines
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
openfoodfacts/score-my-recipe#80 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
snapshot-labs/stamp#702 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
-
Cainophile EXIT handler crashes on its own password redaction and logs the DB password in clear textOpen
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
digitallyinduced/ihp#2832 ·
Maintainers usually reply within 1 day