ml-opensource / ml-opensource/API-manifesto
Topic: Response body
Open
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 10
- Forks
- 6
- PR merge metrics
- No merged PRs in 30d
Description
See: https://github.com/nodes-vapor/readme/blob/master/Documentation/how-to-write-apis.md#response
- data wrapper
- meta data (eg. see #7 )
- sometimes no data with eg. status code 201 (see #10 )
- always json (no xml wrapped in json for example)
Contributor guide
No contributing guide indexed for this repository
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
Read Documentation/how-to-write-apis.md#response and the related issues #7 and #10 first. The response-body guidance should resolve the listed questions about data wrappers, metadata, responses without data, and JSON-only responses; completion means those conventions are documented clearly.
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
- 30/100