summaryrefslogtreecommitdiffstats
path: root/cps-nf-proxy-rest/docs
diff options
context:
space:
mode:
authorniamhcore <niamh.core@est.tech>2021-02-26 10:13:48 +0000
committerniamhcore <niamh.core@est.tech>2021-02-26 17:21:02 +0000
commitb5d573b02c7d1376e92e59887371965a2fb43c25 (patch)
tree366dd39ab6391c1dc5adbfd684eee943d65b6e6a /cps-nf-proxy-rest/docs
parentd3609db46635b9bdb0a49a7d0e18ebe144bb7f29 (diff)
CPS-240 - Create REST End-point on NF-Proxy for DataNode Update & cpsPath Query
Issue-ID: CPS-240 Signed-off-by: niamhcore <niamh.core@est.tech> Change-Id: I2aed92f8ab34282b12e23ae7807a391446165eb0
Diffstat (limited to 'cps-nf-proxy-rest/docs')
-rw-r--r--cps-nf-proxy-rest/docs/openapi/components.yaml9
-rwxr-xr-xcps-nf-proxy-rest/docs/openapi/openapi.yml5
-rw-r--r--cps-nf-proxy-rest/docs/openapi/xnfProxy.yml77
3 files changed, 91 insertions, 0 deletions
diff --git a/cps-nf-proxy-rest/docs/openapi/components.yaml b/cps-nf-proxy-rest/docs/openapi/components.yaml
index 0b5d52a3ab..af95723cb7 100644
--- a/cps-nf-proxy-rest/docs/openapi/components.yaml
+++ b/cps-nf-proxy-rest/docs/openapi/components.yaml
@@ -43,6 +43,15 @@ components:
schema:
type: boolean
default: false
+ cpsPathInQuery:
+ name: cps-path
+ in: query
+ description: cps-path
+ required: false
+ schema:
+ type: string
+ default: /
+
responses:
NotFound:
diff --git a/cps-nf-proxy-rest/docs/openapi/openapi.yml b/cps-nf-proxy-rest/docs/openapi/openapi.yml
index efa8e7253e..a6d0949f23 100755
--- a/cps-nf-proxy-rest/docs/openapi/openapi.yml
+++ b/cps-nf-proxy-rest/docs/openapi/openapi.yml
@@ -9,3 +9,8 @@ paths:
/v1/cm-handles/{cm-handle}/node:
$ref: 'xnfProxy.yml#/nodeByCmHandleAndXpath'
+ /v1/cm-handles/{cm-handle}/nodes/query:
+ $ref: 'xnfProxy.yml#/nodesByCmHandleAndCpsPath'
+
+ /v1/cm-handles/{cm-handle}/nodes:
+ $ref: 'xnfProxy.yml#/nodesByCmHandleAndXpath' \ No newline at end of file
diff --git a/cps-nf-proxy-rest/docs/openapi/xnfProxy.yml b/cps-nf-proxy-rest/docs/openapi/xnfProxy.yml
index 4abe81aff3..c39d2dff02 100644
--- a/cps-nf-proxy-rest/docs/openapi/xnfProxy.yml
+++ b/cps-nf-proxy-rest/docs/openapi/xnfProxy.yml
@@ -22,3 +22,80 @@ nodeByCmHandleAndXpath:
$ref: 'components.yaml#/components/responses/NotFound'
501:
$ref: 'components.yaml#/components/responses/NotImplemented'
+
+nodesByCmHandleAndCpsPath:
+ get:
+ description: Query nodes for the given cps path and cm Handle
+ tags:
+ - nf-proxy
+ 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'
+ 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'
+
+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