Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Do we allow unresolved annotation instances? #311

Open
enikao opened this issue Oct 27, 2024 · 1 comment
Open

Do we allow unresolved annotation instances? #311

enikao opened this issue Oct 27, 2024 · 1 comment

Comments

@enikao
Copy link
Contributor

enikao commented Oct 27, 2024

We DO allow unresolved references (referenceTargetId below) and DO NOT allow unresolved containments (childId).
How about unresolved annotation instances (annotationInstanceId)?

{
  "id": "myNode",
  "classifier": ...,
  "properties": [],
  "containments": [
    {
      "containment": ...,
      "children": [
        "childId"
      ]
    }
  ],
  "references": [
    {
      "reference": ...,
      "targets": [
        "referenceTargetId"
      ]
    }
  ],
  "annotations": [
    "annotationInstanceId"
  ],
  "parent": null
}

Pro (allow unresolved annotation instances):

  • Annotations are meant as auxiliary, not really needed for the (core) model

Con:

  • Structurally, they are very close to containments, so they should follow the same rules
@joswarmer
Copy link
Contributor

joswarmer commented Nov 1, 2024

For references we have both a referred id, as well as a resolveInfo, so there are more options to rebind a reference. For annotations we only have an id, as with containments. This would argue for not allowing unresolved annotations.

However, a model is structurally correct, no matter annotations, so it would be easy to ignore unresolved annotations.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants