openai / openai/openai-openapi
The description is missing error responses entirely
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 2.5k
- Forks
- 527
- Avg merge
- 1h 46m
- Merged PRs (30d)
- 2
Description
No 4XX, 5XX or specific error codes in these classes are documented throughout the description.
This is terrible because most clients need to know which errors they might get, what information it may contain to help recover, and what to do with it.
Plus there are already error types in the description that are easy to use.
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
The issue does not name a file, test, or entry point. Review the OpenAI API OpenAPI description for its classes and existing error types, then document applicable 4XX, 5XX, and specific error responses, including recovery information; done when these responses are covered throughout the description.
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
- 35/100