summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authortragait <rahul.tyagi@est.tech>2021-07-08 15:42:19 +0100
committerNiamh Core <niamh.core@est.tech>2021-08-04 09:53:58 +0000
commit2270d76e4f33ad231cdae317e88ea1769297cfec (patch)
treefe456072ca8254f6e4435c2d955d766e9cba6eed /docs
parent7c4a9aa88269dbdb21c5c54bc47508463548bc1e (diff)
create post request for cmhandles registration
Issue-ID: CPS-406 Change-Id: I64e88643221403e117146443287d03788fb71c3e Signed-off-by: tragait <rahul.tyagi@est.tech>
Diffstat (limited to 'docs')
-rw-r--r--docs/openapi/components.yml8
-rw-r--r--docs/openapi/openapi.yml25
2 files changed, 33 insertions, 0 deletions
diff --git a/docs/openapi/components.yml b/docs/openapi/components.yml
index bc3a63a0..f38ed64b 100644
--- a/docs/openapi/components.yml
+++ b/docs/openapi/components.yml
@@ -11,6 +11,14 @@ components:
details:
type: string
+ CmHandles:
+ type: object
+ properties:
+ cmHandles:
+ type: array
+ items:
+ type: string
+
responses:
NotFound:
description: The specified resource was not found
diff --git a/docs/openapi/openapi.yml b/docs/openapi/openapi.yml
index 7d0569d4..44747a9e 100644
--- a/docs/openapi/openapi.yml
+++ b/docs/openapi/openapi.yml
@@ -72,4 +72,29 @@ paths:
'401':
$ref: 'components.yml#/components/responses/Unauthorized'
'403':
+ $ref: 'components.yml#/components/responses/Forbidden'
+
+ /v1/inventory/cmHandles:
+ post:
+ tags:
+ - dmi-plugin-internal
+ summary: register given list of cm handles (internal use only)
+ description: register given list of cm handles (internal use only)
+ x-api-audience: component-internal
+ operationId: registerCmHandles
+ requestBody:
+ description: list of cm handles
+ content:
+ application/json:
+ schema:
+ $ref: 'components.yml#/components/schemas/CmHandles'
+ required: true
+ responses:
+ '201':
+ $ref: 'components.yml#/components/responses/Created'
+ '400':
+ $ref: 'components.yml#/components/responses/BadRequest'
+ '401':
+ $ref: 'components.yml#/components/responses/Unauthorized'
+ '403':
$ref: 'components.yml#/components/responses/Forbidden' \ No newline at end of file