Release notes and openapi yml update

[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..6203c85 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:
@@ -57,35 +57,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 +93,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:
@@ -148,7 +148,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\
@@ -201,7 +201,7 @@ paths:
           description: Internal Server Error
       summary: Query for CM Handle IDs
       tags:
-        - network-cm-proxy-inventory
+      - network-cm-proxy-inventory
 components:
   parameters:
     dmiPluginIdentifierInQuery:
@@ -260,34 +260,34 @@ 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
+          publicCmHandleProperties:
+            key: my-property
+          cmHandleProperties:
+            key: my-property
+        - cmHandle: my-cm-handle
+          publicCmHandleProperties:
+            key: my-property
+          cmHandleProperties:
+            key: my-property
         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
+          publicCmHandleProperties:
+            key: my-property
+          cmHandleProperties:
+            key: my-property
+        - cmHandle: my-cm-handle
+          publicCmHandleProperties:
+            key: my-property
+          cmHandleProperties:
+            key: my-property
         dmiPlugin: my-dmi-plugin
         dmiModelPlugin: my-dmi-model-plugin
         dmiDataPlugin: my-dmi-data-plugin
         removedCmHandles:
-          - my-cm-handle1
-          - my-cm-handle2
-          - my-cm-handle3
+        - my-cm-handle1
+        - my-cm-handle2
+        - my-cm-handle3
       properties:
         dmiPlugin:
           default: ""
@@ -311,9 +311,9 @@ 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
@@ -340,7 +340,7 @@ components:
             type: string
           type: object
       required:
-        - cmHandle
+      - cmHandle
       type: object
     RestCmHandleProperties:
       additionalProperties:
@@ -387,23 +387,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 +420,8 @@ components:
     ConditionProperties:
       example:
         conditionParameters:
-          - key: conditionParameters
-          - key: conditionParameters
+        - key: conditionParameters
+        - key: conditionParameters
         conditionName: conditionName
       properties:
         conditionName:
@@ -437,8 +437,8 @@ components:
       example:
         name: name
         conditionParameters:
-          - moduleName: my-module
-          - moduleName: my-module
+        - moduleName: my-module
+        - moduleName: my-module
       properties:
         name:
           type: string