Guidance on response payload with 201
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Domain
- api, documentation
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.
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.
- Dominant language
- No language data
- Stars
- 23.3k
- Forks
- 2.7k
- PR merge metrics
- No merged PRs in 30d
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.
More from microsoft/api-guidelines
-
Difficulty 1/5 1-3 hours Newbie friendliness 68/100
microsoft/api-guidelines#571 ·
-
Difficulty 5/5 Over a week Newbie friendliness 5/100
microsoft/api-guidelines#570 ·
-
Im Open
Difficulty 5/5 Over a week Newbie friendliness 10/100
microsoft/api-guidelines#562 ·
-
Difficulty 5/5 Over a week Newbie friendliness 1/100
microsoft/api-guidelines#560 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 58/100
microsoft/api-guidelines#559 ·
All issues in microsoft/api-guidelines
Similar issues
-
bug clawsweeper:linked-pr-open clawsweeper:needs-live-repro clawsweeper:no-new-fix-pr impact:message-loss issue-rating: 🐚 platinum hermit P2 regression
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
AXERA-TECH/ax-llm#77 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
games-on-whales/wolf#509 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100