microsoft / microsoft/api-guidelines
Add guidance on case convention for query parameter names
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
Specifically:
- DO use camel case for all query parameter names. Do not upper-case acronyms; use camel case.
- exceptions: api-version (kebab case), orderby and maxpagesize (all lower)
- DO compare query parameter names using case-sensitivity
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 locating the repository's existing guidance for query parameter naming and read the surrounding conventions. Add the specified camel-case rule, its exceptions, and case-sensitive comparison guidance; done means the guidance is clear and consistent with the surrounding API guidelines.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100