Merge output schema into single file and check into git#425
Merged
jack-berg merged 3 commits intoopen-telemetry:mainfrom Nov 20, 2025
Merged
Merge output schema into single file and check into git#425jack-berg merged 3 commits intoopen-telemetry:mainfrom
jack-berg merged 3 commits intoopen-telemetry:mainfrom
Conversation
jack-berg
commented
Nov 20, 2025
Member
Author
There was a problem hiding this comment.
Reverted these changes: #411 (comment)
With the compiled schema checked in, validator is no longer dependent on the root compile-schema target and all the changes to accommodate that are no longer required.
jack-berg
commented
Nov 20, 2025
Member
Author
There was a problem hiding this comment.
Only changes to this file are the removal of redundant $defs in the rendering of each type's concrete schema.
Member
I agree. Even when the full schema in json and the schema-docs.md are generated, it makes sense to have them checked in in git. People consuming this needs to see the full schema. |
marcalff
approved these changes
Nov 20, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Possibly solves #422. I alluded to this in a comment here.
There are a variety of advantages to publishing a single single JSON schema file and checking it into git:
schema-docs.md, this helps make the impact of changes obvious.$refs across files. With everything in one file, configuring tooling couldn't be easier.opentelemetry-configurationat the ref, runmake compile-schema, and have my implementation point to./schema_out. Much easier if every ref has the fully compiled schema checked into source code in a single file.It makes schema changes a bit noisier in terms of diff, but If we can tolerate keeping
schema-md.docchecked into git, we can tolerate this.