feat(backend): 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 88.16% 88.14% -0.03%
==========================================
Files 1290 1290
Lines 58334 58357 +23
Branches 1966 1966
==========================================
+ Hits 51429 51437 +8
- Misses 6415 6430 +15
Partials 490 490
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 |
|
@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). |
CodSpeed Performance ReportMerging this PR will not alter performanceComparing Summary
Footnotes
|
|
@SchrodingersGat I added short docs on the added functionality is that enough or should I expand more? |
|
I think what you have added is sufficient! |
This adds a OpenAPI vendor extension that helps with analyzing endpoints - would be very helpful for inventree/project-adr#4
There is no immediate effect on deployments, as all the new code is disabled by the default setitngs.