Fix and reenable prance-based openapi spec validation #5709
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
pull-request-size
bot
added
the
size/S
cognifloyd
added
API
bug fix
pantsbuild
size/S
cognifloyd
force-pushed
the
openapi-validation
branch
from
49e0afe to
d06f1e8
Compare
pull-request-size
bot
added
size/M
cognifloyd
force-pushed
the
openapi-validation
branch
2 times, most recently
from
e6289fa to
8aecfa2
Compare
arm4b
approved these changes
Aug 15, 2022
cognifloyd
force-pushed
the
openapi-validation
branch
from
8aecfa2 to
1742b4e
Compare
cognifloyd
force-pushed
the
openapi-validation
branch
from
1742b4e to
f319a14
Compare
nzlosh
reviewed
Aug 19, 2022
There are a lot of issues, so we're only partially validating the spec now. We still validate with prance, but skip checking x-api-model because there are so many legacy issues. I looked at adding the x-api-model ... but wow, we haven't been adding that for a long time. And there are open issues about it: #3575 #3788 So, we just make it possible, but optional, to run the schema validation.
cognifloyd
force-pushed
the
openapi-validation
branch
from
f319a14 to
710137f
Compare
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.
Background
I'm working towards introducing
pants. One of the first things we will use it for is linting / reformatting (it will run black, flake8, etc). Validation of our openapi schema should happen more regularly, so we'll hook that up so pants runs it when it runs lint toolsWhile hooking that up, I noticed parts of the validation commented out. So, I searched through the git history to figure out when and why.
Basically, it's just tech debt that no one had time to address. So, this is a step in that direction.
Overview
Fix and reenable prance-based openapi spec validation, but make our custom
x-api-modelvalidation optional as the spec is out-of-date.This also fixes issues identified by the now-enabled spec validation.
Related: #3575 #3788