ml-opensource / ml-opensource/API-manifesto
Topic: Headers
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#headers
- don't require accept header (versioning in URL)
- accept language
- traceability/debugging
- suggest to include identifying information in headers (eg. NMeta)
- don't include facebook etc.
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
Start with the linked how-to-write-apis.md Headers section and compare its guidance with this issue's requested points. Document the Headers topic so the acceptance, language, traceability/debugging, and exclusion concerns are addressed; done means the manifesto has a complete, focused headers section.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100