diff options
| author |   leventecsanyi <levente.csanyi@est.tech> | 2024-07-26 13:25:12 +0200 |
|---|---|---|
| committer | leventecsanyi <levente.csanyi@est.tech> | 2024-07-26 16:41:38 +0200 |
| commit | ee4242c9d89dc1a814f12d0f90880e3f21745f43 (patch) | |
| tree | ba07625919bbf93de269a7d46d97888a6b780c6e /docs/api/swagger | |
| parent | 7f49c706b6fba519d34099b08450b884d53c798b (diff) | |
Get data job result
- extended openapi
- added not-implemented http error for result endpoint
- added testware
- added stub implementation
- fixed writeDataJob bug in stub
Issue-ID: CPS-2296
Signed-off-by: leventecsanyi <levente.csanyi@est.tech>
Change-Id: I9398cb73b635bec360df886372690187ff54e0d4
Diffstat (limited to 'docs/api/swagger')
| -rw-r--r-- | docs/api/swagger/openapi-datajob.yaml | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/docs/api/swagger/openapi-datajob.yaml b/docs/api/swagger/openapi-datajob.yaml index a0b6d4f3..18efbc38 100644 --- a/docs/api/swagger/openapi-datajob.yaml +++ b/docs/api/swagger/openapi-datajob.yaml @@ -121,6 +121,60 @@ paths: description: Not Implemented tags: - dmi-datajob + /v1/dataJob/{requestId}/dataProducerJob/{dataProducerJobId}/result: + get: + description: Retrieve the result of a data job. + operationId: getDataJobResult + parameters: + - description: Identifier for the overall Datajob + explode: false + in: path + name: requestId + required: true + schema: + example: some-identifier + type: string + style: simple + - description: Identifier for the data producer job + explode: false + in: path + name: dataProducerJobId + required: true + schema: + example: some-producer-job-identifier + type: string + style: simple + - description: Identifier for the data producer + explode: true + in: query + name: dataProducerId + required: true + schema: + example: some-data-producer-identifier + type: string + style: form + - description: The destination of the results (Kafka topic name or s3 bucket name) + explode: true + in: query + name: destination + required: true + schema: + example: some-destination + type: string + style: form + responses: + "501": + content: + application/json: + example: + status: 501 + message: Not Implemented + details: Method Not Implemented + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Not Implemented + tags: + - dmi-datajob components: parameters: requestIdInPath: @@ -153,6 +207,16 @@ components: example: some-data-producer-identifier type: string style: form + destinationInQuery: + description: The destination of the results (Kafka topic name or s3 bucket name) + explode: true + in: query + name: destination + required: true + schema: + example: some-destination + type: string + style: form responses: NotImplemented: content: |