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

OpenAPI v3? #146

Open
mhamann opened this issue Nov 5, 2018 · 13 comments
Open

OpenAPI v3? #146

mhamann opened this issue Nov 5, 2018 · 13 comments

Comments

@mhamann
Copy link
Contributor

mhamann commented Nov 5, 2018

The readme indicates that OpenAPI v3 support is coming soon. Is that getting close? Or is it still a ways out?

@tlivings
Copy link
Contributor

I was waiting on @JamesMessinger to update https://github.com/APIDevTools/swagger-parser which he did!

I'll be revisiting this soon. Would also love help!

@JVanAartsen
Copy link

@tlivings do you have tasks broken out at all? I may be able to find some some time to contribute if given a little bit of direction.

@gdelpu
Copy link

gdelpu commented Jan 15, 2019

@tlivings Hi, I can also manage to find some time to contribute. OpenAPI V3 support is a must have for several of my projects.

@tlivings
Copy link
Contributor

@JVanAartsen , @gdelpu thanks for your offers.

I haven't created a task list but I imagine first up is just going to be figuring out what the breaking changes between 2 and 3 (https://swagger.io/blog/news/whats-new-in-openapi-3-0/), upgrading to the latest swagger-parser, and getting any issues in parameter validation sorted.

As far as I can tell from glancing at it is it is going to be practically a rewrite of how this module currently crawls the schema.

@gdelpu
Copy link

gdelpu commented Jan 21, 2019

@tlivings Hi Trevor,
I started digging into the code and the parser does not look like the major issue. Adapting the validator package could be the most time-consuming task, mainly if we want to keep backward compatibility with Swagger 2.0.
I'll spend a couple hours on the topic within the week and update you

@mhamann
Copy link
Contributor Author

mhamann commented Jan 21, 2019

I would think that the current validator logic could remain mostly the same and just rewrite / port it to a new implementation for OAI 3.0. Since the OAI doc should specify the version, it should be fairly straightforward to pick the right one.

Actually writing the validator would be the hard part, of course ;-)

@rmothilal
Copy link

rmothilal commented Mar 6, 2019

@tlivings Hi guys, hope everyone is well. I would like to know if there has been any progress on the OpenAPI v3 issue?

@hollain
Copy link

hollain commented Aug 1, 2019

@tlivings Hi everyone!
I just wanted to ask if there is any progress on the support for OpenApi v3?
That would be awesome!
Thanks a lot guys!

@K3UL
Copy link

K3UL commented Dec 31, 2019

Hi,

As many I would love to see OpenAPI v3 supported ; for now I am stuck with Express since v3 is a requirement of mine.

Is there any work being done on this at the moment ? Or is it just too big of a task for now ?

@tpburch
Copy link
Contributor

tpburch commented Apr 3, 2020

@tlivings I am planning to work on this, as I'd really like to utilize it. Do you have particular direction you would like to see this go?

If not, I have an idea how I would like to do this. It will be a fairly intrusive change, although I doubt that can be avoided regardless of approach.

@mhamann
Copy link
Contributor Author

mhamann commented Apr 5, 2020

FYI, fastify has this (or relatively similar) in the form of fastify-openapi-glue. It may be helpful for the work that needs to be done here.

@tlivings
Copy link
Contributor

tlivings commented Apr 5, 2020

I haven’t broken down the work required but newer versions of swagger-parser already support 3.0.

However, there are schema breaking changes they will need to be sorted out and most of these are in the change log for open api 3.0.

It’s been difficult to find the time to work on this in my current job because we do not use 3.0 and it’s not been a big priority as a result.

I will review any PR to address this support, with much appreciation.

@dcharbonnier
Copy link
Contributor

this issue can be closed

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

No branches or pull requests

9 participants