microsoft / microsoft/api-guidelines
Clarify Permissive-In / Strict-Out Naming Policy in Guidelines
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
Microsoft API Guidelines needs an update to clarify the Permissive-In / Strict-Out naming policy for API request and response.
https://github.com/microsoft/api-guidelines/blob/vNext/graph/GuidelinesGraph.md#naming
Add a section under Naming Conventions Input/Output Handling
Recommend that APIs:
- Accept a broader range of inputs (e.g., case-insensitive, lenient formats)
- Emit consistent, canonical outputs (e.g., strict casing, normalized values)
Encourage documentation of canonical forms and accepted variants
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 graph/GuidelinesGraph.md at the Naming section and review the existing Input/Output Handling guidance. Add the requested Permissive-In / Strict-Out section covering accepted variants, canonical outputs, and documentation of both; done means the guidance is clear and consistent with the surrounding naming policy.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100