diff options
Diffstat (limited to 'docs/api/swagger/openapi-datajob.yaml')
| -rw-r--r-- | docs/api/swagger/openapi-datajob.yaml | 172 |
1 files changed, 119 insertions, 53 deletions
diff --git a/docs/api/swagger/openapi-datajob.yaml b/docs/api/swagger/openapi-datajob.yaml index 284b372e..a0b6d4f3 100644 --- a/docs/api/swagger/openapi-datajob.yaml +++ b/docs/api/swagger/openapi-datajob.yaml @@ -5,25 +5,25 @@ info: title: NCMP Data Subjob API version: 1.0.0 servers: -- url: /dmi + - url: /dmi tags: -- description: DMI plugin rest apis - name: dmi-datajob + - description: DMI plugin rest apis + name: dmi-datajob paths: /v1/readJob/{requestId}: post: description: Create a read request operationId: readDataJob 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 overall Datajob + explode: false + in: path + name: requestId + required: true + schema: + example: some-identifier + type: string + style: simple requestBody: content: application/3gpp-json-patch+json: @@ -42,21 +42,21 @@ paths: $ref: '#/components/schemas/ErrorMessage' description: Not Implemented tags: - - dmi-datajob + - dmi-datajob /v1/writeJob/{requestId}: post: description: Create a write request operationId: writeDataJob 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 overall Datajob + explode: false + in: path + name: requestId + required: true + schema: + example: some-identifier + type: string + style: simple requestBody: content: application/3gpp-json-patch+json: @@ -75,7 +75,52 @@ paths: $ref: '#/components/schemas/ErrorMessage' description: Not Implemented tags: - - dmi-datajob + - dmi-datajob + /v1/dataJob/{requestId}/dataProducerJob/{dataProducerJobId}/status: + get: + description: Retrieve the status of a specific data job. + operationId: getDataJobStatus + 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 + 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: @@ -88,6 +133,26 @@ components: example: some-identifier type: string style: simple + dataProducerJobIdInPath: + 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 + dataProducerIdInQuery: + description: Identifier for the data producer + explode: true + in: query + name: dataProducerId + required: true + schema: + example: some-data-producer-identifier + type: string + style: form responses: NotImplemented: content: @@ -137,8 +202,8 @@ components: $ref: '#/components/schemas/SubjobReadRequest_data_inner' type: array required: - - data - - dataProducerId + - data + - dataProducerId type: object SubjobWriteRequest: properties: @@ -167,8 +232,8 @@ components: $ref: '#/components/schemas/SubjobWriteRequest_data_inner' type: array required: - - data - - dataProducerId + - data + - dataProducerId type: object CmHandleProperties: description: Private properties of the cm handle for the given path @@ -194,6 +259,26 @@ components: type: object Object: type: object + SubjobWriteResponse: + properties: + subJobId: + description: Unique identifier for the sub-job + example: my-sub-job-id + type: string + dmiServiceName: + description: Name of the relevant DMI Service + example: my-dmi-service + type: string + dataProducerId: + description: ID of the producer registered by DMI for the paths in the operations + in this request + example: my-data-producer-identifier + type: string + required: + - dataProducerId + - dmiServiceName + - subJobId + type: object SubjobReadRequest_data_inner: properties: path: @@ -244,16 +329,16 @@ components: description: Private properties of the cm handle for the given path type: object required: - - op - - path + - op + - path type: object SubjobWriteRequest_data_inner_value: description: Value dependent on the op specified. Resource for an add. Object for a replace. ActionParameters for an action. oneOf: - - $ref: '#/components/schemas/Resource' - - $ref: '#/components/schemas/ActionParameters' - - $ref: '#/components/schemas/Object' + - $ref: '#/components/schemas/Resource' + - $ref: '#/components/schemas/ActionParameters' + - $ref: '#/components/schemas/Object' type: object SubjobWriteRequest_data_inner: properties: @@ -279,25 +364,6 @@ components: value: $ref: '#/components/schemas/SubjobWriteRequest_data_inner_value' required: - - op - - path + - op + - path type: object - SubjobWriteResponse: - type: object - required: - - subJobId - - dmiServiceName - - dataProducerId - properties: - subJobId: - description: Unique identifier for the sub-job - example: my-sub-job-id - type: string - dmiServiceName: - description: Name of the relevant DMI Service - example: my-dmi-service - type: string - dataProducerId: - description: ID of the producer registered by DMI for the paths in the operations in this request - example: my-data-producer-identifier - type: string |