summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorniamhcore <niamh.core@est.tech>2021-08-20 11:24:06 +0100
committerniamhcore <niamh.core@est.tech>2021-08-25 11:25:31 +0100
commit79e41e0794035ea8dd3ae3064f8d368b5345df95 (patch)
tree8d16f71d154195caee224407ff50cd6792610e20 /docs
parenteb26379d71b67c9e76f366665549c92d6f05b1eb (diff)
Write data for cm handle passthrough:running
Issue-ID: CPS-574 Signed-off-by: niamhcore <niamh.core@est.tech> Change-Id: I15e2ad500d2bbf7a1d408b8a852287e55bddbecb
Diffstat (limited to 'docs')
-rw-r--r--docs/openapi/components.yml17
-rw-r--r--docs/openapi/openapi.yml30
2 files changed, 44 insertions, 3 deletions
diff --git a/docs/openapi/components.yml b/docs/openapi/components.yml
index cb39fa4e..ba2a0ece 100644
--- a/docs/openapi/components.yml
+++ b/docs/openapi/components.yml
@@ -58,7 +58,7 @@ components:
namespace:
type: string
- OperationalRequest:
+ DataAccessReadRequest:
type: object
properties:
operation:
@@ -69,6 +69,21 @@ components:
additionalProperties:
type: string
+ DataAccessWriteRequest:
+ type: object
+ properties:
+ operation:
+ type: string
+ enum: [ create ]
+ dataType:
+ type: string
+ data:
+ type: object
+ cmHandleProperties:
+ type: object
+ additionalProperties:
+ type: string
+
responses:
NotFound:
description: The specified resource was not found
diff --git a/docs/openapi/openapi.yml b/docs/openapi/openapi.yml
index af285f4e..f169efd0 100644
--- a/docs/openapi/openapi.yml
+++ b/docs/openapi/openapi.yml
@@ -136,7 +136,7 @@ paths:
content:
application/json:
schema:
- $ref: 'components.yml#/components/schemas/OperationalRequest'
+ $ref: 'components.yml#/components/schemas/DataAccessReadRequest'
responses:
'200':
$ref: 'components.yml#/components/responses/Ok'
@@ -165,7 +165,7 @@ paths:
content:
application/json:
schema:
- $ref: 'components.yml#/components/schemas/OperationalRequest'
+ $ref: 'components.yml#/components/schemas/DataAccessReadRequest'
responses:
'200':
$ref: 'components.yml#/components/responses/Ok'
@@ -175,3 +175,29 @@ paths:
$ref: 'components.yml#/components/responses/Unauthorized'
'403':
$ref: 'components.yml#/components/responses/Forbidden'
+
+ post:
+ description: Write data for a cmHandle using passthrough-running
+ tags:
+ - dmi-plugin
+ summary: Write data for a cmHandle
+ operationId: writeDataByPassthroughRunningForCmHandle
+ parameters:
+ - $ref: 'components.yml#/components/parameters/cmHandleInPath'
+ - $ref: 'components.yml#/components/parameters/resourceIdentifierInPath'
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: 'components.yml#/components/schemas/DataAccessWriteRequest'
+ responses:
+ '200':
+ $ref: 'components.yml#/components/responses/Ok'
+ '400':
+ $ref: 'components.yml#/components/responses/BadRequest'
+ '401':
+ $ref: 'components.yml#/components/responses/Unauthorized'
+ '403':
+ $ref: 'components.yml#/components/responses/Forbidden'
+