Closes #20203: Add a pre-commit check for OpenAPI schema changes #20230
Conversation
This file contains hidden or 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
jeremystretch
requested review from
a team and
arthanson
and removed request for
a team
jeremystretch
commented
Sep 2, 2025
| - id: openapi-check | ||
| name: "Validate OpenAPI schema" | ||
| description: "Check for any unexpected changes to the OpenAPI schema" | ||
| files: api/.*\.py$ |
There was a problem hiding this comment.
Lazy regex to avoid triggering the rule unless it's likely that a modification to the REST API was made.
arthanson
requested changes
Sep 3, 2025
| Update the static OpenAPI schema definition at `contrib/openapi.json` with the management command below. If the schema file is up-to-date, only the NetBox version will be changed. | ||
|
|
||
| ```nohighlight | ||
| ./manage.py spectacular --format openapi-json > ../contrib/openapi.json |
There was a problem hiding this comment.
I think that should be ./manage.py spectacular --format openapi-json > contrib/openapi.json the ../ before contrib causes an error.
There was a problem hiding this comment.
The command assumes you're in the path where manage.py exists; contrib/ is one up from that.
arthanson
approved these changes
Sep 4, 2025
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.
Closes: #20203
contrib/openapi.jsonverify-openapi.shscript to generate the OpenAPI schema & compare it to the static recordpre-commitrule to run the OpenAPI verification checkcontrib/openapi.json