X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=cps-ncmp-rest%2Fdocs%2Fopenapi%2Fncmp-inventory.yml;h=0a408c2413d5b405e8a03784fbf9550cf9f4cfd0;hb=952603c5739d3bec19c45f12adb01ee9e63e9337;hp=b0a50aa83a1e8ebfbf589bf5380abdb1ee57f207;hpb=139e8221933f4d72149601900b421921263e2ba3;p=cps.git diff --git a/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml b/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml index b0a50aa83..0a408c241 100755 --- 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,69 @@ 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. " + }, + { + "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. " + }, + { + "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. " + }, + { + "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" + } + ]