Vague guidelines about point query support

Open
#511 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
52/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

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.

Description

Graph Guidelines Microsoft Graph

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.

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 Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.