Skip to content

docs(index): add cross-spec alignment matrix (T-08)#690

Open
aorzelskiGH wants to merge 1 commit intoIDTA-01001-3-2_Workingfrom
docs/cross-spec-versioning
Open

docs(index): add cross-spec alignment matrix (T-08)#690
aorzelskiGH wants to merge 1 commit intoIDTA-01001-3-2_Workingfrom
docs/cross-spec-versioning

Conversation

@aorzelskiGH
Copy link
Copy Markdown
Contributor

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

  • Add a short normative === Alignment with other AAS Specifications section directly below === Dependencies in index.adoc.
  • Present the information as a simple table (Specification / Aligned Version / Notes).
  • Keep the existing "If there is a bugfix of these parts, they shall be used" rule and extend it to apply to aligned specs as well.

Affected files

  • documentation/IDTA-01001/modules/ROOT/pages/index.adoc

Review notes

  • No changes to the metamodel itself.
  • Companion PRs in aas-specs-api and aas-specs-security add mirroring alignment tables.

Refs: Review Finding T-08

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
@BirgitBoss
Copy link
Copy Markdown
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants