Add openapi generation hook for UI API#42098
Merged
Merged
Conversation
pierrejeambrun
requested review from
ashb,
jedcunningham and
potiuk
as code owners
pierrejeambrun
force-pushed
the
ui-rest-api-and-new-ui
branch
from
bba7761 to
7dd7cc2
Compare
hussein-awala
approved these changes
Sep 9, 2024
Member
|
Cool. I found this one https://github.com/OpenAPITools/openapi-diff - maybe we can also (later when we get to be much closer) to employ that one to produce the diff ? |
Member
Author
|
Yes this would be really helpful to have this kind of tool added to the CI. I'll keep that in mind for later |
12 tasks
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Add a new pre-commit hook and utility script to persist to file the FastAPI openapi spec.
This will be useful for a follow up PR that will generate front-end types and query based on that spec.
Also it is useful for reviewer to see the openapi spec to easily identify breaking change or assess the impact of a PR on the interface. Later on automatic breaking change detection could be enforced in the CI I suppose.