summaryrefslogtreecommitdiffstats
path: root/cps-ncmp-rest
diff options
context:
space:
mode:
authorRenu Kumari <renu.kumari@bell.ca>2022-04-18 12:39:33 -0400
committerRenu Kumari <renu.kumari@bell.ca>2022-04-18 16:44:21 +0000
commit952603c5739d3bec19c45f12adb01ee9e63e9337 (patch)
tree6fced9757e5e3c9492f37898d9984303ba652b3e /cps-ncmp-rest
parent006c7dca01d6d04ce122eadc06707a5b0b70d76c (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')
-rw-r--r--cps-ncmp-rest/docs/openapi/components.yaml25
-rwxr-xr-xcps-ncmp-rest/docs/openapi/ncmp-inventory.yml53
2 files changed, 55 insertions, 23 deletions
diff --git a/cps-ncmp-rest/docs/openapi/components.yaml b/cps-ncmp-rest/docs/openapi/components.yaml
index a7955c19f9..7ed2efe52a 100644
--- 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 5e61d09625..0a408c2413 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"
+ }
+ ]