diff options
Diffstat (limited to 'openapi')
| -rw-r--r-- | openapi/components.yml | 21 | ||||
| -rw-r--r-- | openapi/openapi-datajob.yml | 51 | ||||
| -rw-r--r-- | openapi/openapi.yml | 1 |
3 files changed, 32 insertions, 41 deletions
diff --git a/openapi/components.yml b/openapi/components.yml index ae9710b1..4a6d1729 100644 --- a/openapi/components.yml +++ b/openapi/components.yml @@ -180,6 +180,9 @@ components: requestId: type: string example: 3a9ce55c-e365-4dc9-8da3-a06f07cbc6d7 + moduleSetTag: + type: string + example: module-set-tag1 cmHandleProperties: type: object @@ -252,7 +255,6 @@ components: in: query description: Resource identifier to get/set the resource data required: true - allowReserved: true schema: type: string example: my-schema:my-node @@ -264,7 +266,6 @@ components: required: false schema: type: string - allowReserved: true examples: sample1: value: @@ -283,7 +284,6 @@ components: required: false schema: type: string - allowReserved: true examples: sample1: value: my-topic-name @@ -295,23 +295,11 @@ components: required: true schema: type: string - allowReserved: true examples: sample1: value: topic: my-topic-name - moduleSetTagParamInQuery: - name: moduleSetTag - in: query - description: Module set tag of the given cm handle. - required: false - schema: - type: string - examples: - sample1: - value: tag1 - requiredRequestIdParamInQuery: name: requestId in: query @@ -319,7 +307,6 @@ components: required: true schema: type: string - allowReserved: true examples: sample1: value: 4753fc1f-7de2-449a-b306-a6204b5370b3 @@ -334,4 +321,4 @@ components: example: ncmp-datastore:passthrough-operational or ncmp-datastore:passthrough-running security: - - basicAuth: []
\ No newline at end of file + - basicAuth: [] diff --git a/openapi/openapi-datajob.yml b/openapi/openapi-datajob.yml index 8a0f315b..989218d9 100644 --- a/openapi/openapi-datajob.yml +++ b/openapi/openapi-datajob.yml @@ -27,7 +27,7 @@ tags: - description: DMI plugin rest apis name: dmi-datajob paths: - /dmi/v1/readJob/{requestId}: + /v1/readJob/{requestId}: post: description: Create a read request operationId: readDataJob @@ -42,17 +42,9 @@ paths: tags: - dmi-datajob responses: - "200": - description: Response for subjob - content: - application/json: - schema: - type: object - properties: - dataProducerJobId: - type: string - description: The data job ID. - /dmi/v1/writeJob/{requestId}: + "501": + $ref: '#/components/responses/NotImplemented' + /v1/writeJob/{requestId}: post: description: Create a write request operationId: writeDataJob @@ -67,16 +59,9 @@ paths: tags: - dmi-datajob responses: - "200": - description: Response for subjob - content: - application/json: - schema: - type: object - properties: - dataProducerJobId: - type: string - description: The data job ID. + "501": + $ref: '#/components/responses/NotImplemented' + components: parameters: requestIdInPath: @@ -88,6 +73,16 @@ components: example: some-identifier type: string schemas: + ErrorMessage: + type: object + title: Error + properties: + status: + type: string + message: + type: string + details: + type: string SubjobReadRequest: type: object required: @@ -245,5 +240,15 @@ components: type: string Object: type: object - + responses: + NotImplemented: + description: Not Implemented + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + example: + status: 501 + message: Not Implemented + details: Method Not Implemented diff --git a/openapi/openapi.yml b/openapi/openapi.yml index 38f21c15..6dbc19f3 100644 --- a/openapi/openapi.yml +++ b/openapi/openapi.yml @@ -128,7 +128,6 @@ paths: - $ref: 'components.yml#/components/parameters/resourceIdentifierInQuery' - $ref: 'components.yml#/components/parameters/optionsParamInQuery' - $ref: 'components.yml#/components/parameters/topicParamInQuery' - - $ref: 'components.yml#/components/parameters/moduleSetTagParamInQuery' requestBody: description: Contains collection of cm handles with it's private properties and requestId content: |