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.

Sign up for GitHub

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

Jump to bottom

Update the Web API Swagger 2.0 specification to OpenAPI 3.0 #988

Closed
MattiSG opened this issue Mar 23, 2021 · 5 comments
Closed

Update the Web API Swagger 2.0 specification to OpenAPI 3.0 #988

MattiSG opened this issue Mar 23, 2021 · 5 comments
Assignees
@bonjourmauko
Labels
kind:feat A feature request, a feature deprecation

Comments

@MattiSG
Copy link
Member

MattiSG commented Mar 23, 2021

The Web API specification is currently described in the Swagger 2.0 format, which has been improved upon significantly in OpenAPI 3.0.

There is no known immediate use case for this update, but we should expect maintenance to be made easier, and the tooling ecosystem to move towards the more recent standard.

As a reuser, please use this issue to mention your interest in this update if your integration would be made easier with it 🙂
@MattiSG
Copy link
Member Author

MattiSG commented Mar 23, 2021

As an author of the spec, I can tell it would be very useful to be able to use oneOf as a consequence of #982, which is not supported in Swagger 2.0 as specified in OAI/OpenAPI-Specification#333.

@MattiSG
Copy link
Member Author

MattiSG commented Mar 23, 2021

This would also enable spec-compliant reuse of headers, which are currently defined under commons and is not valid.

MattiSG added a commit that referenced this issue Mar 23, 2021
@MattiSG
Document arrays and booleans as parameter values
4e66961 
Swagger 2.0 does not support oneOf, see #988
@MattiSG MattiSG mentioned this issue Mar 23, 2021
Merged
@bonjourmauko bonjourmauko added the kind:feat A feature request, a feature deprecation label Mar 30, 2021
@bonjourmauko
Copy link
Member

Thanks @MattiSG ! I think this a much waited change, and maybe also a fix for openfisca/legislation-explorer#227 ✨

@bonjourmauko bonjourmauko mentioned this issue Mar 30, 2021
Open
@bonjourmauko
Copy link
Member

Hello @MattiSG , has this been fixed by #989?

@bonjourmauko bonjourmauko self-assigned this Oct 4, 2024
@bonjourmauko bonjourmauko moved this from Inbox to Discussing / Discovering in OpenFisca International Oct 4, 2024
@MattiSG
Copy link
Member Author

MattiSG commented Oct 13, 2024

Yes!

@MattiSG MattiSG closed this as completed Oct 13, 2024
@github-project-automation github-project-automation bot moved this from Discussing / Discovering to Answer given / Dealt with in OpenFisca International Oct 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bonjourmauko bonjourmauko

Labels
kind:feat A feature request, a feature deprecation
Projects
OpenFisca International
Status: Answer given / Dealt with
Milestone
No milestone
Development

No branches or pull requests
2 participants
@MattiSG @bonjourmauko