microsoft / microsoft/api-guidelines

Restrictions for openType

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

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

Add strong recommendation to avoid openType and consider Microsoft Graph extensions plan proposal.docx
Comment: we made the distinction between using an open type where customers could add custom properties (which was the original intent of open types) versus defining a type as open for cases where the service wanted to return unschematized properties (i.e., because they didn't want to commit to a specific set of properties).

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 issue text and review the linked Microsoft Graph extensions plan proposal.docx for the intended distinction between customer-defined open types and unschematized service responses. Update the API guidelines so the recommendation and distinction are explicit; done means the guidance reflects both cases without ambiguity.

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.