microsoft / microsoft/api-guidelines

Updated Azure Guidelines: Filtering

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

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

This came up during the first draft of collections guidance.

We should think about prescriptive guidance for a default filtering language, how it relates to OData, and whether we want to include a small list of alternative filtering languages.

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.

Research direction

Start with the first draft of collections guidance and the discussion in pull request 243 linked from the issue. Review the existing API guidance structure and establish the agreed scope for a default filtering language, its relationship to OData, and any alternatives. Done means the guidance has a decided, documented position on all three points.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.