diff --git a/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc b/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc index 76c76263..5b5b4148 100644 --- a/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc +++ b/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc @@ -10,7 +10,7 @@ Note: Changes in Metamodel (IDTA-01001) will not be listed here, although they h ==== -== Changes w.r.t. V3.1.2 to V3.2 +== Changes w.r.t. V3.1.3 to V3.2 Major Changes: @@ -22,6 +22,18 @@ Major Changes: Minor Changes: +* fix: Harmonized `SecurityQueryFilter` between API and Security specifications and added missing `FILTERLIST` construct to the BNF grammar and JSON Schema. +* fix: Aligned `idShort` pattern in BNF grammar and JSON Schema with Metamodel Constraint AASd-002 to correctly enforce minimum two characters and prevent trailing hyphens. +* fix: Changed JSON Schema validation from `oneOf` to `anyOf` where BNF grammar allows mixed inline and named groups in concatenation scenarios. +* fix: Aligned date/time extraction functions (`$dayOfWeek`, `$dayOfMonth`, `$month`, `$year`) in JSON Schema to accept all `dateTimeOperand` types per BNF grammar, and widened `timeLiteralPattern` to support fractional seconds. +* docs: Aligned prose tables in Query Language specification with BNF grammar and JSON Schema patterns for cast operators, field identifiers, and submodel element limitations. +* docs: Added normative FieldIdentifier applicability table per profile to clarify which Query and Access Rule prefixes apply to specific service specification families. +* docs: Added normative Query Evaluation Semantics clause to standardize query behavior across implementations, including error handling, field resolution, and list-valued matching. +* docs: Added normative Operation-to-RIGHT mapping table documenting the correspondence between HTTP/REST API operations and IDTA-01004 rightsEnum values. +* docs: Added cross-spec terminology matrix reference to align Metamodel classes, API path segments, and Query/Access-Rule prefixes across specifications. +* docs: Added cross-specification alignment matrix to document API compatibility with IDTA-01001 (Metamodel v3.2 instead of v3.1), DTA-01003-a, IDTA-01003-b, IDTA-01004 (Security v3.1), and IDTA-01005 (from v3.1 to v3.2). +* docs: Established IDTA-01002 as authoritative source for formula grammar and JSON Schema shared between API and Security specifications. +* docs: Added informative Conformance Test Corpus annex providing technology-neutral test cases for Query Language, HTTP/REST API, and error handling. * Added the `ServerNotImplemented` status code to the xref:specification/interfaces-payload.adoc#table-status-codes[Status Codes]. Note that the HTTP API mentioned this status code already, therefore, no change in OpenAPI or other related files. (https://github.com/admin-shell-io/aas-specs-api/issues/499[#499]) * Removed the `GetAllAssetAdministrationShellDescriptorsByAssetType` operation from the OpenAPI files for the Asset Administration Shell Registry Service Specification, as it was not intended to be included in the first place and is not implemented by any known implementation. (https://github.com/admin-shell-io/aas-specs-api/issues/515[#515]) * Changing the serialization format for AASX packages from "application/asset-administration-shell-package+xml" to "application/aas+zip" in the OpenAPI files for the Asset Administration Shell Repository Service Specification and the Submodel Repository Service Specification. This change is necessary to align with the actual content type used by implementations and to avoid confusion, as the previous content type was not registered and could be misinterpreted as an XML-based format. (https://github.com/admin-shell-io/aas-specs-api/issues/538[#538]) @@ -33,7 +45,7 @@ Minor Changes: * Editorial changes w.r.t. structuring of sections -=== Interface Changes w.r.t. V3.1.2 to V3.2 +=== Interface Changes w.r.t. V3.1.3 to V3.2 [%autowidth,width="100%",cols="10%,29%,10%,51%",options="header",] |=== @@ -42,9 +54,9 @@ h|BWC h|Interface h|Kind of Change h|Comment | |Asset Administration Shell Repository Interface |Extended a| new API operation for signing: GetAssetAdministrationShellByIdSigned (https://github.com/admin-shell-io/aas-specs-api/issues/518[#518]) | |Concept Description Repository Interface |Extended a| new API operation for signing: GetConceptDescriptionByIdSigned (https://github.com/admin-shell-io/aas-specs-api/issues/518[#518]) | |Submodel Repository Interface |Extended a| new API operation for signing: GetSubmodelByIdSigned (https://github.com/admin-shell-io/aas-specs-api/issues/518[#518]) -|===No +|=== -=== Operation Changes w.r.t. V3.1.2 to V3.2 +=== Operation Changes w.r.t. V3.1.3 to V3.2 [%autowidth,width="100%",cols="40%,15%,45%",options="header",] |=== @@ -61,6 +73,21 @@ h|Operation h|Kind of Change h|Comment | PutAssetAdministrationShellById|change a| Added the missing `id` input parameter and a note explaining the behavior in case the AAS identifier does not match the value of `id`. (https://github.com/admin-shell-io/aas-specs-api/issues/506[#506]) |=== +== Changes w.r.t. V3.1.2 to V3.1.3 + +Major Changes: + +* Fixed the response payload type of `PutSubmodelById` in the Asset Administration Shell Repository OpenAPI files: status code `201` now returns a `Submodel` instead of a `Reference`. (https://github.com/admin-shell-io/aas-specs-api/issues/601[#601]) + + +Minor Changes: + +* fix: Changed JSON Schema validation from `oneOf` to `anyOf` where BNF grammar allows mixed inline and named groups in concatenation scenarios. +* Fixed the response payload type of `PutSubmodelById` in the Asset Administration Shell Repository OpenAPI files: status code `201` now returns a `Submodel` instead of a `Reference`. (https://github.com/admin-shell-io/aas-specs-api/issues/601[#601]) +* Updated the response contract of `PostAllAssetLinksById` in Discovery OpenAPI files by removing status code `404` for `POST /lookup/shells/{aasIdentifier}` to align with create-or-replace semantics. (https://github.com/admin-shell-io/aas-specs-api/issues/595[#595])Expand annotationCheck warning on line R22 +* Updated the response contract of `PostAllAssetLinksById` in Discovery OpenAPI files by removing status code `409` for `POST /lookup/shells/{aasIdentifier}` to align with replace/update behavior on repeated payloads. (https://github.com/admin-shell-io/aas-specs-api/issues/596[#596])Expand annotationCheck warning on line R23 +* Updated the response contract of `GetAllSubmodelDescriptors` in Submodel Registry OpenAPI files by removing status code `404` for `GET /submodel-descriptors`, so an empty collection is consistently represented by `200` with an empty result. (https://github.com/admin-shell-io/aas-specs-api/issues/597[#597]) +* Submodel Service Specification – Read Profile had the wrong identifier `https://admin-shell.io/aas/API/3/1/AssetAdministrationShellServiceSpecification/SSP-002` instead of https://admin-shell.io/aas/API/3/1/SubmodelServiceSpecification/SSP-002` == Changes w.r.t. V3.1.1 to V3.1.2