Skip to content

Add Annotations support to fmiReferences and related elements#30

Open
Copilot wants to merge 3 commits into
mainfrom
copilot/add-annotations-to-fmi-references
Open

Add Annotations support to fmiReferences and related elements#30
Copilot wants to merge 3 commits into
mainfrom
copilot/add-annotations-to-fmi-references

Conversation

Copy link
Copy Markdown

Copilot AI commented May 6, 2026

FMI and SSP both support vendor annotations on elements; FMI-LS-REF had no equivalent, creating a blocker when tool-specific metadata needed to be attached.

Imports fmi3Annotation.xsd from the FMI standard and adds the optional <Annotations> child element to all major elements in both schemas, plus documentation updates.

Schema: fmi3LayeredStandardReferenceManifest.xsd

  • Import fmi3Annotation.xsd
  • <fmiReferences> and <Related> now accept an optional <Annotations> child

Schema: fmi3LayeredStandardReferenceExperiments.xsd

  • Import fmi3Annotation.xsd
  • <Experiments>, <Experiment>, <Parameters>, <Stimuli>, and <References> now accept an optional <Annotations> child

Docs

  • Updated element detail tables in docs/index.adoc for all affected elements

Example usage:

<Related type="text/modelica" source="model.mo" role="model" description="Modelica source">
  <Annotations>
    <Annotation type="com.example.tool">
      <tool:metadata xmlns:tool="com.example.tool" reviewedBy="alice"/>
    </Annotation>
  </Annotations>
</Related>

Copilot AI assigned Copilot and pmai May 6, 2026
Copilot AI linked an issue May 6, 2026 that may be closed by this pull request
Copilot AI changed the title [WIP] Add annotation mechanism for fmiReferences and related elements Add Annotations support to fmiReferences and related elements May 6, 2026
Copilot AI requested a review from pmai May 6, 2026 19:25
Copilot finished work on behalf of pmai May 6, 2026 19:25
@pmai pmai marked this pull request as ready for review May 6, 2026 19:49
Copy link
Copy Markdown
Collaborator

@pmai pmai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add the usage example to the fmi_ls_ref_manifest_example.xml example

Copy link
Copy Markdown
Author

Copilot AI commented May 6, 2026

Add the usage example to the fmi_ls_ref_manifest_example.xml example

Done in commit 3fe24b9. The first <Related> entry in the example now demonstrates an <Annotations> child with a vendor-specific <Annotation type="com.example.tool"> element.

Copilot AI requested a review from pmai May 6, 2026 19:58
Copilot finished work on behalf of pmai May 6, 2026 19:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Provide Annotations

2 participants