Introduce Schema Set upgrade method

[cps.git] / cps-ncmp-rest / docs / openapi / ncmp-inventory.yml

diff --git a/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml b/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml
index b0a50aa..16083bd 100755 (executable)
--- a/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml
+++ b/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml
@@ -1,5 +1,6 @@
 #  ============LICENSE_START=======================================================
 #  Copyright (C) 2021 Bell Canada
+#  Modifications Copyright (C) 2021-2022 Nordix Foundation
 #  ================================================================================
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -30,11 +31,123 @@ updateDmiRegistration:
           schema:
             $ref: 'components.yaml#/components/schemas/RestDmiPluginRegistration'
     responses:
-      201:
-        $ref: 'components.yaml#/components/responses/Created'
+      200:
+        $ref: 'components.yaml#/components/responses/NoContent'
       400:
         $ref: 'components.yaml#/components/responses/BadRequest'
       401:
         $ref: 'components.yaml#/components/responses/Unauthorized'
       403:
         $ref: 'components.yaml#/components/responses/Forbidden'
+      500:
+        description: Partial or Complete failure. The error details are provided in the response body and all supported error codes are documented in the example.
+        content:
+          application/json:
+            schema:
+              $ref: 'components.yaml#/components/schemas/DmiPluginRegistrationErrorResponse'
+            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"
+                }
+              ]
+              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"
+                }
+              ]
+              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"
+                }
+              ]
+
+getAllCmHandleIdsForRegisteredDmi:
+  get:
+    description: Get all cm handle IDs for a registered DMI plugin
+    tags:
+      - network-cm-proxy-inventory
+    summary: Get all cm handle IDs for a registered DMI plugin (DMI plugin, DMI data plugin, DMI model plugin)
+    operationId: getAllCmHandleIdsForRegisteredDmi
+    parameters:
+      - $ref: 'components.yaml#/components/parameters/dmiPluginIdentifierInQuery'
+    responses:
+      200:
+        description: OK
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                type: string
+      401:
+        $ref: 'components.yaml#/components/responses/Unauthorized'
+      403:
+        $ref: 'components.yaml#/components/responses/Forbidden'
+      500:
+        $ref: 'components.yaml#/components/responses/InternalServerError'
+
+searchCmHandleIds:
+  post:
+    description: Query and get CMHandleIds for additional properties, public properties and registered DMI plugin (DMI plugin, DMI data plugin, DMI model plugin).
+    tags:
+      - network-cm-proxy-inventory
+    summary: Query for CM Handle IDs
+    operationId: searchCmHandleIds
+    requestBody:
+      required: true
+      content:
+        application/json:
+          schema:
+            $ref: 'components.yaml#/components/schemas/CmHandleQueryParameters'
+    responses:
+      200:
+        description: OK
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                type: string
+      401:
+        $ref: 'components.yaml#/components/responses/Unauthorized'
+      403:
+        $ref: 'components.yaml#/components/responses/Forbidden'
+      500:
+        $ref: 'components.yaml#/components/responses/InternalServerError'
\ No newline at end of file