huggingface / huggingface/dataset-viewer
Document all the X-Error-Code in OpenAPI
Open
documentation
P2
- Dominant language
- Python
- Stars
- 899
- Forks
- 130
- Avg merge
- 9h 26m
- Merged PRs (30d)
- 14
Description
and also in the docs, maybe, ie: a page with all the error types.
related to #1670 (I think we first want to generate the OpenAPI spec automatically, before documenting all the error codes)
Contributor guide
Research direction
Start by reviewing related issue #1670 and the current OpenAPI specification to understand whether automatic generation is available. Document every X-Error-Code in the generated OpenAPI output and add a documentation page covering all error types; done means both sources contain the complete set.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100