Code Review
/
cps.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
review
|
tree
raw
|
inline
| side by side
Structured Exception details for DMI
[cps.git]
/
docs
/
api
/
swagger
/
ncmp
/
openapi.yaml
diff --git
a/docs/api/swagger/ncmp/openapi.yaml
b/docs/api/swagger/ncmp/openapi.yaml
index
5a6a600
..
606b69f
100644
(file)
--- 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
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:
/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
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
put:
tags:
- network-cm-proxy
@@
-362,6
+385,17
@@
paths:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
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
post:
tags:
- network-cm-proxy
@@
-464,6
+498,17
@@
paths:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
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
delete:
tags:
- network-cm-proxy
@@
-561,6
+606,17
@@
paths:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
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
patch:
tags:
- network-cm-proxy
@@
-661,6
+717,17
@@
paths:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
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:
/v1/ch/{cm-handle}/modules:
get:
tags:
@@
-873,6
+940,23
@@
components:
type: string
details:
type: string
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
RestModuleReference:
title: Module reference details
type: object