microsoft / microsoft/api-guidelines

querying arbitrary number of keys in a dictionary insted

Open
#498 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
23.3k
Forks
2.7k
PR merge metrics
No merged PRs in 30d

Description

Hello team,

In the https://github.com/microsoft/api-guidelines/blob/vNext/graph/patterns/dictionary.md, it mentioned that the keys must be defined by the client. However, there were only examples for client to specify a single key (by appending it in the path). What if the client is interested in multiple keys? Do we have an example on what the request should be?

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 graph/patterns/dictionary.md and review its existing example for a client-defined key. Determine the documented request pattern for retrieving multiple keys, then add an example that answers the issue; done when the guideline clearly explains how clients request more than one key.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.