Skip to content

feat(backend): extend schema intro#10628

Merged
SchrodingersGat merged 18 commits intoinventree:masterfrom
matmair:extend-schema-intro
Jan 29, 2026
Merged

feat(backend): extend schema intro#10628
SchrodingersGat merged 18 commits intoinventree:masterfrom
matmair:extend-schema-intro

Conversation

@matmair
Copy link
Member

@matmair matmair commented Oct 19, 2025

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.

@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 083b9b6
🔍 Latest deploy log https://app.netlify.com/projects/inventree-web-pui-preview/deploys/697aa009d11b4700088f85f5

@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 88.14%. Comparing base (0d80d49) to head (083b9b6).
⚠️ Report is 1 commits behind head on master.

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

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

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

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

@SchrodingersGat
Copy link
Member

@matmair how is this intended to be used?

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

codspeed-hq bot commented Jan 9, 2026

CodSpeed Performance Report

Merging this PR will not alter performance

Comparing matmair:extend-schema-intro (083b9b6) with master (c7a0da1)1

Summary

✅ 44 untouched benchmarks
⏩ 29 skipped benchmarks2

Footnotes

  1. No successful run was found on master (0d80d49) during the generation of this report, so c7a0da1 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

  2. 29 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

@matmair matmair changed the title WIP: Extend schema intro feat(backend): extend schema intro Jan 28, 2026
@matmair matmair marked this pull request as ready for review January 28, 2026 23:47
@matmair
Copy link
Member Author

matmair commented Jan 29, 2026

@SchrodingersGat I added short docs on the added functionality is that enough or should I expand more?

@SchrodingersGat
Copy link
Member

I think what you have added is sufficient!

@SchrodingersGat SchrodingersGat merged commit 620e69b into inventree:master Jan 29, 2026
38 checks passed
@SchrodingersGat SchrodingersGat deleted the extend-schema-intro branch January 29, 2026 05:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api Relates to the API documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants