Merge pull request #4056 from Agnul97/fix-Api_Doc_409_dev_management

FIX: changed openApi docs to introduce new error code 409 for device management requests
eclipse-kapua · Jun 14, 2024 · e498d61 · e498d61
2 parents bdc97db + 70632d3
commit e498d61
Show file tree

Hide file tree

Showing 19 changed files with 71 additions and 2 deletions.
diff --git a/...resources/src/main/resources/openapi/deviceAsset/deviceAsset-scopeId-deviceId-_write.yaml b/...resources/src/main/resources/openapi/deviceAsset/deviceAsset-scopeId-deviceId-_write.yaml
@@ -80,5 +80,7 @@ paths:
           $ref: '../openapi.yaml#/components/responses/subjectUnauthorized'
         404:
           $ref: '../openapi.yaml#/components/responses/entityNotFound'
+        409:
+          $ref: '../openapi.yaml#/components/responses/conflictDeviceNotConnected'
         500:
           $ref: '../openapi.yaml#/components/responses/kapuaError'
diff --git a/rest-api/resources/src/main/resources/openapi/deviceAsset/deviceAsset-scopeId-deviceId.yaml b/rest-api/resources/src/main/resources/openapi/deviceAsset/deviceAsset-scopeId-deviceId.yaml
@@ -37,6 +37,8 @@ paths:
           $ref: '../openapi.yaml#/components/responses/subjectUnauthorized'
         404:
           $ref: '../openapi.yaml#/components/responses/entityNotFound'
+        409:
+          $ref: '../openapi.yaml#/components/responses/conflictDeviceNotConnected'
         500:
           $ref: '../openapi.yaml#/components/responses/kapuaError'
     post:

diff --git a/...sources/src/main/resources/openapi/deviceBundle/deviceBundle-scopeId-deviceId-_start.yaml b/...sources/src/main/resources/openapi/deviceBundle/deviceBundle-scopeId-deviceId-_start.yaml
@@ -34,5 +34,7 @@ paths:
           $ref: '../openapi.yaml#/components/responses/subjectUnauthorized'
         404:
           $ref: '../openapi.yaml#/components/responses/entityNotFound'
+        409:
+          $ref: '../openapi.yaml#/components/responses/conflictDeviceNotConnected'
         500:
           $ref: '../openapi.yaml#/components/responses/kapuaError'
diff --git a/...esources/src/main/resources/openapi/deviceBundle/deviceBundle-scopeId-deviceId-_stop.yaml b/...esources/src/main/resources/openapi/deviceBundle/deviceBundle-scopeId-deviceId-_stop.yaml
@@ -34,5 +34,7 @@ paths:
           $ref: '../openapi.yaml#/components/responses/subjectUnauthorized'
         404:
           $ref: '../openapi.yaml#/components/responses/entityNotFound'
+        409:
+          $ref: '../openapi.yaml#/components/responses/conflictDeviceNotConnected'
         500:
           $ref: '../openapi.yaml#/components/responses/kapuaError'
diff --git a/...-api/resources/src/main/resources/openapi/deviceBundle/deviceBundle-scopeId-deviceId.yaml b/...-api/resources/src/main/resources/openapi/deviceBundle/deviceBundle-scopeId-deviceId.yaml
@@ -39,5 +39,7 @@ paths:
           $ref: '../openapi.yaml#/components/responses/subjectUnauthorized'
         404:
           $ref: '../openapi.yaml#/components/responses/entityNotFound'
+        409:
+          $ref: '../openapi.yaml#/components/responses/conflictDeviceNotConnected'
         500:
           $ref: '../openapi.yaml#/components/responses/kapuaError'
diff --git a/...ces/src/main/resources/openapi/deviceCommand/deviceCommand-scopeId-deviceId-_execute.yaml b/...ces/src/main/resources/openapi/deviceCommand/deviceCommand-scopeId-deviceId-_execute.yaml
@@ -62,5 +62,7 @@ paths:
           $ref: '../openapi.yaml#/components/responses/subjectUnauthorized'
         404:
           $ref: '../openapi.yaml#/components/responses/entityNotFound'
+        409:
+          $ref: '../openapi.yaml#/components/responses/conflictDeviceNotConnected'
         500:
           $ref: '../openapi.yaml#/components/responses/kapuaError'
diff --git a/...sources/openapi/deviceConfiguration/deviceConfiguration-scopeId-deviceId-componentId.yaml b/...sources/openapi/deviceConfiguration/deviceConfiguration-scopeId-deviceId-componentId.yaml
@@ -73,5 +73,7 @@ paths:
           $ref: '../openapi.yaml#/components/responses/subjectUnauthorized'
         404:
           $ref: '../openapi.yaml#/components/responses/entityNotFound'
+        409:
+          $ref: '../openapi.yaml#/components/responses/conflictDeviceNotConnected'
         500:
           $ref: '../openapi.yaml#/components/responses/kapuaError'
diff --git a/.../src/main/resources/openapi/deviceConfiguration/deviceConfiguration-scopeId-deviceId.yaml b/.../src/main/resources/openapi/deviceConfiguration/deviceConfiguration-scopeId-deviceId.yaml
@@ -71,5 +71,7 @@ paths:
           $ref: '../openapi.yaml#/components/responses/subjectUnauthorized'
         404:
           $ref: '../openapi.yaml#/components/responses/entityNotFound'
+        409:
+          $ref: '../openapi.yaml#/components/responses/conflictDeviceNotConnected'
         500:
           $ref: '../openapi.yaml#/components/responses/kapuaError'
diff --git a/...esources/src/main/resources/openapi/deviceInventory/deviceInventory-scopeId-deviceId.yaml b/...esources/src/main/resources/openapi/deviceInventory/deviceInventory-scopeId-deviceId.yaml
@@ -257,5 +257,7 @@ paths:
           $ref: '../openapi.yaml#/components/responses/subjectUnauthorized'
         404:
           $ref: '../openapi.yaml#/components/responses/entityNotFound'
+        409:
+          $ref: '../openapi.yaml#/components/responses/conflictDeviceNotConnected'
         500:
           $ref: '../openapi.yaml#/components/responses/kapuaError'
diff --git a/.../resources/src/main/resources/openapi/deviceKeystore/deviceKeystore-scopeId-deviceId.yaml b/.../resources/src/main/resources/openapi/deviceKeystore/deviceKeystore-scopeId-deviceId.yaml
@@ -37,6 +37,8 @@ paths:
           $ref: '../openapi.yaml#/components/responses/subjectUnauthorized'
         404:
           $ref: '../openapi.yaml#/components/responses/entityNotFound'
+        409:
+          $ref: '../openapi.yaml#/components/responses/conflictDeviceNotConnected'
         500:
           $ref: '../openapi.yaml#/components/responses/kapuaError'
   /{scopeId}/devices/{deviceId}/keystore/items:
@@ -74,6 +76,8 @@ paths:
           $ref: '../openapi.yaml#/components/responses/subjectUnauthorized'
         404:
           $ref: '../openapi.yaml#/components/responses/entityNotFound'
+        409:
+          $ref: '../openapi.yaml#/components/responses/conflictDeviceNotConnected'
         500:
           $ref: '../openapi.yaml#/components/responses/kapuaError'
   /{scopeId}/devices/{deviceId}/keystore/item:
@@ -113,6 +117,8 @@ paths:
           $ref: '../openapi.yaml#/components/responses/subjectUnauthorized'
         404:
           $ref: '../openapi.yaml#/components/responses/entityNotFound'
+        409:
+          $ref: '../openapi.yaml#/components/responses/conflictDeviceNotConnected'
         500:
           $ref: '../openapi.yaml#/components/responses/kapuaError'
     delete:
@@ -147,6 +153,8 @@ paths:
           $ref: '../openapi.yaml#/components/responses/subjectUnauthorized'
         404:
           $ref: '../openapi.yaml#/components/responses/entityNotFound'
+        409:
+          $ref: '../openapi.yaml#/components/responses/conflictDeviceNotConnected'
         500:
           $ref: '../openapi.yaml#/components/responses/kapuaError'
   /{scopeId}/devices/{deviceId}/keystore/items/certificateInfo:
@@ -175,6 +183,8 @@ paths:
           $ref: '../openapi.yaml#/components/responses/subjectUnauthorized'
         404:
           $ref: '../openapi.yaml#/components/responses/entityNotFound'
+        409:
+          $ref: '../openapi.yaml#/components/responses/conflictDeviceNotConnected'
         500:
           $ref: '../openapi.yaml#/components/responses/kapuaError'
   /{scopeId}/devices/{deviceId}/keystore/items/certificateRaw:
@@ -203,6 +213,8 @@ paths:
           $ref: '../openapi.yaml#/components/responses/subjectUnauthorized'
         404:
           $ref: '../openapi.yaml#/components/responses/entityNotFound'
+        409:
+          $ref: '../openapi.yaml#/components/responses/conflictDeviceNotConnected'
         500:
           $ref: '../openapi.yaml#/components/responses/kapuaError'
   /{scopeId}/devices/{deviceId}/keystore/items/keypair:
@@ -231,6 +243,8 @@ paths:
           $ref: '../openapi.yaml#/components/responses/subjectUnauthorized'
         404:
           $ref: '../openapi.yaml#/components/responses/entityNotFound'
+        409:
+          $ref: '../openapi.yaml#/components/responses/conflictDeviceNotConnected'
         500:
           $ref: '../openapi.yaml#/components/responses/kapuaError'
   /{scopeId}/devices/{deviceId}/keystore/items/csr:
@@ -263,5 +277,7 @@ paths:
           $ref: '../openapi.yaml#/components/responses/subjectUnauthorized'
         404:
           $ref: '../openapi.yaml#/components/responses/entityNotFound'
+        409:
+          $ref: '../openapi.yaml#/components/responses/conflictDeviceNotConnected'
         500:
           $ref: '../openapi.yaml#/components/responses/kapuaError'
diff --git a/...esources/src/main/resources/openapi/deviceOperation/deviceOperation-scopeId-deviceId.yaml b/...esources/src/main/resources/openapi/deviceOperation/deviceOperation-scopeId-deviceId.yaml
@@ -41,7 +41,5 @@ paths:
           $ref: '../openapi.yaml#/components/responses/unauthenticated'
         403:
           $ref: '../openapi.yaml#/components/responses/subjectUnauthorized'
-        409:
-          $ref: '../openapi.yaml#/components/responses/entityUniqueness'
         500:
           $ref: '../openapi.yaml#/components/responses/kapuaError'
diff --git a/...es/src/main/resources/openapi/devicePackage/devicePackage-scopeId-deviceId-_download.yaml b/...es/src/main/resources/openapi/devicePackage/devicePackage-scopeId-deviceId-_download.yaml
@@ -77,5 +77,7 @@ paths:
           $ref: '../openapi.yaml#/components/responses/subjectUnauthorized'
         404:
           $ref: '../openapi.yaml#/components/responses/entityNotFound'
+        409:
+          $ref: '../openapi.yaml#/components/responses/conflictDeviceNotConnected'
         500:
           $ref: '../openapi.yaml#/components/responses/kapuaError'
diff --git a/...s/src/main/resources/openapi/devicePackage/devicePackage-scopeId-deviceId-_uninstall.yaml b/...s/src/main/resources/openapi/devicePackage/devicePackage-scopeId-deviceId-_uninstall.yaml
@@ -62,5 +62,7 @@ paths:
           $ref: '../openapi.yaml#/components/responses/subjectUnauthorized'
         404:
           $ref: '../openapi.yaml#/components/responses/entityNotFound'
+        409:
+          $ref: '../openapi.yaml#/components/responses/conflictDeviceNotConnected'
         500:
           $ref: '../openapi.yaml#/components/responses/kapuaError'
diff --git a/...pi/resources/src/main/resources/openapi/devicePackage/devicePackage-scopeId-deviceId.yaml b/...pi/resources/src/main/resources/openapi/devicePackage/devicePackage-scopeId-deviceId.yaml
@@ -37,5 +37,7 @@ paths:
           $ref: '../openapi.yaml#/components/responses/subjectUnauthorized'
         404:
           $ref: '../openapi.yaml#/components/responses/entityNotFound'
+        409:
+          $ref: '../openapi.yaml#/components/responses/conflictDeviceNotConnected'
         500:
           $ref: '../openapi.yaml#/components/responses/kapuaError'
diff --git a/...pi/resources/src/main/resources/openapi/deviceRequest/deviceRequest-scopeId-deviceId.yaml b/...pi/resources/src/main/resources/openapi/deviceRequest/deviceRequest-scopeId-deviceId.yaml
@@ -43,5 +43,7 @@ paths:
           $ref: '../openapi.yaml#/components/responses/subjectUnauthorized'
         404:
           $ref: '../openapi.yaml#/components/responses/entityNotFound'
+        409:
+          $ref: '../openapi.yaml#/components/responses/conflictDeviceNotConnected'
         500:
           $ref: '../openapi.yaml#/components/responses/kapuaError'
diff --git a/...esources/openapi/deviceSnapshot/deviceSnapshot-scopeId-deviceId-snapshotId-_rollback.yaml b/...esources/openapi/deviceSnapshot/deviceSnapshot-scopeId-deviceId-snapshotId-_rollback.yaml
@@ -34,5 +34,7 @@ paths:
           $ref: '../openapi.yaml#/components/responses/subjectUnauthorized'
         404:
           $ref: '../openapi.yaml#/components/responses/entityNotFound'
+        409:
+          $ref: '../openapi.yaml#/components/responses/conflictDeviceNotConnected'
         500:
           $ref: '../openapi.yaml#/components/responses/kapuaError'
diff --git a/...src/main/resources/openapi/deviceSnapshot/deviceSnapshot-scopeId-deviceId-snapshotId.yaml b/...src/main/resources/openapi/deviceSnapshot/deviceSnapshot-scopeId-deviceId-snapshotId.yaml
@@ -41,5 +41,7 @@ paths:
           $ref: '../openapi.yaml#/components/responses/subjectUnauthorized'
         404:
           $ref: '../openapi.yaml#/components/responses/entityNotFound'
+        409:
+          $ref: '../openapi.yaml#/components/responses/conflictDeviceNotConnected'
         500:
           $ref: '../openapi.yaml#/components/responses/kapuaError'
diff --git a/.../resources/src/main/resources/openapi/deviceSnapshot/deviceSnapshot-scopeId-deviceId.yaml b/.../resources/src/main/resources/openapi/deviceSnapshot/deviceSnapshot-scopeId-deviceId.yaml
@@ -40,5 +40,7 @@ paths:
           $ref: '../openapi.yaml#/components/responses/subjectUnauthorized'
         404:
           $ref: '../openapi.yaml#/components/responses/entityNotFound'
+        409:
+          $ref: '../openapi.yaml#/components/responses/conflictDeviceNotConnected'
         500:
           $ref: '../openapi.yaml#/components/responses/kapuaError'
diff --git a/rest-api/resources/src/main/resources/openapi/openapi.yaml b/rest-api/resources/src/main/resources/openapi/openapi.yaml
@@ -804,6 +804,20 @@ components:
         httpErrorCode: 403
         message: "This operation can be performed only on the current logged User."
         kapuaErrorCode: "SELF_MANAGED_ONLY"
+    DeviceNotConnectedExceptionInfo:
+      description: The device is currently disconnected
+      allOf:
+        - $ref: '#/components/schemas/exceptionInfo'
+        - properties:
+            deviceId:
+              description: The id of the disconnected device
+              $ref: '#/components/schemas/kapuaId'
+      example:
+        type: "deviceNotConnectedExceptionInfo"
+        httpErrorCode: 409
+        message: "The device 3243535747637285611 is not CONNECTED. Current device connection status is: null"
+        kapuaErrorCode: "DEVICE_NOT_CONNECTED"
+        deviceId: "LQNak9Yzkus"
     ### Other Base Entities ###
     kapuaListResult:
       description: A container for all the Entities List
@@ -1294,6 +1308,15 @@ components:
         application/xml:
           schema:
             $ref: '#/components/schemas/entityUniquenessExceptionInfo'
+    conflictDeviceNotConnected: #409 response - device not connected
+      description: A conflict in the request - the device is disconnected and the request cannot be accomplished
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/DeviceNotConnectedExceptionInfo'
+        application/xml:
+          schema:
+            $ref: '#/components/schemas/DeviceNotConnectedExceptionInfo'
   # Security schemes
   securitySchemes:
     kapuaToken: