docs(query-language): reference cross-spec terminology matrix (T-09)#587
Open
aorzelskiGH wants to merge 1 commit intoIDTA-01002-3-2_workingfrom
Open
docs(query-language): reference cross-spec terminology matrix (T-09)#587aorzelskiGH wants to merge 1 commit intoIDTA-01002-3-2_workingfrom
aorzelskiGH wants to merge 1 commit intoIDTA-01002-3-2_workingfrom
Conversation
Add a NOTE next to the FieldIdentifier root-element table that explicitly maps each $-prefix to the corresponding Metamodel class (IDTA-01001) and API resource path. References the new normative terminology matrix in IDTA-01001 as the single source of truth and states that prefixes are lower-case only. Refs: Review Finding T-09 Made-with: Cursor
aorzelskiGH
requested review from
BirgitBoss,
alexgordtop,
danielporta,
g1zzm0,
mjacoby,
sebbader-sap,
waltersve and
zrgt
as code owners
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
|
|
||
| [NOTE] | ||
| ==== | ||
| The prefixes `$aas`, `$sm`, `$sme`, `$cd`, `$aasdesc` and `$smdesc` correspond directly to the AAS Metamodel classes `AssetAdministrationShell`, `Submodel`, `SubmodelElement`, `ConceptDescription`, `AssetAdministrationShellDescriptor` and `SubmodelDescriptor`, and to the API resources `/shells`, `/submodels`, `.../submodel-elements/{idShortPath}`, `/concept-descriptions`, `/shell-descriptors` and `/submodel-descriptors` respectively. The normative cross-specification mapping is given in the "Terminology Across IDTA-01001, IDTA-01002 and IDTA-01004" section of IDTA-01001 (AAS Metamodel). All prefixes are lower-case; variants such as `$aasDesc` or `$SmDesc` MUST be rejected by conforming parsers. |
|
|
||
| [NOTE] | ||
| ==== | ||
| The prefixes `$aas`, `$sm`, `$sme`, `$cd`, `$aasdesc` and `$smdesc` correspond directly to the AAS Metamodel classes `AssetAdministrationShell`, `Submodel`, `SubmodelElement`, `ConceptDescription`, `AssetAdministrationShellDescriptor` and `SubmodelDescriptor`, and to the API resources `/shells`, `/submodels`, `.../submodel-elements/{idShortPath}`, `/concept-descriptions`, `/shell-descriptors` and `/submodel-descriptors` respectively. The normative cross-specification mapping is given in the "Terminology Across IDTA-01001, IDTA-01002 and IDTA-01004" section of IDTA-01001 (AAS Metamodel). All prefixes are lower-case; variants such as `$aasDesc` or `$SmDesc` MUST be rejected by conforming parsers. |
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
2 participants
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.
Summary
Add a NOTE next to the FieldIdentifier root-element table in the Query Language chapter that explicitly maps each
$-prefix to the corresponding Metamodel class and API resource path, and points to the new normative cross-spec terminology matrix in IDTA-01001.Problem
Three specs use different surface forms for the same concept (Metamodel class name, API path segment, Query/Access-Rule prefix). The Query Language chapter defines the prefixes but does not make the mapping to the Metamodel and API explicit, which leads to small inconsistencies (e.g.
$aasDescvs.$aasdesc).Solution
$aasDescMUST be rejected.Affected files
documentation/IDTA-01002-3/modules/ROOT/pages/query-language.adocReview notes
admin-shell-io/aas-specs-metamodel(introduces the matrix) andadmin-shell-io/aas-specs-security(mirrors this NOTE in the Access Rule Model chapter).Refs: Review Finding T-09