docs(index): add cross-spec alignment matrix (T-08)#690
Open
aorzelskiGH wants to merge 3 commits into
Open
Conversation
Add an explicit "Alignment with other AAS Specifications" table that names the companion API (IDTA-01002 v3.2) and Security (IDTA-01004 v3.1) versions that are designed to be used with this Metamodel version, together with a short note on what each companion spec contributes. Also clarifies the substitution rule for bugfix (patch) releases and asks implementations to declare which companion versions they implement. Refs: Review Finding T-08 Made-with: Cursor
Collaborator
|
In the past we explicitly did not do an alignment with the release in case a part does not have an update. So for example, if only the API is extended and gets a new version but the metamodel remains the same with this newly proposed section an unnecessary dependency is introduced. |
BirgitBoss
reviewed
May 11, 2026
Comment on lines
24
to
33
| @@ -31,6 +31,26 @@ For the schemas derived from this document there is a dependency to the followin | |||
|
|
|||
| If there is a bugfix of these parts, they shall be used. | |||
|
|
|||
Collaborator
There was a problem hiding this comment.
This chapter has the same intention as the newly introduced chapter "Alignment with other AAS specifications". The new proposal add more information on what to expect in which version. On of both must be removed.
BirgitBoss
reviewed
May 11, 2026
Comment on lines
+35
to
+53
| === Alignment with other AAS Specifications | ||
|
|
||
| This version of IDTA-01001 (Metamodel, v3.2) is designed to be used together with the following companion specifications: | ||
|
|
||
| [cols="2,2,3",options="header"] | ||
| |=== | ||
| | Specification | Aligned Version | Notes | ||
|
|
||
| | IDTA-01002 Part 2: Application Programming Interfaces | ||
| | v3.2 | ||
| | HTTP/REST API, AAS Query Language. References the Metamodel classes and attributes defined here. | ||
|
|
||
| | IDTA-01004 Part 4: Security | ||
| | v3.1 | ||
| | Access Rule Model. Shares the Query Language grammar and schema with IDTA-01002 and references Metamodel classes through FieldIdentifiers. | ||
| |=== | ||
|
|
||
| Any bugfix release (patch version) of an aligned specification MAY be substituted for the version listed above. Implementations claiming conformance to this version of IDTA-01001 SHOULD state which versions of IDTA-01002 and IDTA-01004 they implement. | ||
|
|
Collaborator
There was a problem hiding this comment.
This chapter has the same intention as the existing chapter "Dependencies". The new proposal adds more information on what to expect in which version. On of both must be removed.
BirgitBoss
requested changes
May 11, 2026
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| [#cross-spec-alignment] | ||
| === Alignment with other AAS Specifications | ||
|
|
||
| This version of IDTA-01002 (v3.2) is designed to be used together with the following aligned companion specifications: |
| * defines classes and attributes for payload of API operations and query language | ||
| * defines mapping rules for serialization formats | ||
|
|
||
| | x | IDTA-01003-a Part 3a: Data Specification Template IEC61360 |
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
3 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 an explicit "Alignment with other AAS Specifications" table to the Metamodel's index page. The table names the companion IDTA-01002 (API, v3.2) and IDTA-01004 (Security, v3.1) versions this Metamodel version is designed to be used with, and clarifies the substitution rule for bugfix (patch) releases.
Problem
IDTA-01001 currently only lists dependencies to IDTA-01003-a/b (data specifications). It does not state which versions of the API (IDTA-01002) and Security (IDTA-01004) specifications this Metamodel version is aligned with. Reviewers and implementers have to infer version compatibility from the other two specs, which is error-prone.
Solution
=== Alignment with other AAS Specificationssection directly below=== Dependenciesinindex.adoc.Affected files
documentation/IDTA-01001/modules/ROOT/pages/index.adocReview notes
aas-specs-apiandaas-specs-securityadd mirroring alignment tables.Refs: Review Finding T-08