Release notes added for 3.4.6

[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 bb4cca0..ff9f4ba 100644 (file)
--- a/docs/api/swagger/ncmp/openapi-inventory.yaml
+++ b/docs/api/swagger/ncmp/openapi-inventory.yaml
@@ -4,9 +4,9 @@ info:
   title: NCMP Inventory API
   version: "1.0"
 servers:
-  - url: /ncmpInventory
+- url: /ncmpInventory
 security:
-  - basicAuth: []
+- basicAuth: []
 paths:
   /v1/ch:
     post:
@@ -32,16 +32,6 @@ paths:
               schema:
                 $ref: '#/components/schemas/ErrorMessage'
           description: Bad Request
-        "401":
-          content:
-            application/json:
-              example:
-                status: 401
-                message: Unauthorized error message
-                details: Unauthorized error details
-              schema:
-                $ref: '#/components/schemas/ErrorMessage'
-          description: Unauthorized
         "403":
           content:
             application/json:
@@ -57,35 +47,35 @@ paths:
             application/json:
               example:
                 failedCreatedCmHandles:
-                  - cmHandle: my-cm-handle-01
-                    errorCode: "00"
-                    errorText: Unknown error. <error-details>
-                  - cmHandle: my-cm-handle-02
-                    errorCode: "01"
-                    errorText: cm-handle already exists
-                  - cmHandle: my-cm-handle-03
-                    errorCode: "03"
-                    errorText: cm-handle has an invalid character(s) in id
+                - cmHandle: my-cm-handle-01
+                  errorCode: "00"
+                  errorText: Unknown error. <error-details>
+                - cmHandle: my-cm-handle-02
+                  errorCode: "01"
+                  errorText: cm-handle already exists
+                - cmHandle: my-cm-handle-03
+                  errorCode: "03"
+                  errorText: cm-handle has an invalid character(s) in id
                 failedUpdatedCmHandles:
-                  - cmHandle: my-cm-handle-01
-                    errorCode: "00"
-                    errorText: Unknown error. <error-details>
-                  - cmHandle: my-cm-handle-02
-                    errorCode: "02"
-                    errorText: cm-handle does not exist
-                  - cmHandle: my-cm-handle-03
-                    errorCode: "03"
-                    errorText: cm-handle has an invalid character(s) in id
+                - cmHandle: my-cm-handle-01
+                  errorCode: "00"
+                  errorText: Unknown error. <error-details>
+                - cmHandle: my-cm-handle-02
+                  errorCode: "02"
+                  errorText: cm-handle does not exist
+                - cmHandle: my-cm-handle-03
+                  errorCode: "03"
+                  errorText: cm-handle has an invalid character(s) in id
                 failedRemovedCmHandles:
-                  - cmHandle: my-cm-handle-01
-                    errorCode: "00"
-                    errorText: Unknown error. <error-details>
-                  - cmHandle: my-cm-handle-02
-                    errorCode: "02"
-                    errorText: cm-handle does not exists
-                  - cmHandle: my-cm-handle-03
-                    errorCode: "03"
-                    errorText: cm-handle has an invalid character(s) in id
+                - cmHandle: my-cm-handle-01
+                  errorCode: "00"
+                  errorText: Unknown error. <error-details>
+                - cmHandle: my-cm-handle-02
+                  errorCode: "02"
+                  errorText: cm-handle does not exists
+                - cmHandle: my-cm-handle-03
+                  errorCode: "03"
+                  errorText: cm-handle has an invalid character(s) in id
               schema:
                 $ref: '#/components/schemas/DmiPluginRegistrationErrorResponse'
           description: Partial or Complete failure. The error details are provided
@@ -93,19 +83,19 @@ paths:
             example.
       summary: DMI notifies NCMP of new CM Handles
       tags:
-        - network-cm-proxy-inventory
+      - network-cm-proxy-inventory
   /v1/ch/cmHandles:
     get:
       description: Get all cm handle IDs for a registered DMI plugin
       operationId: getAllCmHandleIdsForRegisteredDmi
       parameters:
-        - description: dmi-plugin-identifier
-          in: query
-          name: dmi-plugin-identifier
-          required: true
-          schema:
-            example: my-dmi-plugin
-            type: string
+      - description: dmi-plugin-identifier
+        in: query
+        name: dmi-plugin-identifier
+        required: true
+        schema:
+          example: my-dmi-plugin
+          type: string
       responses:
         "200":
           content:
@@ -115,16 +105,6 @@ paths:
                   type: string
                 type: array
           description: OK
-        "401":
-          content:
-            application/json:
-              example:
-                status: 401
-                message: Unauthorized error message
-                details: Unauthorized error details
-              schema:
-                $ref: '#/components/schemas/ErrorMessage'
-          description: Unauthorized
         "403":
           content:
             application/json:
@@ -148,7 +128,7 @@ paths:
       summary: "Get all cm handle IDs for a registered DMI plugin (DMI plugin, DMI\
         \ data plugin, DMI model plugin)"
       tags:
-        - network-cm-proxy-inventory
+      - network-cm-proxy-inventory
   /v1/ch/searches:
     post:
       description: "Query and get CMHandleIds for additional properties, public properties\
@@ -169,16 +149,6 @@ paths:
                   type: string
                 type: array
           description: OK
-        "401":
-          content:
-            application/json:
-              example:
-                status: 401
-                message: Unauthorized error message
-                details: Unauthorized error details
-              schema:
-                $ref: '#/components/schemas/ErrorMessage'
-          description: Unauthorized
         "403":
           content:
             application/json:
@@ -201,7 +171,7 @@ paths:
           description: Internal Server Error
       summary: Query for CM Handle IDs
       tags:
-        - network-cm-proxy-inventory
+      - network-cm-proxy-inventory
 components:
   parameters:
     dmiPluginIdentifierInQuery:
@@ -226,16 +196,6 @@ components:
           schema:
             $ref: '#/components/schemas/ErrorMessage'
       description: Bad Request
-    Unauthorized:
-      content:
-        application/json:
-          example:
-            status: 401
-            message: Unauthorized error message
-            details: Unauthorized error details
-          schema:
-            $ref: '#/components/schemas/ErrorMessage'
-      description: Unauthorized
     Forbidden:
       content:
         application/json:
@@ -260,34 +220,52 @@ components:
     RestDmiPluginRegistration:
       example:
         updatedCmHandles:
-          - cmHandle: my-cm-handle
-            publicCmHandleProperties:
-              key: my-property
-            cmHandleProperties:
-              key: my-property
-          - cmHandle: my-cm-handle
-            publicCmHandleProperties:
-              key: my-property
-            cmHandleProperties:
-              key: my-property
+        - 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
-            publicCmHandleProperties:
-              key: my-property
-            cmHandleProperties:
-              key: my-property
-          - cmHandle: my-cm-handle
-            publicCmHandleProperties:
-              key: my-property
-            cmHandleProperties:
-              key: my-property
+        - 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
-        dmiDataPlugin: my-dmi-data-plugin
-        removedCmHandles:
+        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
+        - my-cm-handle2
+        - my-cm-handle3
       properties:
         dmiPlugin:
           default: ""
@@ -311,20 +289,25 @@ components:
           type: array
         removedCmHandles:
           example:
-            - my-cm-handle1
-            - my-cm-handle2
-            - my-cm-handle3
+          - my-cm-handle1
+          - my-cm-handle2
+          - my-cm-handle3
           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
@@ -339,14 +322,49 @@ components:
             example: my-property
             type: string
           type: object
+        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
+      - cmHandle
       type: object
     RestCmHandleProperties:
       additionalProperties:
         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:
@@ -371,6 +389,10 @@ components:
           items:
             $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
           type: array
+        failedUpgradeCmHandles:
+          items:
+            $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
+          type: array
       type: object
     CmHandlerRegistrationErrorResponse:
       properties:
@@ -387,23 +409,23 @@ components:
     CmHandleQueryParameters:
       example:
         cmHandleQueryParameters:
-          - conditionParameters:
-              - key: conditionParameters
-              - key: conditionParameters
-            conditionName: conditionName
-          - conditionParameters:
-              - key: conditionParameters
-              - key: conditionParameters
-            conditionName: conditionName
+        - conditionParameters:
+          - key: conditionParameters
+          - key: conditionParameters
+          conditionName: conditionName
+        - conditionParameters:
+          - key: conditionParameters
+          - key: conditionParameters
+          conditionName: conditionName
         conditions:
-          - name: name
-            conditionParameters:
-              - moduleName: my-module
-              - moduleName: my-module
-          - name: name
-            conditionParameters:
-              - moduleName: my-module
-              - moduleName: my-module
+        - name: name
+          conditionParameters:
+          - moduleName: my-module
+          - moduleName: my-module
+        - name: name
+          conditionParameters:
+          - moduleName: my-module
+          - moduleName: my-module
       properties:
         cmHandleQueryParameters:
           items:
@@ -420,8 +442,8 @@ components:
     ConditionProperties:
       example:
         conditionParameters:
-          - key: conditionParameters
-          - key: conditionParameters
+        - key: conditionParameters
+        - key: conditionParameters
         conditionName: conditionName
       properties:
         conditionName:
@@ -437,8 +459,8 @@ components:
       example:
         name: name
         conditionParameters:
-          - moduleName: my-module
-          - moduleName: my-module
+        - moduleName: my-module
+        - moduleName: my-module
       properties:
         name:
           type: string