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

Support OpenAPI v3.1 #236

Open
MattiSG opened this issue May 14, 2024 · 2 comments
Open

Support OpenAPI v3.1 #236

MattiSG opened this issue May 14, 2024 · 2 comments

Comments

@MattiSG
Copy link
Member

MattiSG commented May 14, 2024 •
edited
Loading

Following openfisca/openfisca-ops#126, we have been able to upgrade Core in production, which means that openfisca/openfisca-core#989 was deployed and the web API now exposes a OpenAPI v3.1 format. The Legislation Explorer uses an outdated parser that displays the following error:

Unable to render this definition
The provided definition does not specify a valid version field.

image
@MattiSG MattiSG mentioned this issue May 17, 2024
Merged
@MattiSG
Copy link
Member Author

MattiSG commented May 17, 2024

I tried upgrading the Swagger UI package to v5 that supports OpenAPI v3.1. However, all the dependencies of the Legislation Explorer are so severely outdated that it is a never-ending headache. I cannot even build the website on my machine, no matter if there is a package upgrade or not. I don't see an easy way to bring back Swagger UI without an overhaul in the app, which I believe should not happen and we should instead rewrite it from scratch.

@MattiSG MattiSG changed the title Support OpenAPI v3 Support OpenAPI v3.1 May 18, 2024
@MattiSG
Copy link
Member Author

MattiSG commented May 18, 2024

The issue is really specifically with OpenAPI v3.1, not v3. Most other online tools have also not upgraded to the Swagger UI version that supports OpenAPI v3.1, and thus finding a freely accessible alternative is not easy.

The upgrade was made in openfisca/openfisca-core@8be2ec4. Maybe one way out of this situation is to only revert openfisca/openfisca-core@8be2ec4. We need to assess the functional consequences of this revert.

MattiSG added a commit to openfisca/openfisca-core that referenced this issue May 21, 2024
@MattiSG
Revert OpenAPI version number to 3.0.0
2a76f67 
This was bumped in 8be2ec4 but we do not seem to use any of the 3.1-specific features
Support for OpenAPI v3.1 is not offered by the current Legislation Explorer version and upgrading is too costly. See <openfisca/legislation-explorer#236>.
We do not actually abide by 3.1.0, as can be seen in the use of `example` instead of `examples. v3.1.0 is a breaking change, the technical committee decided not to follow semver, see <https://github.com/OAI/OpenAPI-Specification/releases/tag/3.1.0-rc0>.
MattiSG added a commit to openfisca/openfisca-core that referenced this issue May 21, 2024
@MattiSG
Revert OpenAPI version number to 3.0.0
2091cd6 
This was bumped in 8be2ec4 but we do not actually abide by 3.1.0, as can be seen in the use of `example` instead of `examples. v3.1.0 is a breaking change, the technical committee decided not to follow semver, see <https://github.com/OAI/OpenAPI-Specification/releases/tag/3.1.0-rc0>.
Support for OpenAPI v3.1 is not offered by the current Legislation Explorer version and upgrading is too costly. See <openfisca/legislation-explorer#236>.
@MattiSG MattiSG mentioned this issue May 21, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@MattiSG