Merge 2 'query' end points in NCMP
[cps.git] / cps-ncmp-rest / docs / openapi / ncmp.yml
index 318e6e6..7a894f5 100755 (executable)
@@ -246,26 +246,28 @@ fetchModuleReferencesByCmHandle:
       500:
         $ref: 'components.yaml#/components/responses/InternalServerError'
 
-executeCmHandleSearch:
+searchCmHandles:
   post:
-    description: Execute cm handle searches using 'hasAllModules' condition to get all cm handles for the given module names
+    description: Execute cm handle query search, to be included in the result a cm-handle must fulfill ALL the conditions listed here
     tags:
       - network-cm-proxy
     summary: Execute cm handle search using the available conditions
-    operationId: executeCmHandleSearch
+    operationId: searchCmHandles
     requestBody:
       required: true
       content:
         application/json:
           schema:
-            $ref: 'components.yaml#/components/schemas/Conditions'
+            $ref: 'components.yaml#/components/schemas/CmHandleQueryParameters'
     responses:
       200:
         description: OK
         content:
           application/json:
             schema:
-              $ref: 'components.yaml#/components/schemas/CmHandles'
+              type: array
+              items:
+                $ref: 'components.yaml#/components/schemas/RestOutputCmHandle'
       400:
         $ref: 'components.yaml#/components/responses/BadRequest'
       401:
@@ -317,19 +319,19 @@ getCmHandlePropertiesById:
       500:
         $ref: 'components.yaml#/components/responses/InternalServerError'
 
-queryCmHandles:
+searchCmHandleIds:
   post:
-    description: Execute cm handle query search
+    description: Execute cm handle query search, to be included in the result a cm-handle must fulfill ALL the conditions listed here
     tags:
       - network-cm-proxy
     summary: Execute cm handle query upon a given set of query parameters
-    operationId: queryCmHandles
+    operationId: searchCmHandleIds
     requestBody:
       required: true
       content:
         application/json:
           schema:
-            $ref: 'components.yaml#/components/schemas/CmHandleQueryRestParameters'
+            $ref: 'components.yaml#/components/schemas/CmHandleQueryParameters'
     responses:
       200:
         description: OK