Skip to content

feat: Clarify "reference" properties spec#928

Closed
B13rg wants to merge 10 commits into
mlcommons:mainfrom
B13rg:docs-1.1-ref
Closed

feat: Clarify "reference" properties spec#928
B13rg wants to merge 10 commits into
mlcommons:mainfrom
B13rg:docs-1.1-ref

Conversation

@B13rg
Copy link
Copy Markdown
Member

@B13rg B13rg commented Jul 31, 2025

#751

Clarifies usages of "reference" in the spec to specify what field references.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jul 31, 2025

MLCommons CLA bot All contributors have signed the MLCommons CLA ✍️ ✅

Comment thread docs/croissant-spec-draft.md Outdated
Comment thread docs/croissant-spec-draft.md Outdated
@B13rg
Copy link
Copy Markdown
Member Author

B13rg commented Jul 31, 2025

Here is a diagram descibing the object relations as I understand them:

image

@B13rg
Copy link
Copy Markdown
Member Author

B13rg commented Aug 1, 2025

Some uncertainties:

  • Reference Property Descriptions: The Field reference "@id" values are clunky, how can it be phrased better? It needs to cleanly communicate it's a reference, not embedded object.
  • "parentField" and "subField" properties: clarify what should happen with circular references, or if a referenced field is missing. Should this be considered an error, or are there fallback behaviors?

@benjelloun
Copy link
Copy Markdown
Contributor

Here is a diagram descibing the object relations as I understand them:

image

Nice picture!

@benjelloun
Copy link
Copy Markdown
Contributor

Some uncertainties:

  • Reference Property Descriptions: The Field reference "@id" values are clunky, how can it be phrased better? It needs to cleanly communicate it's a reference, not embedded object.

That comes from JSON-LD:

@id
Used to uniquely identify node objects that are being described in the document with IRIs or blank node identifiers. This keyword is described in § 3.3 Node Identifiers. A node reference is a node object containing only the @id property, which may represent a reference to a node object found elsewhere in the document.

  • "parentField" and "subField" properties: clarify what should happen with circular references, or if a referenced field is missing. Should this be considered an error, or are there fallback behaviors?

Circular references and missing referenced field should both be errors.

@B13rg B13rg changed the base branch from main to croissant-1.1-spec August 3, 2025 00:48
Comment thread docs/croissant-spec-draft.md Outdated
@B13rg B13rg changed the base branch from croissant-1.1-spec to main August 6, 2025 21:24
@B13rg B13rg marked this pull request as ready for review August 6, 2025 21:25
@B13rg B13rg requested a review from a team as a code owner August 6, 2025 21:25
@B13rg B13rg closed this May 6, 2026
@github-actions github-actions Bot locked and limited conversation to collaborators May 6, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants