diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/swagger/openapi-datajob.yaml | 185 |
1 files changed, 88 insertions, 97 deletions
diff --git a/docs/api/swagger/openapi-datajob.yaml b/docs/api/swagger/openapi-datajob.yaml index 54ce0660..ef435f54 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/cmreadJob: post: description: Create a read request operationId: readDataJob parameters: - - description: The destination of the results (Kafka topic name or s3 bucket - name) - in: query - name: destination - required: true - schema: - example: some-destination - type: string - style: form + - description: The destination of the results (Kafka topic name or s3 bucket + name) + in: query + name: destination + required: true + schema: + example: some-destination + type: string + style: form 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/cmwriteJob: post: description: Create a write request operationId: writeDataJob parameters: - - description: The destination of the results (Kafka topic name or s3 bucket - name) - in: query - name: destination - required: true - schema: - example: some-destination - type: string - style: form + - description: The destination of the results (Kafka topic name or s3 bucket + name) + in: query + name: destination + required: true + schema: + example: some-destination + type: string + style: form requestBody: content: application/3gpp-json-patch+json: @@ -75,36 +75,30 @@ paths: $ref: '#/components/schemas/ErrorMessage' description: Not Implemented tags: - - dmi-datajob + - dmi-datajob /v1/cmwriteJob/dataProducer/{dataProducerId}/dataProducerJob/{dataProducerJobId}/status: get: description: Retrieve the status of a specific data job. operationId: getDataJobStatus parameters: - - description: Identifier for the data producer - in: path - name: dataProducerId - required: true - schema: - example: some-data-producer-identifier - type: string - style: simple - - description: Identifier for the data producer job - in: path - name: dataProducerJobId - required: true - schema: - example: some-producer-job-identifier - type: string - style: simple - - description: Identifier for the data producer - in: query - name: dataProducerId - required: true - schema: - example: some-data-producer-identifier - type: string - style: form + - description: Identifier for the data producer + explode: false + in: path + name: dataProducerId + required: true + schema: + example: some-data-producer-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 responses: "501": content: @@ -117,45 +111,39 @@ paths: $ref: '#/components/schemas/ErrorMessage' description: Not Implemented tags: - - dmi-datajob + - dmi-datajob /v1/cmwriteJob/dataProducer/{dataProducerId}/dataProducerJob/{dataProducerJobId}/result: get: description: Retrieve the result of a data job. operationId: getDataJobResult parameters: - - description: Identifier for the data producer - in: path - name: dataProducerId - required: true - schema: - example: some-data-producer-identifier - type: string - style: simple - - description: Identifier for the data producer job - in: path - name: dataProducerJobId - required: true - schema: - example: some-producer-job-identifier - type: string - style: simple - - description: Identifier for the data producer - 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) - in: query - name: destination - required: true - schema: - example: some-destination - type: string - style: form + - description: Identifier for the data producer + explode: false + in: path + name: dataProducerId + required: true + schema: + example: some-data-producer-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: The destination of the results (Kafka topic name or s3 bucket + name) + in: query + name: destination + required: true + schema: + example: some-destination + type: string + style: form responses: "501": content: @@ -168,11 +156,12 @@ paths: $ref: '#/components/schemas/ErrorMessage' description: Not Implemented tags: - - dmi-datajob + - dmi-datajob components: parameters: requestIdInPath: description: Identifier for the overall Datajob + explode: false in: path name: requestId required: true @@ -182,6 +171,7 @@ components: style: simple dataProducerJobIdInPath: description: Identifier for the data producer job + explode: false in: path name: dataProducerJobId required: true @@ -191,6 +181,7 @@ components: style: simple dataProducerIdInPath: description: Identifier for the data producer + explode: false in: path name: dataProducerId required: true @@ -265,8 +256,8 @@ components: $ref: '#/components/schemas/SubjobReadRequest_data_inner' type: array required: - - data - - dataProducerId + - data + - dataProducerId type: object SubjobWriteRequest: properties: @@ -285,7 +276,7 @@ components: type: string dataJobId: description: Identifier for the overall Data Job - example: my-data-job-identifier + example: my-data-producer-identifier type: string data: example: @@ -299,8 +290,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 @@ -342,9 +333,9 @@ components: example: my-data-producer-identifier type: string required: - - dataProducerId - - dmiServiceName - - subJobId + - dataProducerId + - dmiServiceName + - subJobId type: object SubjobReadRequest_data_inner: properties: @@ -396,16 +387,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: @@ -431,6 +422,6 @@ components: value: $ref: '#/components/schemas/SubjobWriteRequest_data_inner_value' required: - - op - - path + - op + - path type: object |