summaryrefslogtreecommitdiffstats
path: root/cps-ncmp-rest/docs/openapi/components.yaml
diff options
context:
space:
mode:
authorniamhcore <niamh.core@est.tech>2021-10-19 11:07:02 +0100
committerniamhcore <niamh.core@est.tech>2021-10-20 11:46:21 +0100
commit66017b4b6f910579d13f0a45ef7c587e86f325fd (patch)
treec959cabc3755465c17890e7327b67ab27601ff30 /cps-ncmp-rest/docs/openapi/components.yaml
parent46de0fbcdd71324353cf9adf824060a57bc5d642 (diff)
Add get cm handles by modules to open api
Issue-ID: CPS-644 Signed-off-by: niamhcore <niamh.core@est.tech> Change-Id: I228782027cafcf59843ff4b8de1dd5ea3988ddba
Diffstat (limited to 'cps-ncmp-rest/docs/openapi/components.yaml')
-rw-r--r--cps-ncmp-rest/docs/openapi/components.yaml47
1 files changed, 47 insertions, 0 deletions
diff --git a/cps-ncmp-rest/docs/openapi/components.yaml b/cps-ncmp-rest/docs/openapi/components.yaml
index d35919da4b..1f55ce1998 100644
--- a/cps-ncmp-rest/docs/openapi/components.yaml
+++ b/cps-ncmp-rest/docs/openapi/components.yaml
@@ -19,6 +19,7 @@
components:
schemas:
+ # Common Schemas
ErrorMessage:
type: object
title: Error
@@ -30,6 +31,7 @@ components:
details:
type: string
+ # Request Schemas
RestDmiPluginRegistration:
type: object
properties:
@@ -65,6 +67,51 @@ components:
type: string
example: system-001
+ Conditions:
+ type: object
+ properties:
+ conditions:
+ $ref: '#/components/schemas/ConditionsData'
+ ConditionsData:
+ type: array
+ items:
+ type: object
+ $ref: '#/components/schemas/ConditionProperties'
+ ConditionProperties:
+ properties:
+ name:
+ type: string
+ example: hasAllModules
+ conditionParameters:
+ $ref: '#/components/schemas/ConditionParameters'
+ ConditionParameters:
+ type: array
+ items:
+ type: object
+ $ref: '#/components/schemas/ConditionParameter'
+ ConditionParameter:
+ properties:
+ moduleName:
+ type: string
+ example: someModuleName
+
+ #Response Schemas
+ CmHandles:
+ type: object
+ properties:
+ cmHandles:
+ $ref: '#/components/schemas/CmHandleProperties'
+ CmHandleProperties:
+ type: array
+ items:
+ type: object
+ $ref: '#/components/schemas/CmHandleProperty'
+ CmHandleProperty:
+ properties:
+ cmHandleId:
+ type: string
+ example: someCmHandleId
+
parameters:
cmHandleInPath:
name: cm-handle