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
Refactor add_path even more #238
Conversation
… Path This avoids needing to pass Path the OpenAPI version
I shouldn't have labelled this WIP. @sloria, I don't mean to rush you if you saw that but didn't have the time to look at it. If it was non-breaking I would merge it myself and wait for you to release, but since it is a bit more than that, I'm requesting your review. |
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.
Yeah, I saw this and just hadn't had the time to review it in earnest.
I'm good with this change. It was admittedly pretty ugly to allow operations to be passed both in Path
and as a kwarg to add_path
, so I'm all for cleaning that up. And +1 for reducing the API surface.
How about we release this in 0.40.0 then remove all deprecated API in 1.0.0?
Actually, let's make this 1.0.0b1 then remove all deprecated API in 1.0.0 final. |
Sorry for rushing you on this. I wasn't sure how much you rely on @ ping and/or review requests to reach your attention. (I don't.)
As you wish. We can remove all deprecated stuff right now since we're now in beta: it won't be pulled unless asked explicitly with I had a few other things in mind. I'm not sure they'll make it to v1.0 but if these are breaking changes, that'll be a 2.x. |
I want to give users an easy transition to 1.0, hence allowing for one beta release with the deprecated API. We can remove it in 1.0.0b2 if we end up needing another beta. Feel free to tag any issues with the 1.0 milestone. Otherwise, I'll just plan on releasing 1.0.0 as is, sans deprecated API, in a week or two. |
@sloria I'm writing a plugin for falcon which is using the new Thanks for this great library! |
@alysivji I've gone ahead and cut the 1.0.0b1 release. |
This is based on #237 and goes further.
Path
is removed.Clearer API (IMHO), and almost no test broken.
Probably not perfect, but I think it is a nice improvement.
@sloria, I'd understand your reluctance to introduce breaking changes. Would it make you feel more comfortable to publish a 1.0 version then break everything in 2.x? I don't mind either way. The breaking changes introduced here are not much worse than those introduced with the class interface. They will break every custom path helper, and possibly some operation helpers, marginally, but the fix is easy. It is not as if it made some feature impossible.