-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
WIP: Extend schema intro #10628
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
WIP: Extend schema intro #10628
Conversation
✅ Deploy Preview for inventree-web-pui-preview canceled.
|
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## master #10628 +/- ##
==========================================
- Coverage 87.82% 87.81% -0.02%
==========================================
Files 1279 1279
Lines 57572 57594 +22
Branches 2016 2016
==========================================
+ Hits 50564 50576 +12
- Misses 6509 6519 +10
Partials 499 499
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
|
@SchrodingersGat @wolflu05 this is more meant for maintainers then normal users as it enables us to write jq or spectral rules to lint the API. Any thoughts on additional things that might be helpful? By default nothing changes |
| debug_querycount: False | ||
| debug_shell: False | ||
|
|
||
| # Schema generation options |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As this is the default value, please comment it out in the config_template.yaml file - that way, if we ever change the default, we won't have users who are "locked in" to the old default
|
@matmair how is this intended to be used? |
With this addition, a dev can set the config key, export the schema and then use any json/yaml tool to filter through the whole API to find issues like #8539 to ensure that the API works in a more uniform way. Big picture, the goal is to create a set of rules that get run against the API spec to ensure all endpoints are working similar (ish). |
This adds a vendor extensions that helps with analyzing endpoints - would be very helpful for inventree/project-adr#4
This is more of a POC than something that could be merged