Repository navigation
Include training records in generated field references - #12
Merged
ANierbeck merged 1 commit intoOct 26, 2026
Merged
Conversation
Render each version's record schemas in the existing field reference, with a separate table per schema. Mark conditionally required fields and handle boolean then/else branches without failing generation. Document the generation command and the ignored output location. Apache-ai: Yes Generated-by: Codex (GPT-6) Reviewed-by: Calvin Kirs
ANierbeck
approved these changes
Oct 26, 2026
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.
Running
tools/render-docs.pyonly documentedProvenanceRecord, leavingTrainingProvenanceRecordfields out of the generated reference.Generate a separate table for each record schema, mark conditional requirements such as
trainingData, and document the command in SETUP. Booleanthen/elsebranches are handled safely.Validation: renderer smoke checks, 14 examples (JSON Schema + SHACL), 25 unit tests, and Maven verify passed.