CPS-240 - Create REST End-point on NF-Proxy for DataNode Update & cpsPath Query

[cps.git] / cps-nf-proxy-rest / docs / openapi / xnfProxy.yml

diff --git a/cps-nf-proxy-rest/docs/openapi/xnfProxy.yml b/cps-nf-proxy-rest/docs/openapi/xnfProxy.yml
index 0bb673a..c39d2df 100644 (file)
--- a/cps-nf-proxy-rest/docs/openapi/xnfProxy.yml
+++ b/cps-nf-proxy-rest/docs/openapi/xnfProxy.yml
@@ -1,9 +1,14 @@
-helloWorld:
+nodeByCmHandleAndXpath:
   get:
+    description: Get a node with an option to retrieve all the children for a given cm Handle
     tags:
       - nf-proxy
-    summary: rest interface validation
-    operationId: helloWorld
+    summary: Get a node given a cm Handle and xpath
+    operationId: getNodeByCmHandleAndXpath
+    parameters:
+      - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
+      - $ref: 'components.yaml#/components/parameters/xpathInQuery'
+      - $ref: 'components.yaml#/components/parameters/includeDescendantsOptionInQuery'
     responses:
       200:
         $ref: 'components.yaml#/components/responses/Ok'
@@ -13,13 +18,21 @@ helloWorld:
         $ref: 'components.yaml#/components/responses/Unauthorized'
       403:
         $ref: 'components.yaml#/components/responses/Forbidden'
+      404:
+        $ref: 'components.yaml#/components/responses/NotFound'
+      501:
+        $ref: 'components.yaml#/components/responses/NotImplemented'
 
-helloError:
+nodesByCmHandleAndCpsPath:
   get:
+    description: Query nodes for the given cps path and cm Handle
     tags:
       - nf-proxy
-    summary: error handler validation
-    operationId: helloError
+    summary: Query data nodes
+    operationId: queryNodesByCmHandleAndCpsPath
+    parameters:
+      - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
+      - $ref: 'components.yaml#/components/parameters/cpsPathInQuery'
     responses:
       200:
         $ref: 'components.yaml#/components/responses/Ok'
@@ -28,4 +41,61 @@ helloError:
       401:
         $ref: 'components.yaml#/components/responses/Unauthorized'
       403:
-        $ref: 'components.yaml#/components/responses/Forbidden'
\ No newline at end of file
+        $ref: 'components.yaml#/components/responses/Forbidden'
+      404:
+        $ref: 'components.yaml#/components/responses/NotFound'
+
+nodesByCmHandleAndXpath:
+  patch:
+    description: Update node leaves for the given cps path and cm Handle
+    tags:
+      - nf-proxy
+    summary: Update node leaves
+    operationId: updateNodeLeaves
+    parameters:
+      - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
+      - $ref: 'components.yaml#/components/parameters/xpathInQuery'
+    requestBody:
+      required: true
+      content:
+        application/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'
+
+  put:
+    description: Replace a node with descendants for the given cps path and cm Handle
+    tags:
+      - nf-proxy
+    summary: Replace a node with descendants
+    operationId: replaceNode
+    parameters:
+      - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
+      - $ref: 'components.yaml#/components/parameters/xpathInQuery'
+    requestBody:
+      required: true
+      content:
+        application/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'
\ No newline at end of file