Document ncmp-inventory error code in openapi

Issue-ID: CPS-896
Signed-off-by: Renu Kumari <renu.kumari@bell.ca>
Change-Id: Ic39da86c18ac921a6a3d213064f0b7c77d08e06f

diff --git a/cps-ncmp-rest/docs/openapi/components.yaml b/cps-ncmp-rest/docs/openapi/components.yaml
index a7955c1..7ed2efe 100644 (file)
--- a/cps-ncmp-rest/docs/openapi/components.yaml
+++ b/cps-ncmp-rest/docs/openapi/components.yaml
@@ -94,35 +94,14 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
-          example: [
-            {
-              "cmHandle": "my-cm-handle-01",
-              "errorCode": "01",
-              "errorText": "cm-handle already exists"
-            }
-          ]
         failedUpdatedCmHandles:
           type: array
           items:
             $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
-          example: [
-            {
-              "cmHandle": "my-cm-handle-02",
-              "errorCode": "02",
-              "errorText": "cm-handle does not exist"
-            }
-          ]
         failedRemovedCmHandles:
           type: array
           items:
             $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
-          example: [
-            {
-              "cmHandle": "my-cm-handle-02",
-              "errorCode": "02",
-              "errorText": "cm-handle does not exist"
-            }
-          ]
     CmHandlerRegistrationErrorResponse:
       type: object
       properties:
@@ -131,10 +110,10 @@ components:
           example: my-cm-handle
         errorCode:
           type: string
-          example: '01'
+          example: '00'
         errorText:
           type: string
-          example: 'cm-handle already exists'
+          example: 'Unknown error. <error-details>'
 
     RestInputCmHandle:
       required:

diff --git a/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml b/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml
index 5e61d09..0a408c2 100755 (executable)
--- a/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml
+++ b/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml
@@ -40,7 +40,60 @@ updateDmiRegistration:
       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"
+                }
+              ]