diff options
| author |   mpriyank <priyank.maheshwari@est.tech> | 2022-03-28 15:47:47 +0530 |
|---|---|---|
| committer | mpriyank <priyank.maheshwari@est.tech> | 2022-04-04 21:11:09 +0530 |
| commit | 93afc1eb95f38939ec0c60cce466d76d449e7faf (patch) | |
| tree | fc2cc9abe88771a5a302fb5d4f51566f80c6ec19 /cps-ncmp-rest/docs/openapi/components.yaml | |
| parent | 512f7ab93af18ed1f2bd93da18879666906521f6 (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 'cps-ncmp-rest/docs/openapi/components.yaml')
| -rw-r--r-- | cps-ncmp-rest/docs/openapi/components.yaml | 29 |
1 files changed, 28 insertions, 1 deletions
diff --git a/cps-ncmp-rest/docs/openapi/components.yaml b/cps-ncmp-rest/docs/openapi/components.yaml index 69225aed2d..092c0a28bb 100644 --- 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 - + # 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 @@ -434,3 +450,14 @@ components: 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" |