From 8f4984ef07d888dbd12b6c95b1c3e0a026f6cc50 Mon Sep 17 00:00:00 2001 From: Aaron Zielstorff Date: Tue, 5 May 2026 15:57:41 +0200 Subject: [PATCH 1/4] Fixes PUT /shells/{aasIdentifier}/submodels/{submodelIdentifier} return type on 201 status --- .../V3.2_SSP-001.yaml | 4 ++-- .../V3.2_SSP-005.yaml | 4 ++-- Entire-API-Collection/V3.2.yaml | 13 ++++++++++++- .../IDTA-01002-3/modules/ROOT/pages/changelog.adoc | 1 + 4 files changed, 17 insertions(+), 5 deletions(-) diff --git a/AssetAdministrationShellRepositoryServiceSpecification/V3.2_SSP-001.yaml b/AssetAdministrationShellRepositoryServiceSpecification/V3.2_SSP-001.yaml index e6418021..f96d442d 100644 --- a/AssetAdministrationShellRepositoryServiceSpecification/V3.2_SSP-001.yaml +++ b/AssetAdministrationShellRepositoryServiceSpecification/V3.2_SSP-001.yaml @@ -572,7 +572,7 @@ paths: required: true responses: '201': - description: Submodel reference created successfully + description: Submodel created successfully headers: Location: description: URL of the newly created resource @@ -581,7 +581,7 @@ paths: content: application/json: schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.2.0#/components/schemas/Reference' + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.2.0#/components/schemas/Submodel' '204': description: Submodel updated successfully '400': diff --git a/AssetAdministrationShellRepositoryServiceSpecification/V3.2_SSP-005.yaml b/AssetAdministrationShellRepositoryServiceSpecification/V3.2_SSP-005.yaml index 95bb65f1..7767cbfc 100644 --- a/AssetAdministrationShellRepositoryServiceSpecification/V3.2_SSP-005.yaml +++ b/AssetAdministrationShellRepositoryServiceSpecification/V3.2_SSP-005.yaml @@ -409,7 +409,7 @@ paths: required: true responses: '201': - description: Submodel reference created successfully + description: Submodel created successfully headers: Location: description: URL of the newly created resource @@ -418,7 +418,7 @@ paths: content: application/json: schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.2.0#/components/schemas/Reference' + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.2.0#/components/schemas/Submodel' '204': description: Submodel updated successfully '400': diff --git a/Entire-API-Collection/V3.2.yaml b/Entire-API-Collection/V3.2.yaml index 420f80bb..02a1dbe1 100644 --- a/Entire-API-Collection/V3.2.yaml +++ b/Entire-API-Collection/V3.2.yaml @@ -3390,7 +3390,7 @@ paths: put: tags: - Asset Administration Shell Repository API - summary: Updates the Submodel + summary: Creates or updates the Submodel operationId: PutSubmodelById_AasRepository x-semanticIds: - https://admin-shell.io/aas/API/PutSubmodelById/3/2 @@ -3402,6 +3402,17 @@ paths: $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.2.0#/components/schemas/Submodel' required: true responses: + '201': + description: Submodel created successfully + headers: + Location: + description: URL of the newly created resource + schema: + type: string + content: + application/json: + schema: + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.2.0#/components/schemas/Submodel' '204': description: Submodel updated successfully '400': diff --git a/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc b/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc index eee3ab56..8b7ab0c9 100644 --- a/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc +++ b/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc @@ -25,6 +25,7 @@ Minor Changes: * 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]) +* 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]) * Editorial fixes in Table 2 of the Query Language specification (https://github.com/admin-shell-io/aas-specs-api/issues/507[#507]) * 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]) * Editorial: Remove links to SwaggerHub from the HTTP API section, as the links are maintained in the service specifications and profiles sections. (https://github.com/admin-shell-io/aas-specs-api/issues/475[#475]) From 7034430a53619a16a13b1c5593fa5898e6aa4ff2 Mon Sep 17 00:00:00 2001 From: Aaron Zielstorff Date: Thu, 21 May 2026 08:23:19 +0200 Subject: [PATCH 2/4] Fix response payload type for PutSubmodelById: status code 201 now returns a Submodel instead of a Reference --- .../V3.2_SSP-001.yaml | 2 +- .../IDTA-01002-3/modules/ROOT/pages/changelog.adoc | 11 +++++++++++ 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/AssetAdministrationShellRepositoryServiceSpecification/V3.2_SSP-001.yaml b/AssetAdministrationShellRepositoryServiceSpecification/V3.2_SSP-001.yaml index f96d442d..1f7cc5d1 100644 --- a/AssetAdministrationShellRepositoryServiceSpecification/V3.2_SSP-001.yaml +++ b/AssetAdministrationShellRepositoryServiceSpecification/V3.2_SSP-001.yaml @@ -581,7 +581,7 @@ paths: content: application/json: schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.2.0#/components/schemas/Submodel' + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.1.2#/components/schemas/Submodel' '204': description: Submodel updated successfully '400': diff --git a/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc b/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc index 8b7ab0c9..198674ab 100644 --- a/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc +++ b/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc @@ -9,6 +9,17 @@ Note: Changes in Metamodel (IDTA-01001) will not be listed here, although they have an impact on the payload of many operations. ==== +== Changes w.r.t. V3.1.2 to V3.1.3 + +Major Changes: + +* ... + + +Minor 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]) + == Changes w.r.t. V3.1.2 to V3.2 From 6b05b2235c1ec35c6a495908fe86af29af66ae1d Mon Sep 17 00:00:00 2001 From: Aaron Zielstorff Date: Thu, 21 May 2026 17:54:29 +0200 Subject: [PATCH 3/4] Corrects changelog --- .../modules/ROOT/pages/changelog.adoc | 23 +++++++++---------- 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc b/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc index 198674ab..1153625e 100644 --- a/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc +++ b/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc @@ -9,17 +9,6 @@ Note: Changes in Metamodel (IDTA-01001) will not be listed here, although they have an impact on the payload of many operations. ==== -== Changes w.r.t. V3.1.2 to V3.1.3 - -Major Changes: - -* ... - - -Minor 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]) - == Changes w.r.t. V3.1.2 to V3.2 @@ -36,7 +25,6 @@ Minor Changes: * 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]) -* 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]) * Editorial fixes in Table 2 of the Query Language specification (https://github.com/admin-shell-io/aas-specs-api/issues/507[#507]) * 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]) * Editorial: Remove links to SwaggerHub from the HTTP API section, as the links are maintained in the service specifications and profiles sections. (https://github.com/admin-shell-io/aas-specs-api/issues/475[#475]) @@ -71,6 +59,17 @@ h|BWC h|Interface h|Kind of Change h|Comment | |Submodel Repository Interface |Extended a| new API operation for signing: GetSubmodelByIdSigned |=== +== Changes w.r.t. V3.1.2 to V3.1.3 + +Major Changes: + +* ... + + +Minor 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]) + == Changes w.r.t. V3.1.1 to V3.1.2 From 7b63dcb8317c2f689d4cc16b0e1c5497afa27cc8 Mon Sep 17 00:00:00 2001 From: Aaron Zielstorff Date: Thu, 21 May 2026 17:56:06 +0200 Subject: [PATCH 4/4] Fixes wrong version --- .../V3.2_SSP-001.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/AssetAdministrationShellRepositoryServiceSpecification/V3.2_SSP-001.yaml b/AssetAdministrationShellRepositoryServiceSpecification/V3.2_SSP-001.yaml index 1f7cc5d1..01b29842 100644 --- a/AssetAdministrationShellRepositoryServiceSpecification/V3.2_SSP-001.yaml +++ b/AssetAdministrationShellRepositoryServiceSpecification/V3.2_SSP-001.yaml @@ -581,7 +581,7 @@ paths: content: application/json: schema: - $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.1.2#/components/schemas/Submodel' + $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.2#/components/schemas/Submodel' '204': description: Submodel updated successfully '400':