Merge "Amend http status for CM Handles Data Enpoints in Documentation"

[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 af6b004..53f51f3 100644 (file)
--- a/docs/api/swagger/ncmp/openapi-inventory.yaml
+++ b/docs/api/swagger/ncmp/openapi-inventory.yaml
@@ -261,32 +261,46 @@ components:
       example:
         updatedCmHandles:
         - cmHandle: my-cm-handle
+          alternateId: my-alternate-id
           publicCmHandleProperties:
             key: my-property
           cmHandleProperties:
             key: my-property
           moduleSetTag: my-module-set-tag
+          trustLevel: COMPLETE
         - cmHandle: my-cm-handle
+          alternateId: my-alternate-id
           publicCmHandleProperties:
             key: my-property
           cmHandleProperties:
             key: my-property
           moduleSetTag: my-module-set-tag
+          trustLevel: COMPLETE
         createdCmHandles:
         - cmHandle: my-cm-handle
+          alternateId: my-alternate-id
           publicCmHandleProperties:
             key: my-property
           cmHandleProperties:
             key: my-property
           moduleSetTag: my-module-set-tag
+          trustLevel: COMPLETE
         - cmHandle: my-cm-handle
+          alternateId: my-alternate-id
           publicCmHandleProperties:
             key: my-property
           cmHandleProperties:
             key: my-property
           moduleSetTag: my-module-set-tag
+          trustLevel: COMPLETE
         dmiPlugin: my-dmi-plugin
         dmiModelPlugin: my-dmi-model-plugin
+        upgradedCmHandles:
+          cmHandles:
+          - my-cm-handle1
+          - my-cm-handle2
+          - my-cm-handle3
+          moduleSetTag: my-module-set-tag
         dmiDataPlugin: my-dmi-data-plugin
         removedCmHandles:
         - my-cm-handle1
@@ -321,15 +335,19 @@ components:
           items:
             type: string
           type: array
+        upgradedCmHandles:
+          $ref: '#/components/schemas/UpgradedCmHandles'
       type: object
     RestInputCmHandle:
       example:
         cmHandle: my-cm-handle
+        alternateId: my-alternate-id
         publicCmHandleProperties:
           key: my-property
         cmHandleProperties:
           key: my-property
         moduleSetTag: my-module-set-tag
+        trustLevel: COMPLETE
       properties:
         cmHandle:
           example: my-cm-handle
@@ -347,6 +365,15 @@ components:
         moduleSetTag:
           example: my-module-set-tag
           type: string
+        trustLevel:
+          enum:
+          - COMPLETE
+          - NONE
+          example: COMPLETE
+          type: string
+        alternateId:
+          example: my-alternate-id
+          type: string
       required:
       - cmHandle
       type: object
@@ -355,6 +382,29 @@ components:
         example: my-property
         type: string
       type: object
+    UpgradedCmHandles:
+      example:
+        cmHandles:
+        - my-cm-handle1
+        - my-cm-handle2
+        - my-cm-handle3
+        moduleSetTag: my-module-set-tag
+      properties:
+        cmHandles:
+          example:
+          - my-cm-handle1
+          - my-cm-handle2
+          - my-cm-handle3
+          items:
+            type: string
+          type: array
+        moduleSetTag:
+          default: ""
+          example: my-module-set-tag
+          type: string
+      required:
+      - cmHandles
+      type: object
     ErrorMessage:
       properties:
         status:
@@ -379,6 +429,10 @@ components:
           items:
             $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
           type: array
+        failedUpgradeCmHandles:
+          items:
+            $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
+          type: array
       type: object
     CmHandlerRegistrationErrorResponse:
       properties: