Clarify Permissive-In / Strict-Out Naming Policy in Guidelines
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Domain
- api, documentation
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.
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
- Dominant language
- No language data
- Stars
- 23.3k
- Forks
- 2.7k
- PR merge metrics
- No merged PRs in 30d
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.
More from microsoft/api-guidelines
-
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 ·
-
Im Open
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 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 58/100
microsoft/api-guidelines#559 ·
All issues in microsoft/api-guidelines
Similar issues
-
Area: Excel support
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
orbeon/orbeon-forms#7893 ·
-
essnmx good first issue
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
yeti-platform/yeti#1380 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
modelcontextprotocol/python-sdk#3566 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
griptape-ai/griptape#2353 ·