core-spec: move semantic_model out of the Enumerations section in spec.yaml - #367
Closed
eisber wants to merge 1 commit into
Closed
core-spec: move semantic_model out of the Enumerations section in spec.yaml#367eisber wants to merge 1 commit into
eisber wants to merge 1 commit into
Conversation
…c.yaml
spec.yaml is a multi-document YAML file whose --- separators group the
specification into sections. semantic_model is a document-root key, but it
sits after the # Enumerations separator, so it parses as a member of that
section alongside the enum definitions:
0 -> ['version']
1 -> ['dialects', 'datatypes', 'vendor_name', 'semantic_model']
2 -> ['datasets']
Give the root keys their own section, matching how every other section in the
file is delimited:
0 -> ['version']
1 -> ['dialects', 'datatypes', 'vendor_name']
2 -> ['semantic_model']
3 -> ['datasets']
Comment-only restructuring: no key, value or enum member is added, removed or
changed, and nothing in the repository parses this file.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
17 tasks
There was a problem hiding this comment.
Warning
Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.
Copilot review overview
Review tier: Lite
Findings: 1
New issues introduced by this change (1)
| Severity | Finding |
|---|---|
core-spec/spec.yaml — The new “Document root” comment is potentially misleading in a multi-document YAML file:… |
What changed in this PR
This PR adjusts the sectioning in core-spec/spec.yaml so semantic_model is separated into its own YAML document, preventing it from being grouped under the “Enumerations” section when parsed as a multi-document YAML file.
Changes:
- Inserted a
---document separator beforesemantic_model - Added a short “Document root” comment block to clarify intent
| File | Description |
|---|---|
| core-spec/spec.yaml | Adds a new YAML document boundary + comments so semantic_model is no longer parsed within the Enumerations document |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+63
to
+65
| # Document root | ||
| # Keys allowed on the root object of an Ossie document, alongside the `version` | ||
| # declared at the top of this file. |
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.

Summary
core-spec/spec.yamlis a multi-document YAML file whose---separators group thespecification into sections.
semantic_modelis a document-root key, but it sits after the# Enumerationsseparator, so it parses as a member of that section alongside the enumdefinitions.
On
maintoday:This PR gives the document-root keys their own section, matching how every other section in
the file is delimited:
Scope
Five added lines, all of them a
---separator and comments. No key, value or enum memberis added, removed, renamed or reordered, so the parsed content of the file is unchanged
apart from which section
semantic_modelbelongs to.Nothing in the repository parses
core-spec/spec.yaml— it is documentation. (The twospec.yamlreferences underconverters/ontology/tests/are unrelatedtmp_pathfixtures.)So this carries no runtime risk; it makes the file say what it already meant.
Noticed while preparing #323, and split out of it so that PR stays about one thing.
Related Issues
None.
Checklist
Specification
core-spec/and follow the existing structureOntology
ontology/are consistent with spec changes —ontology/is untouchedConverters
converters/is updated to reflect spec or ontology changes — not applicable, nothing parses this fileValidation
validation/are updated if the spec changed — no change needed;validate.pyreadsossie-schema.json, notspec.yamltest_validate.py34 passed,validation/tests/10 passed)Documentation
docs/is updated to reflect any user-facing changes — no user-facing changeCONTRIBUTING.mdis updated if the contribution process changed — not applicableExamples
examples/are added or updated for any new spec constructs — no new constructsTests
pytest/ CI green)Compliance