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.

Sign up for GitHub

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

Jump to bottom

Update Matching Strategy SemanticId #473

Open
BirgitBoss opened this issue Oct 9, 2024 · 2 comments · Fixed by #482
Open

Update Matching Strategy SemanticId #473

BirgitBoss opened this issue Oct 9, 2024 · 2 comments · Fixed by #482
Labels
accepted accepted in principle to be fixed documentation Improvements or additions to documentation
Milestone
V3.1

Comments

@BirgitBoss
Copy link
Collaborator

Is your feature request related to a problem? Please describe.
There are different matching strategies described for semantic IDs. What is not clear from the example is whether the key.type should be considered or not in exact matching etc. (see chapter on reference matching: these two matching strategies need to be combined).
@BirgitBoss BirgitBoss added this to the V3.1 milestone Oct 9, 2024
@BirgitBoss BirgitBoss added requires workstream approval strategic decision proposal needs to be prepared in TF spec team documentation Improvements or additions to documentation labels Oct 9, 2024
@BirgitBoss
Copy link
Collaborator Author

BirgitBoss commented Oct 30, 2024 •
edited
Loading

2024-10-30 TF AAS Metamodel

Decision Proposal

  • use same terms for reference and semanticId matching: either Equivalence or Exact Matching. Proopsal: use exact match
  • reformulate exact matching for semanticId with

• With exact matching,the references of the two semantic IDs need to exact match as described in Clause "Matching Strategy for References".
Example: ExternalRef0173-1#02-BAA120#008 is not an exact match to ModelRef0173-1#02-BAA120#008 but only a value match

Additionally introduce value match for semanticId with Example
ExternalRef0173-1#02-BAA120#008 is a value match to ModelRef0173-1#02-BAA120#008

Correct

Examples for non-matching external references[[5](https://admin-shell-io.github.io/aas-specs-antora/IDTA-01001/v3.1/general.html#_footnotedef_5)]:

(GlobalReference)0173-1#01-ADS698#010, (GlobalReference)0173-1#01-ADS700#010

matches

(GlobalReference)0173-1#01-ADS698#010, (FragmentReference)0173-1#01-ADS700#010

to

Examples for non-matching external references[[5](https://admin-shell-io.github.io/aas-specs-antora/IDTA-01001/v3.1/general.html#_footnotedef_5)]:

(GlobalReference)0173-1#01-ADS698#010, (GlobalReference)0173-1#01-ADS700#010

is no exact match to

(GlobalReference)0173-1#01-ADS698#010, (FragmentReference)0173-1#01-ADS700#010

@BirgitBoss BirgitBoss added ready for approval TF proposes how to resolve the issue. Needs final approval my Workstream and removed requires workstream approval strategic decision proposal needs to be prepared in TF spec team labels Oct 30, 2024
@BirgitBoss BirgitBoss mentioned this issue Oct 30, 2024
Closed
BirgitBoss added a commit that referenced this issue Oct 31, 2024
@BirgitBoss
closes #473 Matching semanticId
be6f36f 
value-match and exact match
@BirgitBoss BirgitBoss mentioned this issue Oct 31, 2024
Merged
@BirgitBoss BirgitBoss added accepted accepted in principle to be fixed and removed ready for approval TF proposes how to resolve the issue. Needs final approval my Workstream labels Nov 14, 2024
@BirgitBoss
Copy link
Collaborator Author

2024-11-14 Workstream AAS
Decision Proposal approved: #473 (comment)

Non-Normative chapter, therefore remove Default recommendation
In API information about expected matching strategy should be added if relevant (see admin-shell-io/aas-specs-api#342).

@BirgitBoss BirgitBoss linked a pull request Dec 12, 2024 that will close this issue
fix or improve explanation for References and Semantics #482
Merged
BirgitBoss added a commit that referenced this issue Dec 13, 2024
@BirgitBoss @s-heppner
fix or improve explanation for References and Semantics (#482)
e098147 
* fix formatting

* #480 add example with referredSemanticId

* extension of #480: added invalid examples for all constraints for References

* closes #471 different syntax intelligent matching

* closes #473 Matching semanticId
value-match and exact match

* closes #479 supplementalSemanticId and isCaseOf

* see #479 now isCaseOf included in strategy

* add note that implementations may differ

Co-authored-by: s-heppner <[email protected]>

* grammar

* fix typo

Co-authored-by: s-heppner <[email protected]>

* exact match for semanticIc
+ formatting

---------

Co-authored-by: s-heppner <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
accepted accepted in principle to be fixed documentation Improvements or additions to documentation
Projects
None yet
Milestone
V3.1
Development

Successfully merging a pull request may close this issue.

fix or improve explanation for References and Semantics admin-shell-io/aas-specs
1 participant
@BirgitBoss