Core logic to update,add or remove cmHandle properties

[cps.git] / cps-ncmp-rest / docs / openapi / components.yaml

diff --git a/cps-ncmp-rest/docs/openapi/components.yaml b/cps-ncmp-rest/docs/openapi/components.yaml
index e63f9c0..cda6ca3 100644 (file)
--- a/cps-ncmp-rest/docs/openapi/components.yaml
+++ b/cps-ncmp-rest/docs/openapi/components.yaml
@@ -1,5 +1,5 @@
 #  ============LICENSE_START=======================================================
-#  Copyright (C) 2021 Nordix Foundation
+#  Copyright (C) 2021-2022 Nordix Foundation
 #  Modifications Copyright (C) 2021 Pantheon.tech
 #  ================================================================================
 #  Licensed under the Apache License, Version 2.0 (the "License");
@@ -50,6 +50,16 @@ components:
             $ref: '#/components/schemas/RestCmHandle'
         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'
         removedCmHandles:
@@ -67,12 +77,14 @@ components:
           type: string
           example: my-cm-handle
         cmHandleProperties:
-            $ref: '#/components/schemas/RestCmHandleAdditionalProperties'
-    RestCmHandleAdditionalProperties:
+            $ref: '#/components/schemas/RestCmHandleProperties'
+        publicCmHandleProperties:
+            $ref: '#/components/schemas/RestCmHandleProperties'
+    RestCmHandleProperties:
         type: object
         additionalProperties:
             type: string
-            example: my-additional-property
+            example: my-property
 
     Conditions:
       type: object
@@ -380,3 +392,13 @@ components:
     NoContent:
       description: No Content
       content: {}
+    InternalServerError:
+      description: Internal Server Error
+      content:
+        application/json:
+          schema:
+            $ref: "#/components/schemas/ErrorMessage"
+          example:
+            status: 500
+            message: Internal Server Error
+            details: Internal Server Error occurred