microsoft / microsoft/api-guidelines
Evolvable Graph API design
Open
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
We are currently working on updating a set of guidelines specific for Graph APIs.
We also observed a need to list the best practices and patterns for evolvable API designs to accommodate changes more easily. We are thinking that it should probably include:
- Evolvable enums;
- Guidance on property versioning and other non-breaking changes.
Please add suggested topics to include in this issue.
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
Start by reviewing the repository's existing Graph API guidelines and the single comment on this issue; no file or test entry point is named. Done means an agreed scope and topic list for guidance on evolvable Graph API designs, including the proposed enum and property-versioning areas.
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
- 25/100