Add guidance on case convention for query parameter names

Open
#431 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Domain
api, documentation

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.

Description

Azure Guidelines

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
Dominant language
No language data
Stars
23.3k
Forks
2.7k
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from microsoft/api-guidelines

All issues in microsoft/api-guidelines

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.