summaryrefslogtreecommitdiffstats
path: root/openapi
diff options
context:
space:
mode:
Diffstat (limited to 'openapi')
-rw-r--r--openapi/components.yml12
-rw-r--r--openapi/openapi.yml36
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