Merge pull request #454 from alexgordtop/issues/445-upsert_of_objects

#445: Relaxed api to not throw 404 when element was not found on PUT

Author: BirgitBoss

AasxFileServerServiceSpecification/V3.1_SSP-001.yaml

@@ -150,7 +150,7 @@ paths:
     put:
       tags:
         - AASX File Server API
-      summary: Updates the AASX package at the server
+      summary: Creates or updates the AASX package at the server
       operationId: PutAASXByPackageId
       x-semanticIds:
         - https://admin-shell.io/aas/API/PutAASXByPackageId/3/0
@@ -175,6 +175,17 @@ paths:
                 contentType: application/asset-administration-shell-package
         required: true
       responses:
+        '201':
+          description: AASX package stored 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/Part2-API-Schemas/V3.1.0#/components/schemas/PackageDescription'
         '204':
           description: AASX package updated successfully
         '400':
@@ -183,8 +194,6 @@ paths:
           $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/unauthorized'
         '403':
           $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/forbidden'
-        '404':
-          $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/not-found'
         '500':
           $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/internal-server-error'
         default:

AssetAdministrationShellRegistryServiceSpecification/V3.1_SSP-001.yaml

@@ -119,7 +119,7 @@ paths:
     put:
       tags:
         - Asset Administration Shell Registry API
-      summary: Updates an existing Asset Administration Shell Descriptor
+      summary: Creates or updates an existing Asset Administration Shell Descriptor
       operationId: PutAssetAdministrationShellDescriptorById
       x-semanticIds:
         - https://admin-shell.io/aas/API/PutAssetAdministrationShellDescriptorById/3/0
@@ -140,14 +140,23 @@ paths:
               $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/schemas/AssetAdministrationShellDescriptor'
         required: true
       responses:
+        '201':
+          description: Asset Administration Shell Descriptor 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/Part2-API-Schemas/V3.1.0#/components/schemas/AssetAdministrationShellDescriptor'
         '204':
           description: Asset Administration Shell Descriptor updated successfully
         '400':
           $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/bad-request'
         '403':
           $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/forbidden'
-        '404':
-          $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/not-found'
         '500':
           $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/internal-server-error'    
         default:
@@ -278,7 +287,7 @@ paths:
     put:
       tags:
         - Asset Administration Shell Registry API
-      summary: Updates an existing Submodel Descriptor
+      summary: Creates or updates an existing Submodel Descriptor
       operationId: PutSubmodelDescriptorByIdThroughSuperpath
       x-semanticIds:
         - https://admin-shell.io/aas/API/PutSubmodelDescriptorById/3/0
@@ -290,14 +299,23 @@ paths:
               $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/schemas/SubmodelDescriptor'
         required: true
       responses:
+        '201':
+          description: Submodel Descriptor 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/Part2-API-Schemas/V3.1.0#/components/schemas/SubmodelDescriptor'
         '204':
           description: Submodel Descriptor updated successfully
         '400':
           $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/bad-request'
         '403':
           $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/forbidden'
-        '404':
-          $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/not-found'
         '500':
           $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/internal-server-error'    
         default:

AssetAdministrationShellRegistryServiceSpecification/V3.1_SSP-003.yaml

@@ -59,7 +59,7 @@ paths:
     put:
       tags:
         - Async Bulk Asset Administration Shell Registry API
-      summary: Updates multiple existing Asset Administration Shell Descriptors
+      summary: Creates or updates multiple existing Asset Administration Shell Descriptors
       operationId: PutBulkAssetAdministrationShellDescriptorsById
       x-semanticIds:
         - https://admin-shell.io/aas/API/PutBulkAssetAdministrationShellDescriptorsById/3/1

AssetAdministrationShellRepositoryServiceSpecification/V3.1_SSP-001.yaml

@@ -152,7 +152,7 @@ paths:
     put:
       tags:
         - Asset Administration Shell Repository API
-      summary: Updates an existing Asset Administration Shell
+      summary: Creates or updates an existing Asset Administration Shell
       operationId: PutAssetAdministrationShellById
       x-semanticIds:
         - https://admin-shell.io/aas/API/PutAssetAdministrationShellById/3/0
@@ -164,6 +164,17 @@ paths:
               $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.1.0#/components/schemas/AssetAdministrationShell'
         required: true
       responses:
+        '201':
+          description: Asset Administration Shell 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.1.0#/components/schemas/AssetAdministrationShell'
         '204':
           description: Asset Administration Shell updated successfully
         '400':
@@ -172,8 +183,6 @@ paths:
           $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/unauthorized'
         '403':
           $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/forbidden'
-        '404':
-          $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/not-found'
         '500':
           $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/internal-server-error'
         default:
@@ -514,7 +523,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/PutSubmodel/3/0
@@ -526,6 +535,17 @@ paths:
               $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.1.0#/components/schemas/Submodel'
         required: true
       responses:
+        '201':
+          description: Submodel reference 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.1.0#/components/schemas/Reference'
         '204':
           description: Submodel updated successfully
         '400':
@@ -1099,7 +1119,7 @@ paths:
     put:
       tags:
         - Asset Administration Shell Repository API
-      summary: Updates an existing submodel element at a specified path within submodel elements hierarchy
+      summary: Creates or updates an existing submodel element at a specified path within submodel elements hierarchy
       operationId: PutSubmodelElementByPath_AasRepository
       x-semanticIds:
         - https://admin-shell.io/aas/API/PutSubmodelElementByPath/3/0
@@ -1112,6 +1132,17 @@ paths:
               $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.1.0#/components/schemas/SubmodelElement'
         required: true
       responses:
+        '201':
+          description: Submodel element 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.1.0#/components/schemas/SubmodelElement'
         '204':
           description: Submodel element updated successfully
         '400':

AssetAdministrationShellServiceSpecification/V3.1_SSP-001.yaml

@@ -389,8 +389,6 @@ paths:
           $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/unauthorized'
         '403':
           $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/forbidden'
-        '404':
-          $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/not-found'
         '500':
           $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/internal-server-error'
         default:
@@ -957,7 +955,7 @@ paths:
     put:
       tags:
         - Asset Administration Shell API
-      summary: Updates an existing submodel element at a specified path within submodel elements hierarchy
+      summary: Creates or updates an existing submodel element at a specified path within submodel elements hierarchy
       operationId: PutSubmodelElementByPath
       x-semanticIds:
         - https://admin-shell.io/aas/API/PutSubmodelElementByPath/3/0
@@ -970,6 +968,17 @@ paths:
               $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.1.0#/components/schemas/SubmodelElement'
         required: true
       responses:
+        '201':
+          description: Submodel element 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.1.0#/components/schemas/SubmodelElement'
         '204':
           description: Submodel element updated successfully
         '400':

ConceptDescriptionRepositoryServiceSpecification/V3.1_SSP-001.yaml

@@ -144,7 +144,7 @@ paths:
     put:
       tags:
         - Concept Description Repository API
-      summary: Updates an existing Concept Description
+      summary: Creates or updates an existing Concept Description
       operationId: PutConceptDescriptionById
       x-semanticIds:
         - https://admin-shell.io/aas/API/PutConceptDescriptionById/3/0
@@ -165,14 +165,23 @@ paths:
               $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.1.0#/components/schemas/ConceptDescription'
         required: true
       responses:
+        '201':
+          description: Concept Description 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.1.0#/components/schemas/ConceptDescription'
         '204':
           description: Concept Description updated successfully
         '400':
           $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/bad-request'
         '403':
           $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/forbidden'
-        '404':
-          $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/not-found'
         '500':
           $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/internal-server-error'
         default: