docs(index): align cross-spec versions and add alignment matrix (T-08)#82
Open
aorzelskiGH wants to merge 1 commit into
Open
docs(index): align cross-spec versions and add alignment matrix (T-08)#82aorzelskiGH wants to merge 1 commit into
aorzelskiGH wants to merge 1 commit into
Conversation
Update the "Metamodel Versions" section and the corresponding bibliography entries to reference the current versions of the companion specifications: - IDTA-01001 Part 1: Metamodel v3.1 -> v3.2 - IDTA-01002 Part 2: APIs v3.1 -> v3.2 In addition, add an explicit "Alignment with other AAS Specifications" table that states which Metamodel and API versions this Security version (v3.1) is designed to be used with, and clarifies the substitution rule for bugfix releases. Refs: Review Finding T-08 Made-with: Cursor
![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-01004 (v3.1) is designed to be used together with the following companion specifications: |
| |=== | ||
| | Specification | Aligned Version | Notes | ||
|
|
||
| | IDTA-01001 Part 1: Metamodel |
| | HTTP/REST API and AAS Query Language. IDTA-01002 and IDTA-01004 share the same BNF grammar and JSON Schema for formula expressions; the Query Language chapter in IDTA-01002 is normative for formula semantics. | ||
| |=== | ||
|
|
||
| Bugfix (patch) releases of aligned specifications MAY be substituted. Implementations conforming to this version of IDTA-01004 SHOULD declare which versions of IDTA-01001 and IDTA-01002 they implement. |
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
2 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
Align the Security specification's cross-spec version references with the current working versions of IDTA-01001 (Metamodel) and IDTA-01002 (API), and add an explicit "Alignment with other AAS Specifications" table.
Problem
IDTA-01004 still references IDTA-01001 v3.1 and IDTA-01002 v3.1 in both
index.adocandbibliography.adoc, while the current working versions are v3.2 in both repositories. In addition, the fact that IDTA-01002 and IDTA-01004 share the BNF grammar and JSON Schema for formula expressions is not visible at index level, which invites drift between the two specs on every release.Solution
index.adoc:v3.1->v3.2v3.1->v3.2=== Alignment with other AAS Specificationssection with a simple table (Specification / Aligned Version / Notes) and a substitution rule for bugfix (patch) releases.Affected files
documentation/IDTA-01004/modules/ROOT/pages/index.adocdocumentation/IDTA-01004/modules/ROOT/pages/bibliography.adocReview notes
aas-specs-metamodelandaas-specs-apiadd mirroring alignment tables.Refs: Review Finding T-08