summaryrefslogtreecommitdiffstats
path: root/dmi-service/openapi
diff options
context:
space:
mode:
authorleventecsanyi <levente.csanyi@est.tech>2024-07-24 15:42:32 +0200
committerleventecsanyi <levente.csanyi@est.tech>2024-07-25 17:39:52 +0200
commit7f49c706b6fba519d34099b08450b884d53c798b (patch)
tree567832a5b528978f28b9629df9641021f56ed241 /dmi-service/openapi
parent477405c7b9e86061cdc674efb882293a18182606 (diff)
Added REST endpoint for data job status
- extended opanapi - added not-implemented http error for new endpoint - added testware Issue-ID: CPS-2295 Signed-off-by: leventecsanyi <levente.csanyi@est.tech> Change-Id: Ib7aa90da2ec53dd523740ad267919fd2e709e937
Diffstat (limited to 'dmi-service/openapi')
-rw-r--r--dmi-service/openapi/openapi-datajob.yml29
1 files changed, 29 insertions, 0 deletions
diff --git a/dmi-service/openapi/openapi-datajob.yml b/dmi-service/openapi/openapi-datajob.yml
index 31a76bbd..68ee3ecc 100644
--- a/dmi-service/openapi/openapi-datajob.yml
+++ b/dmi-service/openapi/openapi-datajob.yml
@@ -61,6 +61,19 @@ paths:
responses:
"501":
$ref: '#/components/responses/NotImplemented'
+ /v1/dataJob/{requestId}/dataProducerJob/{dataProducerJobId}/status:
+ get:
+ description: Retrieve the status of a specific data job.
+ operationId: getDataJobStatus
+ parameters:
+ - $ref: '#/components/parameters/requestIdInPath'
+ - $ref: '#/components/parameters/dataProducerJobIdInPath'
+ - $ref: '#/components/parameters/dataProducerIdInQuery'
+ tags:
+ - dmi-datajob
+ responses:
+ "501":
+ $ref: '#/components/responses/NotImplemented'
components:
parameters:
@@ -72,6 +85,22 @@ components:
schema:
example: some-identifier
type: string
+ dataProducerJobIdInPath:
+ description: Identifier for the data producer job
+ in: path
+ name: dataProducerJobId
+ required: true
+ schema:
+ example: some-producer-job-identifier
+ type: string
+ dataProducerIdInQuery:
+ name: dataProducerId
+ in: query
+ description: Identifier for the data producer
+ required: true
+ schema:
+ type: string
+ example: some-data-producer-identifier
schemas:
ErrorMessage:
type: object