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 swagger docs to Open API spec 3.1 #1055

Closed
3 tasks done
acelaya opened this issue Mar 21, 2021 · 2 comments · Fixed by #1836
Closed
3 tasks done

Update swagger docs to Open API spec 3.1 #1055

acelaya opened this issue Mar 21, 2021 · 2 comments · Fixed by #1836
Milestone

Comments

@acelaya
Copy link
Member

acelaya commented Mar 21, 2021

https://lornajane.net/posts/2020/whats-new-in-openapi-3-1

https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0

  • Replace nullable with an array of types that includes 'null'.
  • Update to a swagger UI version that supports OpenAPI 3.1, in api-spec.shlink.io
  • Check if webhooks can replace the async API spec.
@acelaya
Copy link
Member Author

acelaya commented Mar 21, 2021

Blocked by swagger-api/swagger-ui#5891

@acelaya acelaya added the blocked Issues with some external dependency preventing to work on them label Mar 21, 2021
@acelaya acelaya added this to the 3.7.0 milestone May 29, 2023
@acelaya
Copy link
Member Author

acelaya commented Jun 12, 2023

Swagger-ui 5 released with full support for OAS 3.1 https://github.com/swagger-api/swagger-ui/releases/tag/v5.0.0

@acelaya acelaya removed the blocked Issues with some external dependency preventing to work on them label Jun 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant