docs(index): add cross-spec alignment matrix (T-08)#690
Open
aorzelskiGH wants to merge 1 commit intoIDTA-01001-3-2_Workingfrom
Open
docs(index): add cross-spec alignment matrix (T-08)#690aorzelskiGH wants to merge 1 commit intoIDTA-01001-3-2_Workingfrom
aorzelskiGH wants to merge 1 commit intoIDTA-01001-3-2_Workingfrom
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. |
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
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