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 /docs | |
| 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 'docs')
| -rw-r--r-- | docs/api/swagger/openapi-datajob.yaml | 53 |
1 files changed, 37 insertions, 16 deletions
diff --git a/docs/api/swagger/openapi-datajob.yaml b/docs/api/swagger/openapi-datajob.yaml index b3baa168..e58591e0 100644 --- a/docs/api/swagger/openapi-datajob.yaml +++ b/docs/api/swagger/openapi-datajob.yaml @@ -10,7 +10,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 @@ -31,15 +31,19 @@ paths: $ref: '#/components/schemas/SubjobReadRequest' description: Operation body responses: - "200": + "501": content: application/json: + example: + status: 501 + message: Not Implemented + details: Method Not Implemented schema: - $ref: '#/components/schemas/readDataJob_200_response' - description: Response for subjob + $ref: '#/components/schemas/ErrorMessage' + description: Not Implemented tags: - dmi-datajob - /dmi/v1/writeJob/{requestId}: + /v1/writeJob/{requestId}: post: description: Create a write request operationId: writeDataJob @@ -60,12 +64,16 @@ paths: $ref: '#/components/schemas/SubjobWriteRequest' description: Operation body responses: - "200": + "501": content: application/json: + example: + status: 501 + message: Not Implemented + details: Method Not Implemented schema: - $ref: '#/components/schemas/readDataJob_200_response' - description: Response for subjob + $ref: '#/components/schemas/ErrorMessage' + description: Not Implemented tags: - dmi-datajob components: @@ -80,7 +88,28 @@ components: example: some-identifier type: string style: simple + responses: + NotImplemented: + content: + application/json: + example: + status: 501 + message: Not Implemented + details: Method Not Implemented + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Not Implemented schemas: + ErrorMessage: + properties: + status: + type: string + message: + type: string + details: + type: string + title: Error + type: object SubjobReadRequest: properties: dataAcceptType: @@ -165,14 +194,6 @@ components: type: object Object: type: object - readDataJob_200_response: - example: - dataProducerJobId: dataProducerJobId - properties: - dataProducerJobId: - description: The data job ID. - type: string - type: object SubjobReadRequest_data_inner: properties: path: |