Support Delete operation for ds Passtrough-Running in NCMP 1/3

[cps.git] / cps-ncmp-rest / docs / openapi / ncmp.yml

diff --git a/cps-ncmp-rest/docs/openapi/ncmp.yml b/cps-ncmp-rest/docs/openapi/ncmp.yml
index 52245c3..673eb0b 100755 (executable)
--- a/cps-ncmp-rest/docs/openapi/ncmp.yml
+++ b/cps-ncmp-rest/docs/openapi/ncmp.yml
@@ -194,7 +194,14 @@ getResourceDataForPassthroughOperational:
       - $ref: 'components.yaml#/components/parameters/optionsParamInQuery'
     responses:
       200:
-        $ref: 'components.yaml#/components/responses/Ok'
+        description: OK
+        content:
+          application/json:
+            schema:
+              type: object
+            examples:
+              dataSampleResponse:
+                $ref: 'components.yaml#/components/examples/dataSampleResponse'
       400:
         $ref: 'components.yaml#/components/responses/BadRequest'
       401:
@@ -218,7 +225,14 @@ resourceDataForPassthroughRunning:
       - $ref: 'components.yaml#/components/parameters/optionsParamInQuery'
     responses:
       200:
-        $ref: 'components.yaml#/components/responses/Ok'
+        description: OK
+        content:
+          application/json:
+            schema:
+              type: object
+            examples:
+              dataSampleResponse:
+                $ref: 'components.yaml#/components/examples/dataSampleResponse'
       400:
         $ref: 'components.yaml#/components/responses/BadRequest'
       401:
@@ -243,6 +257,9 @@ resourceDataForPassthroughRunning:
         application/json:
           schema:
             type: string
+          examples:
+            dataSampleRequest:
+              $ref: 'components.yaml#/components/examples/dataSampleRequest'
         application/yang-data+json:
           schema:
             type: string
@@ -258,6 +275,97 @@ resourceDataForPassthroughRunning:
       404:
         $ref: 'components.yaml#/components/responses/NotFound'
 
+  put:
+    tags:
+      - network-cm-proxy
+    summary: Update resource data from pass-through running for a cm handle
+    description: Update resource data from pass-through running for the given cm handle
+    operationId: updateResourceDataRunningForCmHandle
+    parameters:
+      - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
+      - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
+      - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
+    requestBody:
+      required: true
+      content:
+        application/json:
+          schema:
+            type: string
+          examples:
+            dataSampleRequest:
+              $ref: 'components.yaml#/components/examples/dataSampleRequest'
+        application/yang-data+json:
+          schema:
+            type: string
+    responses:
+      200:
+        $ref: 'components.yaml#/components/responses/Ok'
+      400:
+        $ref: 'components.yaml#/components/responses/BadRequest'
+      401:
+        $ref: 'components.yaml#/components/responses/Unauthorized'
+      403:
+        $ref: 'components.yaml#/components/responses/Forbidden'
+      404:
+        $ref: 'components.yaml#/components/responses/NotFound'
+
+  patch:
+    tags:
+      - network-cm-proxy
+    summary: Patch resource data from pass-through running
+    description: Patch resource data from pass-through running for the given cm handle
+    operationId: patchResourceDataRunningForCmHandle
+    parameters:
+      - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
+      - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
+      - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
+    requestBody:
+      required: true
+      content:
+        application/json:
+          schema:
+            type: object
+    responses:
+      200:
+        $ref: 'components.yaml#/components/responses/Ok'
+      400:
+        $ref: 'components.yaml#/components/responses/BadRequest'
+      401:
+        $ref: 'components.yaml#/components/responses/Unauthorized'
+      403:
+        $ref: 'components.yaml#/components/responses/Forbidden'
+      404:
+        $ref: 'components.yaml#/components/responses/NotFound'
+
+  delete:
+    tags:
+      - network-cm-proxy
+    summary: Delete resource data
+    description: Delete resource data from pass-through running for a given cm handle
+    operationId: deleteResourceDataRunningForCmHandle
+    parameters:
+      - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
+      - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
+      - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
+    requestBody:
+      required: true
+      content:
+        application/json:
+          schema:
+            type: string
+    responses:
+      204:
+        $ref: 'components.yaml#/components/responses/NoContent'
+      400:
+        $ref: 'components.yaml#/components/responses/BadRequest'
+      401:
+        $ref: 'components.yaml#/components/responses/Unauthorized'
+      403:
+        $ref: 'components.yaml#/components/responses/Forbidden'
+      404:
+        $ref: 'components.yaml#/components/responses/NotFound'
+
+
 fetchModuleReferencesByCmHandle:
   get:
     description: fetch all module references (name and revision) for a given cm handle
@@ -273,9 +381,15 @@ fetchModuleReferencesByCmHandle:
         content:
           application/json:
             schema:
-              type: string
-            example: [{"moduleName": "nc-notifications", "revision": "2008-07-14"}]
-        $ref: 'components.yaml#/components/responses/Ok'
+              type: object
+            examples:
+              moduleReferencesResponse:
+                summary: Sample response
+                value:
+                  - moduleName: my-module-name
+                    revision: yyyy-mm-dd
+                  - moduleName: my-module-name-2
+                    revision: yyyy-mm-dd
       400:
         $ref: 'components.yaml#/components/responses/BadRequest'
       401:
@@ -283,4 +397,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