aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authormpriyank <priyank.maheshwari@est.tech>2022-03-28 15:47:47 +0530
committermpriyank <priyank.maheshwari@est.tech>2022-04-04 21:11:09 +0530
commit93afc1eb95f38939ec0c60cce466d76d449e7faf (patch)
treefc2cc9abe88771a5a302fb5d4f51566f80c6ec19 /docs
parent512f7ab93af18ed1f2bd93da18879666906521f6 (diff)
Structured Exception details for DMI
- Introduced DmiErrorMessage in API docs with 502 Bad Gateway - HttpClientRequestException will be thrown which will be exposed as 502 BAD Gateway for the client from NCMP Issue-ID: CPS-917 Change-Id: Iba8f159e8216bc1f63a9ab86208e5c802437e2e8 Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
Diffstat (limited to 'docs')
-rw-r--r--docs/api/swagger/ncmp/openapi.yaml84
1 files changed, 84 insertions, 0 deletions
diff --git a/docs/api/swagger/ncmp/openapi.yaml b/docs/api/swagger/ncmp/openapi.yaml
index 5a6a600a36..606b69f75e 100644
--- a/docs/api/swagger/ncmp/openapi.yaml
+++ b/docs/api/swagger/ncmp/openapi.yaml
@@ -131,6 +131,18 @@ paths:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
+ "502":
+ description: Bad Gateway
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DmiErrorMessage'
+ example:
+ message: "Bad Gateway Error Message NCMP"
+ dmi-response:
+ http-code: 400
+ body: Bad Request
+
/v1/ch/{cm-handle}/data/ds/ncmp-datastore:passthrough-running:
get:
tags:
@@ -256,6 +268,17 @@ paths:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
+ "502":
+ description: Bad Gateway
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DmiErrorMessage'
+ example:
+ message: "Bad Gateway Error Message NCMP"
+ dmi-response:
+ http-code: 400
+ body: Bad Request
put:
tags:
- network-cm-proxy
@@ -362,6 +385,17 @@ paths:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
+ "502":
+ description: Bad Gateway
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DmiErrorMessage'
+ example:
+ message: "Bad Gateway Error Message NCMP"
+ dmi-response:
+ http-code: 400
+ body: Bad Request
post:
tags:
- network-cm-proxy
@@ -464,6 +498,17 @@ paths:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
+ "502":
+ description: Bad Gateway
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DmiErrorMessage'
+ example:
+ message: "Bad Gateway Error Message NCMP"
+ dmi-response:
+ http-code: 400
+ body: Bad Request
delete:
tags:
- network-cm-proxy
@@ -561,6 +606,17 @@ paths:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
+ "502":
+ description: Bad Gateway
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DmiErrorMessage'
+ example:
+ message: "Bad Gateway Error Message NCMP"
+ dmi-response:
+ http-code: 400
+ body: Bad Request
patch:
tags:
- network-cm-proxy
@@ -661,6 +717,17 @@ paths:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
+ "502":
+ description: Bad Gateway
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DmiErrorMessage'
+ example:
+ message: "Bad Gateway Error Message NCMP"
+ dmi-response:
+ http-code: 400
+ body: Bad Request
/v1/ch/{cm-handle}/modules:
get:
tags:
@@ -873,6 +940,23 @@ components:
type: string
details:
type: string
+ # DMI Server Exception Schema
+ DmiErrorMessage:
+ title: DMI Error Message
+ type: object
+ properties:
+ message:
+ type: string
+ example: "Bad Gateway Error Message NCMP"
+ dmi-response:
+ type: object
+ properties:
+ http-code:
+ type: integer
+ example: 400
+ body:
+ type: string
+ example: Bad Request
RestModuleReference:
title: Module reference details
type: object