diff options
| author |   leventecsanyi <levente.csanyi@est.tech> | 2023-04-05 11:42:30 +0200 |
|---|---|---|
| committer | leventecsanyi <levente.csanyi@est.tech> | 2023-04-17 12:06:01 +0200 |
| commit | fff80c048f90ad6b58a00329e514f0c2e5c41dd5 (patch) | |
| tree | c710d2222d04afb9ce49cee29e88c4ccbb659b10 /openapi | |
| parent | c4a18054d489a83efb99a8975585631e5ecd0b10 (diff) | |
Define an interface to accept collection of cm handles for Get operation.
- Added REST endpoint (Not Implemented yet)
- Created unit test
Issue-ID: CPS-1555
Change-Id: I24ce8d663602c08cc207f4657289631439d3fb9e
Signed-off-by: leventecsanyi <levente.csanyi@est.tech>
Diffstat (limited to 'openapi')
| -rw-r--r-- | openapi/components.yml | 12 | ||||
| -rw-r--r-- | openapi/openapi.yml | 36 |
2 files changed, 44 insertions, 4 deletions
diff --git a/openapi/components.yml b/openapi/components.yml index 1e35c028..2bddd8b9 100644 --- a/openapi/components.yml +++ b/openapi/components.yml @@ -1,5 +1,5 @@ # ============LICENSE_START======================================================= -# Copyright (C) 2021-2022 Nordix Foundation +# Copyright (C) 2021-2023 Nordix Foundation # Modifications Copyright (C) 2022 Bell Canada # ================================================================================ # Licensed under the Apache License, Version 2.0 (the "License"); @@ -164,6 +164,16 @@ components: status: 500 message: Internal Server Error details: Internal Server Error occured + NotImplemented: + description: Not Implemented + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + example: + status: 501 + message: Not Implemented + details: Method Not Implemented parameters: cmHandleInPath: name: cmHandle diff --git a/openapi/openapi.yml b/openapi/openapi.yml index 38d5cef5..24854e9c 100644 --- a/openapi/openapi.yml +++ b/openapi/openapi.yml @@ -119,8 +119,8 @@ paths: post: tags: - dmi-plugin - summary: Get resource data from passthrough operational or running for cm handles - description: Get resource data from passthrough operational or running for cm handles + summary: Get resource data from passthrough operational or running for a cm handle + description: Get resource data from passthrough operational or running for a cm handle operationId: dataAccessPassthrough parameters: - $ref: 'components.yml#/components/parameters/datastoreName' @@ -148,4 +148,34 @@ paths: '400': $ref: 'components.yml#/components/responses/BadRequest' '500': - $ref: 'components.yml#/components/responses/ServerError'
\ No newline at end of file + $ref: 'components.yml#/components/responses/ServerError' + + /v1/ch/batch/data/ds/{datastore-name}: + post: + tags: + - dmi-plugin + summary: Get a collection of CMHandles + description: Get a collection of cm handles by datastore (not implemented) + operationId: getResourceDataByCmHandles + parameters: + - $ref: 'components.yml#/components/parameters/datastoreName' + - $ref: 'components.yml#/components/parameters/topicParamInQuery' + requestBody: + description: Contains collection of cm handles with it's private properties and requestId + content: + application/json: + schema: + type: object + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + '400': + $ref: 'components.yml#/components/responses/BadRequest' + '500': + $ref: 'components.yml#/components/responses/ServerError' + '501': + $ref: 'components.yml#/components/responses/NotImplemented'
\ No newline at end of file |