Refactored dat job interfaces - result endpoint changed is a separate commit
-changed openapi and stub implementations
Issue-ID: CPS-2360
Signed-off-by: leventecsanyi <levente.csanyi@est.tech>
Change-Id: Ib7d826f5909278309b7c16dc5caaabbe5f01732b
diff --git a/dmi-service/openapi/openapi-datajob.yml b/dmi-service/openapi/openapi-datajob.yml
index aa93623..09e23a9 100644
--- a/dmi-service/openapi/openapi-datajob.yml
+++ b/dmi-service/openapi/openapi-datajob.yml
@@ -27,12 +27,12 @@
- description: DMI plugin rest apis
name: dmi-datajob
paths:
- /v1/readJob/{requestId}:
+ /v1/cmreadJob:
post:
description: Create a read request
operationId: readDataJob
parameters:
- - $ref: '#/components/parameters/requestIdInPath'
+ - $ref: '#/components/parameters/destinationInQuery'
requestBody:
description: Operation body
content:
@@ -44,12 +44,12 @@
responses:
"501":
$ref: '#/components/responses/NotImplemented'
- /v1/writeJob/{requestId}:
+ /v1/cmwriteJob:
post:
description: Create a write request
operationId: writeDataJob
parameters:
- - $ref: '#/components/parameters/requestIdInPath'
+ - $ref: '#/components/parameters/destinationInQuery'
requestBody:
description: Operation body
content:
@@ -61,14 +61,13 @@
responses:
"501":
$ref: '#/components/responses/NotImplemented'
- /v1/dataJob/{requestId}/dataProducerJob/{dataProducerJobId}/status:
+ /v1/cmwriteJob/dataProducer/{dataProducerId}/dataProducerJob/{dataProducerJobId}/status:
get:
description: Retrieve the status of a specific data job.
operationId: getDataJobStatus
parameters:
- - $ref: '#/components/parameters/requestIdInPath'
+ - $ref: '#/components/parameters/dataProducerIdInPath'
- $ref: '#/components/parameters/dataProducerJobIdInPath'
- - $ref: '#/components/parameters/dataProducerIdInQuery'
tags:
- dmi-datajob
responses:
@@ -107,6 +106,14 @@
schema:
example: some-producer-job-identifier
type: string
+ dataProducerIdInPath:
+ name: dataProducerId
+ in: path
+ description: Identifier for the data producer
+ required: true
+ schema:
+ type: string
+ example: some-data-producer-identifier
dataProducerIdInQuery:
name: dataProducerId
in: query
@@ -227,6 +234,10 @@
description: ID of the producer registered by DMI for the paths in the operations in this request
example: my-data-producer-identifier
type: string
+ dataJobId:
+ description: Identifier for the overall Data Job
+ example: my-data-producer-identifier
+ type: string
data:
example:
op: add