summaryrefslogtreecommitdiffstats
path: root/cps-nf-proxy-rest/docs/openapi/xnfProxy.yml
diff options
context:
space:
mode:
authorHanif Kukkalli <lte-ng@outlook.com>2021-02-23 12:26:39 +0100
committerHanif Kukkalli <lte-ng@outlook.com>2021-02-26 11:23:28 +0000
commit83e318f8c7d3cacb24b2ef9b76162b0af12e817c (patch)
tree3a38e10ffcb878e6e61bdaeb2440d58b079467c5 /cps-nf-proxy-rest/docs/openapi/xnfProxy.yml
parent85aebca0339f9e619fa3a9fd537dc986fc7aa03a (diff)
Implement getDataNode(anchorName, xPath) in NF-Proxy
Added spring-boot-starter-validation instead of cps-ri. Added test 'Data node without leaves and without children.' to MultipartFileUtilSpec groovy test Created a method getNodeByCmHandleIdAndXpath(cmHandleId, cpsPath) Added hardcoded value of NFS DataspaceName as: "NFP-Operation". Issue-ID: CPS-172 Signed-off-by: Hanif Kukkalli <lte-ng@outlook.com> Change-Id: Ie8086ede01a9c5069b1ee75864b04a0ee5e8a4f6
Diffstat (limited to 'cps-nf-proxy-rest/docs/openapi/xnfProxy.yml')
-rw-r--r--cps-nf-proxy-rest/docs/openapi/xnfProxy.yml31
1 files changed, 12 insertions, 19 deletions
diff --git a/cps-nf-proxy-rest/docs/openapi/xnfProxy.yml b/cps-nf-proxy-rest/docs/openapi/xnfProxy.yml
index 0bb673ac3d..4abe81aff3 100644
--- 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,19 +18,7 @@ helloWorld:
$ref: 'components.yaml#/components/responses/Unauthorized'
403:
$ref: 'components.yaml#/components/responses/Forbidden'
-
-helloError:
- get:
- tags:
- - nf-proxy
- summary: error handler validation
- operationId: helloError
- 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' \ No newline at end of file
+ 404:
+ $ref: 'components.yaml#/components/responses/NotFound'
+ 501:
+ $ref: 'components.yaml#/components/responses/NotImplemented'