Skip to content

feat(schema): Add JSON schema for ORT project files#11547

Draft
MarcelBochtler wants to merge 1 commit intooss-review-toolkit:mainfrom
boschglobal:ort-project-schema
Draft

feat(schema): Add JSON schema for ORT project files#11547
MarcelBochtler wants to merge 1 commit intooss-review-toolkit:mainfrom
boschglobal:ort-project-schema

Conversation

@MarcelBochtler
Copy link
Member

In order to get auto-completions and validation in editors, provide a JSON schema for the ORT project file.

In order to get auto-completions and validation in editors, provide a
JSON schema for the ORT project file.

Signed-off-by: Marcel Bochtler <[email protected]>
@codecov
Copy link

codecov bot commented Mar 6, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 57.98%. Comparing base (6df9647) to head (781ce3e).
⚠️ Report is 14 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##               main   #11547   +/-   ##
=========================================
  Coverage     57.98%   57.98%           
  Complexity     1730     1730           
=========================================
  Files           349      349           
  Lines         12994    12994           
  Branches       1263     1263           
=========================================
  Hits           7534     7534           
  Misses         4995     4995           
  Partials        465      465           
Flag Coverage Δ
funTest-external-tools 14.18% <ø> (ø)
test-ubuntu-24.04 42.56% <ø> (ø)
test-windows-2025 42.53% <ø> (ø)

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@sschuberth
Copy link
Member

If we add the schema, I think we should also have a way to auto-generate it from the model classes (similar to like this script does that for the ORT result).

The difference here is that OrtProjectFileDto uses KxS instead of Jackson, so not exactly the same approach as in the above-mentioned script can be used. But there are several solutions for KxS as well, like https://github.com/Kotlin/kotlinx-schema, https://github.com/SMILEY4/schema-kenerator, or https://github.com/pwall567/json-kotlin-schema-codegen.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants