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

Experimental support for OpenAPI specification version 3.0 #342

Open
bajiat opened this issue Sep 7, 2017 · 3 comments
Open

Experimental support for OpenAPI specification version 3.0 #342

bajiat opened this issue Sep 7, 2017 · 3 comments

Comments

@bajiat
Copy link
Contributor

bajiat commented Sep 7, 2017

Start by listing the differences required to forms based on spec version 3.0

@JeHugawa
Copy link
Collaborator

JeHugawa commented Oct 5, 2017

Differences with swagger specification version 2.0 and OpenAPI specification version 3.0.

  • URL structure.
    Swagger 2 lets you define a host and a baseURL, wherein OpenAPI 3 you define them both in URL. You can also have description for each url and multiple URLs for different paths in openAPI3. They're specified under "servers" in OpenAPI 3.

  • Components
    Swagger 2 had a concept of definitions, but OpenAPI 3 replaces them with components.

  • Request Format
    In swagger 2, they were subset of parameters, wherein OpenAPI 3 body and formdata are merged into one requestbody.

  • responses
    You don't have to define each response seperately anymore. Also callbacks let you define webhooks.

  • link object
    OpenAPI 3 adds linking.

  • chances to security
    Security has been renamed, OAuth2 flow names have been updated, you can have multiple flows, and there’s support for OpenID Connect. Basic type is now htpp and security has now "scheme" and "bearerformat".

Sources

https://swagger.io/docs/
https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md
https://blog.readme.io/an-example-filled-guide-to-swagger-3-2/
https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md

@JeHugawa
Copy link
Collaborator

This is just a rough description of differences, and the specifics will be done on a later date.

@ilarimikkonen
Copy link
Member

ui needs a button (next to the nav bar) where user can select version. use 3.0 by default and add explanation to about tab that we have 3.0 in use now

@ilarimikkonen ilarimikkonen added this to In Progress in apinf/openapi-designer Apr 30, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

No branches or pull requests

4 participants