-
Notifications
You must be signed in to change notification settings - Fork 1.2k
feat(openai_movement): Change URL structures to kill /openai/v1 (part 1) #3587
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
to give users a release to migrate, what do you think about using @cdoern 's technique of publishing these on /v1 and /v1/openai/v1?
Why? We are breaking backwards compatibility with 0.3.0 -- what is the additional rationale for having both? Is there a reason I am missing? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the API Conformance
test is passing because its no longer checking anything given that it looks for v1/openai/v1
. I can look into this in a follow up if you want, but instead of doing --match-path '^/v1/openai/v1'
I think we now need to check for all APIs we want to ensure don't change (all of the ones that used to be behind the openai/v1)
@cdoern updated the |
The
/v1/openai/v1
prefix is annoying and now unnecessary given our clearer focus on how to think about the API surface.Let's kill it for the 0.3.0 update.
To make client-side changes feasible, we will do this in two parts. This part adds a new route (sans
/openai/v1
) so the existing client continues to work since the server supports both.The next PR will be client-side (Stainless) changes which I will be making shortly.
The final PR will remove the
/openai/v1
routes.Note that all these changes will happen rapidly within this release cycle. The entire set will be backwards incompatible.