[CI] Add step that runs backward compatibility tests on PRs #1592
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
Hedingber
suggested changes
Dec 30, 2021
Tankilevitch
force-pushed
the
CI/add-OAI-compatibility-check
branch
from
4523f9e
to
bd4f4a2
Compare
Hedingber
suggested changes
Jan 1, 2022
There was a problem hiding this comment.
Please note the previous review comment - add description
Also it seems like you're still writing the output of the docker run command to a file, so I unresolved #1592 (comment)
… as a result of defining more implicit env naming.
…bility-dockerized
Hedingber
changed the title
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.
https://jira.iguazeng.com/browse/ML-1274
A few tools have been examined:
Since we are currently using 3.0.1 of OpenApi with FastApi, there are a few differences in the capabilities that JSON schema provides that are only available in the 3.1.0 version of OpenApi.
That is further explained at tiangolo/fastapi#240 (comment).
These distinctions have an impact on the usability of
oasdiffandnpm/openapi-diff.Currently,
openapi-diffis the only one capable of handling the aforementioned differences.Important Notes
oasdiff.openapi-diffis useful, it does not provide much useful information about the exact cause of the API breakage, necessitating additional investigation to determine the exact cause. I propose that we switch tooasdiffonce fastapi supports OpenApi 3.1.0.