diff options
Diffstat (limited to 'cps-ncmp-rest/docs/openapi/ncmp-inventory.yml')
-rwxr-xr-x | cps-ncmp-rest/docs/openapi/ncmp-inventory.yml | 60 |
1 files changed, 58 insertions, 2 deletions
diff --git a/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml b/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml index 3cd8e8baf..0a408c241 100755 --- a/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml +++ b/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml @@ -31,7 +31,7 @@ updateDmiRegistration: schema: $ref: 'components.yaml#/components/schemas/RestDmiPluginRegistration' responses: - 204: + 200: $ref: 'components.yaml#/components/responses/NoContent' 400: $ref: 'components.yaml#/components/responses/BadRequest' @@ -40,4 +40,60 @@ updateDmiRegistration: 403: $ref: 'components.yaml#/components/responses/Forbidden' 500: - $ref: 'components.yaml#/components/responses/InternalServerError' + 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" + } + ] |