Upgrade OpenAPI spec to v3

[MattiSG]

Depends on #1160

New Features

• Upgrade OpenAPI specification of the API to v3 from Swagger v2.
• Continuously validate OpenAPI specification.

Breaking changes

• Drop support for OpenAPI specification v2 and prior.
• Users relying on the aforesaid can use this to migrate (example).

---

Last updated by @maukoquiroga at 2022-11-03T23:14:44Z

[bonjourmauko]

Awesome 😃 !

@openfisca/international-maintainers if this is considered a problem to have WIP PRs in this repo, please feel free to close 🙂

I think that thanks to Github drafts, WIP pull requests have been more widely and less wildly used.

I may also have some time in the coming weeks to put into this, if you need some help, haven't tried yet but I guess the validation test that you added is to help follow through programatically with the upgrade?

[MattiSG]

I guess the validation test that you added is to help follow through programatically with the upgrade?

It is a way to know what's left to do, yes.

[MattiSG]

Interesting point to have in mind: there is a user request for customising some parts of the generated OpenAPI, see openfisca/openfisca-doc#222.

[MattiSG]

Since I initially opened this PR, I cannot approve or request changes 😉

Here, it would be “request changes” because of the version number and the missing documentation for the null object where the conversation was resolved with no information. But otherwise everything seems good! 👍

I see you prepared openfisca/extension-template#47 and openfisca/country-template#128 for Core upgrade, but I do not see any PR in https://github.com/openfisca/legislation-explorer, while this will clearly break https://demo.openfisca.org when this upgrade gets deployed. This is not blocking for this Core upgrade however, since there should be no automated deployment without version constraint changes on Template.

[bonjourmauko]

I'd like to invoke #1159 and deploy a pre-release. @guillett would you like to test it with MesAides/1jeune1solution?

[coveralls]

Coverage increased (+0.02%) to 77.659% when pulling be3dee5 on openapi-v3 into 78c0d5f on master.

[MattiSG]

I'd like to invoke #1159 and deploy a pre-release.

I am not sure I understand the reason: this PR is barely 600 LoC, and most of it is about moving the contents of a YAML file around. Could you please clarify what makes you consider that “the changeset is too large for manual review”? 🙂