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]
/
cps-ncmp-rest
/
docs
/
openapi
/
components.yaml
diff --git
a/cps-ncmp-rest/docs/openapi/components.yaml
b/cps-ncmp-rest/docs/openapi/components.yaml
index
6477e34
..
092c0a2
100644
(file)
--- a/
cps-ncmp-rest/docs/openapi/components.yaml
+++ b/
cps-ncmp-rest/docs/openapi/components.yaml
@@
-30,7
+30,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
# Request Schemas
RestDmiPluginRegistration:
type: object
# Request Schemas
RestDmiPluginRegistration:
type: object
@@
-135,7
+151,7
@@
components:
type: string
example: my-cm-handle-id
type: string
example: my-cm-handle-id
- ModuleReference:
+
Rest
ModuleReference:
type: object
title: Module reference details
properties:
type: object
title: Module reference details
properties:
@@
-329,6
+345,18
@@
components:
sample 3:
value:
options: (depth=2,fields=book/authors)
sample 3:
value:
options: (depth=2,fields=book/authors)
+ topicParamInQuery:
+ name: topic
+ in: query
+ description: topic parameter in query.
+ required: false
+ schema:
+ type: string
+ allowReserved: true
+ examples:
+ sample 1:
+ value:
+ topic: my-topic-name
contentParamInHeader:
name: Content-Type
in: header
contentParamInHeader:
name: Content-Type
in: header
@@
-422,3
+450,14
@@
components:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
status: 500
message: Internal Server Error
details: Internal Server Error occurred
+ BadGateway:
+ 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"