openai / openai/openai-openapi
Minor errors in spec
Open
Nobody has claimed this yet.
bug
enhancement
specification
- Dominant language
- No language data
- Stars
- 2.5k
- Forks
- 527
- Avg merge
- 1h 46m
- Merged PRs (30d)
- 2
Description
Logging these here in case they are useful.
These apply to the latest https://app.stainless.com/api/spec/documented/openai/openapi.documented.yml
- The chatCompletetions operation returns CreateChatCompletionResponse. When actually making a streaming request, the last SSE event will have the data "[DONE]". There is a corresponding DoneEvent in the schemas, but this is not indicated in spec as a possible response to chatCompletions.
- The downloadFile operation only lists a "application/json" response type, but in practice the actual response is always an "application/octet-stream"
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
Open the latest openapi.documented.yml from the linked spec and inspect chatCompletions, DoneEvent, and downloadFile. Compare the documented responses with the behavior described in the issue; done means the [DONE] SSE event and application/octet-stream response are represented accurately.
Written by the indexing model from the issue text.
Assessment
- Domain
- api
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100