Skip to content

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

Open
aorzelskiGH wants to merge 3 commits into
IDTA-01002-3-2_workingfrom
docs/cross-spec-versioning
Open

docs(index): add cross-spec alignment matrix (T-08)#588
aorzelskiGH wants to merge 3 commits into
IDTA-01002-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 API's index.adoc. The table names the companion IDTA-01001 (Metamodel, v3.2) and IDTA-01004 (Security, v3.1) versions this API version is designed to be used with, and clarifies the substitution rule for bugfix (patch) releases.

Problem

The existing "Metamodel Versions" section lists dependencies but does not distinguish between pure data-spec dependencies (IDTA-01003) and the tightly coupled Metamodel/Security specifications. In particular, the fact that IDTA-01002 and IDTA-01004 share the BNF grammar and JSON Schema for formula expressions is not visible at index level.

Solution

  • Add a short normative === Alignment with other AAS Specifications section next to the existing == Metamodel Versions.
  • Present the information as a simple table (Specification / Aligned Version / Notes).
  • Call out that IDTA-01002 and IDTA-01004 share the same grammar and schema for formula expressions and that bugfix releases of companion specs may be substituted.

Affected files

  • documentation/IDTA-01002-3/modules/ROOT/pages/index.adoc

Review notes

  • No grammar or API surface changes.
  • Companion PRs in aas-specs-metamodel and aas-specs-security add mirroring alignment tables and, for Security, update bibliography entries to match.

Refs: Review Finding T-08

Add an explicit "Alignment with other AAS Specifications" table
to the Metamodel Versions section, listing the companion
Metamodel (IDTA-01001 v3.2) and Security (IDTA-01004 v3.1)
versions this API version is designed to be used with, plus a
short note on what each companion spec contributes and the
substitution rule for bugfix releases.

Refs: Review Finding T-08
Made-with: Cursor
Comment on lines 15 to 26
@@ -25,6 +25,26 @@ This document uses the following parts of the “Specification of the Asset Admi

If there are bugfixes of the parts, these shall be used.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this part must be removed if new chapter is introduced. New chapter gives more information on the kind of dependency.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See my commits: I resolved my comment by proposing new table, please review

Comment thread documentation/IDTA-01002-3/modules/ROOT/pages/index.adoc
@BirgitBoss
Copy link
Copy Markdown
Collaborator

should be aligned with admin-shell-io/aas-specs-metamodel#690 (review) so that all Parts have the same chapter in index.adoc

@BirgitBoss BirgitBoss added this to the 3.2 milestone May 11, 2026
@BirgitBoss BirgitBoss added the documentation Improvements or additions to documentation label May 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants