openai / openai/openai-openapi
Please consider bumping the api's minor version when openapi specs is updated
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 2.5k
- Forks
- 527
- Avg merge
- 1h 46m
- Merged PRs (30d)
- 2
Description
Hi, today when I debugged my program call using an unofficial Clojure client, I noticed that the client itself wasn't aware that the openapi specs it use is already outdated. I noticed that despite various functionality improvement in the openapi specs itself the version stays at 2.0.0 for a long time, which causes downstream apps to be oblivious of such being out of sync. Please consider updating the api's version itself when there are functional changes to the api.
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
Start by reviewing the current OpenAPI specification and its version history, focusing on how functional API changes are represented while the version remains 2.0.0. Define the versioning rule for functional specification changes and verify that the resulting version clearly signals updates to downstream clients.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100