summaryrefslogtreecommitdiffstats
path: root/cps-nf-proxy-rest/docs/openapi/components.yaml
diff options
context:
space:
mode:
Diffstat (limited to 'cps-nf-proxy-rest/docs/openapi/components.yaml')
-rw-r--r--cps-nf-proxy-rest/docs/openapi/components.yaml30
1 files changed, 29 insertions, 1 deletions
diff --git a/cps-nf-proxy-rest/docs/openapi/components.yaml b/cps-nf-proxy-rest/docs/openapi/components.yaml
index 5352199834..0b5d52a3ab 100644
--- a/cps-nf-proxy-rest/docs/openapi/components.yaml
+++ b/cps-nf-proxy-rest/docs/openapi/components.yaml
@@ -20,7 +20,29 @@ components:
format: binary
parameters:
-
+ cmHandleInPath:
+ name: cm-handle
+ in: path
+ description: The identifier for a network function, network element, subnetwork or any other cm object by managed NF-Proxy
+ required: true
+ schema:
+ type: string
+ xpathInQuery:
+ name: xpath
+ in: query
+ description: xpath
+ required: false
+ schema:
+ type: string
+ default: /
+ includeDescendantsOptionInQuery:
+ name: include-descendants
+ in: query
+ description: include-descendants
+ required: false
+ schema:
+ type: boolean
+ default: false
responses:
NotFound:
@@ -53,6 +75,12 @@ components:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
+ NotImplemented:
+ description: The given path has not been implemented
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorMessage'
Ok:
description: OK
content: