diff options
| author |   Renu Kumari <renu.kumari@bell.ca> | 2022-04-18 12:39:33 -0400 |
|---|---|---|
| committer | Renu Kumari <renu.kumari@bell.ca> | 2022-04-18 16:44:21 +0000 |
| commit | 952603c5739d3bec19c45f12adb01ee9e63e9337 (patch) | |
| tree | 6fced9757e5e3c9492f37898d9984303ba652b3e /cps-ncmp-rest/docs/openapi/ncmp-inventory.yml | |
| parent | 006c7dca01d6d04ce122eadc06707a5b0b70d76c (diff) | |
Document ncmp-inventory error code in openapi
Issue-ID: CPS-896
Signed-off-by: Renu Kumari <renu.kumari@bell.ca>
Change-Id: Ic39da86c18ac921a6a3d213064f0b7c77d08e06f
Diffstat (limited to 'cps-ncmp-rest/docs/openapi/ncmp-inventory.yml')
| -rwxr-xr-x | cps-ncmp-rest/docs/openapi/ncmp-inventory.yml | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml b/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml index 5e61d0962..0a408c241 100755 --- 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" + } + ] |