Repository navigation
docs(rfc-0032): add Option C, external definition references resolved from OSDS - #111
Merged
Merged
Conversation
… from OSDS Adds a third option to RFC-0032 that requires no schema change to ODCS or ODPS: an element binds to an OSDS semantic definition through the shared Authoritative Definitions block with a new recommended type value (semanticDefinition, TBD), and inherits the attributes it does not state itself. Specifies the URL mechanism in full: a grammar, route selection by locator shape (network / file / id), version pinning with @3.1.4 or @v3.1.4, the floating and @latest cases, fragment notation reusing the ODCS reference notation, and merge semantics where inline always wins. Prior art and the naming discussion go to appendices A and B. The comparison table becomes A vs B vs C. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UabnikmEmLj55JPHFLTbGH Signed-off-by: Jean-Georges "jgp" Perrin <dev@jgp.net>
This was referenced Sep 1, 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.
Closes #110
Adds Option C to RFC-0032, alongside the existing Option A (
type: importsinrelationships) and Option B (top-levelimports+$import).Option C requires no schema change to ODCS or ODPS. An element binds to an OSDS semantic definition through the already-shared Authoritative Definitions block, using one new recommended
typevalue, and inherits the attributes it does not state itself. Inline values always win; an unresolved reference costs inherited attributes rather than invalidating the document.The URL mechanism
reference ::= locator [ "#" fragment ], with the route chosen by the shape of the locator, not by the link's type — the fragment and@versionare stripped first:://.yaml/.yml/.jsonVersion pinning:
@3.1.4and@v3.1.4are the same version (thevis stripped), exact match only in v1, no@means floating (latest active, warn),@latestsays it out loud, and@on a file locator is an assertion on the file'sversion. RFC-0047 forbids@in ids, so the delimiter is unambiguous. Fragments reuse the ODCS reference notation (#/definitions/…,#/schema/…/properties/…),idfirst andnameas fallback; no fragment means the whole document is the definition.Also
semanticDefinitionrecommended overexternalDefinition/definition/businessDefinition, flagged TBD for the TSC. KeepingbusinessDefinitioninformational avoids changing the behaviour of contracts already in the wild.Content gate
No CI in this repo. Verified locally: all 26 YAML examples parse, every internal anchor resolves, every relative and external link returns 200, all template sections present, dashboard row unchanged.
🤖 Generated with Claude Code
https://claude.ai/code/session_01UabnikmEmLj55JPHFLTbGH