microsoft / microsoft/api-guidelines
arbitrary JSON pattern/anti-pattern
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
Context
Graph.Json is used to model properties or payload of which the shape is unknown.
This makes it really difficult for clients to do anything useful with it.
The vast majority of use is from Excel, and this is historical because they are generating their REST API and CSDL from the object model in the product.
Decision
Graph.Json should not be used anymore, and we'll investigate to replace it by Edm.Untyped instead which is part of Odata. (need to check whether this impact the payload, or internal mechanics of AGS)
Edm.Untyped should ONLY be used in the scenario where the payload/property value comes from outside of the workload and its shape varies/is unknown. (a good example is the SharePoint Pages APIs, webparts can be defined by 3rd parties, and the shape of the webpart properties is unknown by API publishers)
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
No files or tests are named. Start by locating Graph.Json references in the repository, then investigate whether replacing it with Edm.Untyped affects the payload or internal mechanics of AGS. Done means the guidance clearly limits Edm.Untyped to external, shape-unknown payloads and resolves the replacement decision.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- json
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100