From 66017b4b6f910579d13f0a45ef7c587e86f325fd Mon Sep 17 00:00:00 2001
From: niamhcore <niamh.core@est.tech>
Date: Tue, 19 Oct 2021 11:07:02 +0100
Subject: Add get cm handles by modules to open api

Issue-ID: CPS-644
Signed-off-by: niamhcore <niamh.core@est.tech>
Change-Id: I228782027cafcf59843ff4b8de1dd5ea3988ddba
---
 cps-ncmp-rest/docs/openapi/components.yaml | 47 ++++++++++++++++++++++++++++++
 cps-ncmp-rest/docs/openapi/ncmp.yml        | 29 +++++++++++++++++-
 cps-ncmp-rest/docs/openapi/openapi.yml     |  5 +++-
 3 files changed, 79 insertions(+), 2 deletions(-)

(limited to 'cps-ncmp-rest/docs')

diff --git a/cps-ncmp-rest/docs/openapi/components.yaml b/cps-ncmp-rest/docs/openapi/components.yaml
index d35919da4..1f55ce199 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
diff --git a/cps-ncmp-rest/docs/openapi/ncmp.yml b/cps-ncmp-rest/docs/openapi/ncmp.yml
index 52245c3cc..9e3560a2f 100755
--- a/cps-ncmp-rest/docs/openapi/ncmp.yml
+++ b/cps-ncmp-rest/docs/openapi/ncmp.yml
@@ -283,4 +283,31 @@ fetchModuleReferencesByCmHandle:
       403:
         $ref: 'components.yaml#/components/responses/Forbidden'
       404:
-        $ref: 'components.yaml#/components/responses/NotFound'
\ No newline at end of file
+        $ref: 'components.yaml#/components/responses/NotFound'
+
+executeCmHandleSearch:
+  post:
+    description: Execute cm handle searches using 'hasAllModules' condition to get all cm handles for the given module names
+    tags:
+      - network-cm-proxy
+    summary: Execute cm handle search using the available conditions
+    operationId: executeCmHandleSearch
+    requestBody:
+      required: true
+      content:
+        application/json:
+          schema:
+            $ref: 'components.yaml#/components/schemas/Conditions'
+    responses:
+      200:
+        description: OK
+        content:
+          application/json:
+            schema:
+              $ref: 'components.yaml#/components/schemas/CmHandles'
+      400:
+        $ref: 'components.yaml#/components/responses/BadRequest'
+      401:
+        $ref: 'components.yaml#/components/responses/Unauthorized'
+      403:
+        $ref: 'components.yaml#/components/responses/Forbidden'
\ No newline at end of file
diff --git a/cps-ncmp-rest/docs/openapi/openapi.yml b/cps-ncmp-rest/docs/openapi/openapi.yml
index 69c2a117d..64a74c593 100755
--- a/cps-ncmp-rest/docs/openapi/openapi.yml
+++ b/cps-ncmp-rest/docs/openapi/openapi.yml
@@ -45,4 +45,7 @@ paths:
     $ref: 'ncmp.yml#/resourceDataForPassthroughRunning'
 
   /v1/ch/{cm-handle}/modules:
-    $ref: 'ncmp.yml#/fetchModuleReferencesByCmHandle'
\ No newline at end of file
+    $ref: 'ncmp.yml#/fetchModuleReferencesByCmHandle'
+
+  /v1/ch/searches:
+    $ref: 'ncmp.yml#/executeCmHandleSearch'
\ No newline at end of file
-- 
cgit 1.2.3-korg