Revert OpenAPI version number to 3.0.0 #1210
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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>.
verbman
requested review from
bonjourmauko and
sandcha
and removed request for
verbman
sandcha
approved these changes
May 21, 2024
| @@ -62,4 +62,4 @@ def test_situation_definition(body): | |||
|
|
|||
|
|
|||
| def test_respects_spec(body): | |||
| assert not [error for error in openapi_v3_spec_validator.iter_errors(body)] | |||
| assert not [error for error in OpenAPIV30SpecValidator(body).iter_errors()] | |||
There was a problem hiding this comment.
👌
Seen in this documentation (pdf). Also in the source code of
openapi_spec_validator, OpenAPIV30SpecValidator and openapi_v3_spec_validator.
Comment on lines
+140
to
+141
| # propertyNames: # this keyword is part of JSON Schema but is not supported in OpenAPI v3.0.0 | ||
| # pattern: "^[12][0-9]{3}-[01][0-9]-[0-3][0-9]$" # all keys are ISO dates |
There was a problem hiding this comment.
I understand that we are dropping
propertyNamesbecause it wasn't and is not supported by OpenAPI and that we are keeping it here as documentation for humans.
There was a problem hiding this comment.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This was bumped in 8be2ec4 (#989). We do not actually abide by 3.1.0, as can be seen in the use of
exampleinstead ofexamples, support for which was dropped. v3.1.0 is indeed a breaking change, but the OpenAPI technical committee decided not to follow SemVer.Support for OpenAPI v3.1 is not offered by the current Legislation Explorer version and upgrading is too costly (see openfisca/legislation-explorer#236).
Technical changes
propertyNamesinValuesdefinition