Skip to content

Conversation

@matmair
Copy link
Contributor

@matmair matmair commented Oct 19, 2025

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

@matmair matmair added this to the 1.1.0 milestone Oct 19, 2025
@matmair matmair self-assigned this Oct 19, 2025
@matmair matmair added the api Relates to the API label Oct 19, 2025
@netlify
Copy link

netlify bot commented Oct 19, 2025

Deploy Preview for inventree-web-pui-preview canceled.

Name Link
🔨 Latest commit efc9e20
🔍 Latest deploy log https://app.netlify.com/projects/inventree-web-pui-preview/deploys/690a95a98bdb0c0008a1ade8

@codecov
Copy link

codecov bot commented Oct 19, 2025

Codecov Report

❌ Patch coverage is 50.00000% with 13 lines in your changes missing coverage. Please review.
✅ Project coverage is 87.81%. Comparing base (d12102b) to head (efc9e20).

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              
Flag Coverage Δ
backend 89.53% <50.00%> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
Backend Apps 91.93% <ø> (ø)
Backend General 93.66% <ø> (ø)
Frontend 70.11% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@matmair
Copy link
Contributor Author

matmair commented Oct 21, 2025

@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
Copy link
Member

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

@SchrodingersGat
Copy link
Member

@matmair how is this intended to be used?

@matmair
Copy link
Contributor Author

matmair commented Oct 21, 2025

@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).

@SchrodingersGat SchrodingersGat modified the milestones: 1.1.0, 1.2.0 Oct 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api Relates to the API

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants