microsoft / microsoft/api-guidelines
Vague guidelines about point query support
Open
Nobody has claimed this yet.
Graph Guidelines
Microsoft Graph
- Dominant language
- No language data
- Stars
- 23.3k
- Forks
- 2.7k
- PR merge metrics
- No merged PRs in 30d
Description
The guidance for point queries:
Whenever possible, services MUST support the "/" pattern. For example:
is vague. It is unclear "whenever" a service "must" support point queries. We should either remove the "must" or we should clarify the situations when a service isn't required to support point queries.
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
Read Guidelines.md at the Collection URL Patterns section linked in the issue, especially the point-query guidance. Decide whether to remove the MUST or define the exceptions, then update the wording so the requirement is unambiguous.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100