microsoft / microsoft/api-guidelines
Guidance on response payload with 201
Open
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
OData says request that successfully creates a resource returns 201 Created. In this case, the response body MUST contain the resource created.
Microsoft REST API Guidelines say "Services MAY also return the full metadata for the created item in the response."
Graph Guidelines don't say anything that I have found.
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 comparing the OData requirement with the Microsoft REST API Guidelines statement and checking the existing Graph guidance. Done means the guidelines clearly state whether a successful 201 response must include the created resource or may return only metadata.
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