Skip to content
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

Update to supported versions? #219

Closed
miketheman opened this issue Feb 27, 2024 · 7 comments
Closed

Update to supported versions? #219

miketheman opened this issue Feb 27, 2024 · 7 comments

Comments

@miketheman
Copy link
Collaborator

Hello! Thanks for making this plugin.
I was trying it out in an attempt to adopt OpenAPI specifications (and request validation, and the other features this provides) to an existing codebase, which is tricky, for sure!

I hit the issue reported in #203 and pinned to openapi-core 0.16.x to get things generally working.

I also read through the upgrade efforts set in #206 and wanted to understand if it's a 100% foregone conclusion that this library intends to update to OpenAPI 3.1.x, or would it be acceptable to attempt to update the code to the latest openapi-core 0.19.0 and preserve OpenAPI 3.0.0 semantics as a stepping stone?
I'm definitely 👍 on moving towards 3.1.0, but would that be too much change?

Another version support question: Pyramid 2.0 was released in early 2021 - should newer versions of this library still attempt to maintain backwards compatibility, or would it be desirable to update the code and tests to assume at least 2.x ?

@zupo
Copy link
Collaborator

zupo commented Feb 28, 2024

Hey @miketheman!

So far, everyone that worked on #206 expressed they would want to upgrade to OpenAPI 3.1, so the code was written as such. I am not against adding changes to it for backwards compatibility with Open API 3.0, but I don't have the bandwidth to do is, so someone else will have to contribute these changes.

About dropping Pyramid <2.0 support, I'm happy to review a PR that does it too.

@miketheman
Copy link
Collaborator Author

Excellent! I started #220 so far

@miketheman
Copy link
Collaborator Author

Now that the "heavy" work was done, I'll proceed with an update to support Pyramid 2.0 and above.

Re: OpenAPI 3.0 - I'm now thinking that since there's already breaking changes in the underlying libraries, this would be a good time to go for 3.1.0 - so that anyone upgrading to the latest library should also be encouraged to upgrade to the latest specification.

How does that sound?

@zupo
Copy link
Collaborator

zupo commented Mar 7, 2024

I'll cut a release with 3.0 support before we merge 3.1, just so that people that need to stay on 3.0 can get the latest fixes in openapi-core.

Other than that, please continue!

@zupo
Copy link
Collaborator

zupo commented Mar 7, 2024

@miketheman: heads-up: I'm already working on adding python 3.12 support in #224

@zupo
Copy link
Collaborator

zupo commented Mar 7, 2024

@miketheman: also, please post PRs directly to this repo, so it's easier for me to help out on them -- I just sent you an invite to get permissions!

@miketheman
Copy link
Collaborator Author

Listing some version updates done:

I'm thinking that it doesn't "cost" anything to keep the Pyramid 1.x support around, other than some deprecation warnings during the test suite. If Pyramid ever starts to error for those, then we can update the sample apps as a result.

I think that is enough to close this out for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants