Improve materials/id schema description and examples#172
Merged
Conversation
The previous description ("An opaque external ID (likely generated by
compiler)") was too vague. The new description explains what resources
the ID identifies, notes the uniqueness constraint, and clarifies
that values can be numeric or string. Examples now use realistic
values matching patterns seen in other schemas.
Contributor
|
gnidan
commented
Mar 9, 2026
Member
Author
gnidan
left a comment
gnidan
left a comment
There was a problem hiding this comment.
Schema architect review: Looks good
The description accurately captures how materials/id is used:
- Referenced by
materials/source(source IDs),materials/compilation(compilation IDs), andmaterials/reference(generic ID refs) — the "compilation resource" framing covers these correctly. - "Unique within the scope where they appear" aligns with the source schema's uniqueness requirement.
- "Typically generated by the compiler" is accurate.
Examples are improved — 0 is realistic as a source index, and "__301f3b6d85831638" matches the actual compilation ID example in info.schema.yaml.
LGTM.
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
1 participant
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.
The previous description was too vague ("An opaque external ID (likely generated by compiler)"). Rewrote to explain what resources the ID identifies (sources, compilations), the uniqueness constraint, and the numeric/string type options. Replaced placeholder examples with realistic values matching patterns used in other schemas.