Create Endpoint For Get Cm Handles By Name

[cps.git] / docs / api / swagger / ncmp / openapi-inventory.yaml

diff --git a/docs/api/swagger/ncmp/openapi-inventory.yaml b/docs/api/swagger/ncmp/openapi-inventory.yaml
index 34a087b..154a441 100644 (file)
--- a/docs/api/swagger/ncmp/openapi-inventory.yaml
+++ b/docs/api/swagger/ncmp/openapi-inventory.yaml
@@ -53,6 +53,16 @@ paths:
                 status: 403
                 message: Forbidden error message
                 details: Forbidden error details
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorMessage'
+              example:
+                status: 500
+                message: Internal Server Error
+                details: Internal Server Error occurred
 components:
   schemas:
     RestDmiPluginRegistration:
@@ -61,26 +71,39 @@ components:
         dmiPlugin:
           type: string
           example: my-dmi-plugin
+          default: ""
         dmiDataPlugin:
           type: string
           example: my-dmi-data-plugin
+          default: ""
         dmiModelPlugin:
           type: string
           example: my-dmi-model-plugin
+          default: ""
         createdCmHandles:
           type: array
           items:
-            $ref: '#/components/schemas/RestCmHandle'
+            $ref: '#/components/schemas/RestInputCmHandle'
         updatedCmHandles:
           type: array
+          example:
+            cmHandle: my-cm-handle
+            cmHandleProperties:
+              add-my-property: add-property
+              update-my-property: updated-property
+              delete-my-property: ~
+            publicCmHandleProperties:
+              add-my-property: add-property
+              update-my-property: updated-property
+              delete-my-property: ~
           items:
-            $ref: '#/components/schemas/RestCmHandle'
+            $ref: '#/components/schemas/RestInputCmHandle'
         removedCmHandles:
           type: array
           items:
             type: string
             example: "[\"my-cm-handle1\",\"my-cm-handle2\",\"my-cm-handle3\"]"
-    RestCmHandle:
+    RestInputCmHandle:
       required:
       - cmHandle
       type: object