Skip to content

Commit 37d9287

Browse files
authored
docs(query-language): reference cross-spec terminology matrix (#587)
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
1 parent 281028f commit 37d9287

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

documentation/IDTA-01002-3/modules/ROOT/pages/query-language.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,11 @@ Can start at any possible Submodel Element, is *not* restricted to Submodel Elem
116116
| `$smdesc` a| Starting point for fields available in Submodel Descriptors | `$smdesc#endpoints[0].protocolinformation.href`
117117
|===
118118

119+
[NOTE]
120+
====
121+
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.
122+
====
123+
119124
Attribute declarations point to literal values that provide the input for comparisons. It is not possible to point to objects or lists, only atomic values. Attribute declarations present a subset of the attributes defined by the AAS Metamodel and the extension classes of Clause xref:specification/interfaces-payload.adoc[Data Types for Payload].
120125

121126
.Attribute Elements for Field Identifiers. `<index>` is an optional nonNegativeInteger value. No `<index>` shall be interpreted as 'anywhere in the list'.

0 commit comments

Comments
 (0)