fix(openapi): fixed and improved documentation of DevicePackageUninst…

…allRequest Signed-off-by: Alberto Codutti <alberto.codutti@eurotech.com>
eclipse · Dec 22, 2023 · 4c676e9 · 4c676e9
1 parent 90b73c1
commit 4c676e9
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 18 deletions.
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
@@ -26,23 +26,22 @@ paths:
         content:
           application/json:
             schema:
-              type: object
-              properties:
-                name:
-                  type: string
-                version:
-                  type: string
-                reboot:
-                  type: boolean
-                rebootDelay:
-                  type: integer
-              required:
-                - name
-                - version
-            example:
-              name: org.eclipse.kura.demo.heater
-              version: 1.0.500
-        required: true
+              $ref: './devicePackage.yaml#/components/schemas/devicePackageUninstallRequest'
+            examples:
+              basic:
+                summary: Basic
+                description: A request with only required properties
+                value:
+                  name: org.eclipse.kura.demo.heater
+                  version: 1.0.500
+              complete:
+                summary: Complete
+                description: A request with all properties
+                value:
+                  name: org.eclipse.kura.demo.heater
+                  version: 1.0.500
+                  reboot: false
+                  rebootDelay: 0
       responses:
         200:
           description: The corresponding Device Management Operation to track the progress of the Device Package Uninstall Request

diff --git a/rest-api/resources/src/main/resources/openapi/devicePackage/devicePackage.yaml b/rest-api/resources/src/main/resources/openapi/devicePackage/devicePackage.yaml
@@ -144,4 +144,27 @@ components:
           blockDelay: 0
           blockTimeout: 5000
           notifyBlockSize: 256
-          installVerifyURI: https://download.eclipse.org/kura/releases/4.1.0/org.eclipse.kura.demo.heater_1.0.500.verifier.sh
+          installVerifyURI: https://download.eclipse.org/kura/releases/4.1.0/org.eclipse.kura.demo.heater_1.0.500.verifier.sh
+    devicePackageUninstallRequest:
+      type: object
+      properties:
+        name:
+          type: string
+          description: The package name to uninstall
+        version:
+          type: string
+          description: The package verson to uninstall
+        reboot:
+          type: boolean
+          description: Whether to reboot the device after uninstall of the package
+        rebootDelay:
+          type: integer
+          description: The delay in milliseconds to delay the reboot after uninstallation
+      required:
+        - name
+        - version
+      example:
+        name: org.eclipse.kura.demo.heater
+        version: 1.0.500
+        reboot: false
+        rebootDelay: 0