diff options
| author |   egernug <gerard.nugent@est.tech> | 2024-05-29 10:22:59 +0100 |
|---|---|---|
| committer | egernug <gerard.nugent@est.tech> | 2024-05-30 15:28:58 +0100 |
| commit | daf2ba8f11d98b26e871961d1c6bd1b4c5c89aab (patch) | |
| tree | 59ce0ae8b2e17d90197914802a2ed95157446896 /openapi | |
| parent | 190c30c687cb5506fed6e27bfa623fa2747386bb (diff) | |
Implement ACK in DMI Plugin
Implementing a response in DMI Plugin to indicate that the datajobs API is not implemented
Issue-ID: CPS-2243
Change-Id: I5215d634006a2031638110e3dc159c66ad4e7d86
Signed-off-by: egernug <gerard.nugent@est.tech>
Diffstat (limited to 'openapi')
| -rw-r--r-- | openapi/openapi-datajob.yml | 51 |
1 files changed, 28 insertions, 23 deletions
diff --git a/openapi/openapi-datajob.yml b/openapi/openapi-datajob.yml index 8a0f315b..989218d9 100644 --- a/openapi/openapi-datajob.yml +++ b/openapi/openapi-datajob.yml @@ -27,7 +27,7 @@ tags: - description: DMI plugin rest apis name: dmi-datajob paths: - /dmi/v1/readJob/{requestId}: + /v1/readJob/{requestId}: post: description: Create a read request operationId: readDataJob @@ -42,17 +42,9 @@ paths: tags: - dmi-datajob responses: - "200": - description: Response for subjob - content: - application/json: - schema: - type: object - properties: - dataProducerJobId: - type: string - description: The data job ID. - /dmi/v1/writeJob/{requestId}: + "501": + $ref: '#/components/responses/NotImplemented' + /v1/writeJob/{requestId}: post: description: Create a write request operationId: writeDataJob @@ -67,16 +59,9 @@ paths: tags: - dmi-datajob responses: - "200": - description: Response for subjob - content: - application/json: - schema: - type: object - properties: - dataProducerJobId: - type: string - description: The data job ID. + "501": + $ref: '#/components/responses/NotImplemented' + components: parameters: requestIdInPath: @@ -88,6 +73,16 @@ components: example: some-identifier type: string schemas: + ErrorMessage: + type: object + title: Error + properties: + status: + type: string + message: + type: string + details: + type: string SubjobReadRequest: type: object required: @@ -245,5 +240,15 @@ components: type: string Object: type: object - + responses: + NotImplemented: + description: Not Implemented + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + example: + status: 501 + message: Not Implemented + details: Method Not Implemented |