Add more CI checks for OpenAPI definitions and JSON Schemas #1656
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
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
…t the 2020-12 spec Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
They are only in a few schemas and use the wrong version of the spec Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
richvdh
reviewed
Oct 10, 2023
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
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.
The commits can be reviewed one by one.
check-json-schemas.pyValidates all JSON schemas and their inline examples.
This is complementary to
check-event-schema-examples.pythat only validates the event examples and their JSON schemas. There is no way currently to detect a JSON schema, so it validates all files in a fixed set of folders. This could be fixed by adding the$schemafield to all JSON schemas.This check found several issues, such as: #1634, #1635, #1636, #1646.
check-openapi-sources.pyValidates OpenAPI definitions schemas and their inline examples.
This was already unused prior to the switch to OpenAPI 3.1. It was adapted to validate against the new version, and slightly improved to check all all request parameters instead of just the
requestBody.This check was the reason for #1647. It seems this issue was also the reason why it was removed from CI in the first place.
Fixes #8.
Preview: https://pr1656--matrix-spec-previews.netlify.app