summaryrefslogtreecommitdiffstats
path: root/cps-ncmp-rest/docs/openapi/ncmproxy.yml
diff options
context:
space:
mode:
Diffstat (limited to 'cps-ncmp-rest/docs/openapi/ncmproxy.yml')
-rw-r--r--cps-ncmp-rest/docs/openapi/ncmproxy.yml119
1 files changed, 119 insertions, 0 deletions
diff --git a/cps-ncmp-rest/docs/openapi/ncmproxy.yml b/cps-ncmp-rest/docs/openapi/ncmproxy.yml
new file mode 100644
index 0000000000..2a70d70a6d
--- /dev/null
+++ b/cps-ncmp-rest/docs/openapi/ncmproxy.yml
@@ -0,0 +1,119 @@
+# ============LICENSE_START=======================================================
+# Modification (C) 2021 Nordix Foundation
+# ================================================================================
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# ============LICENSE_END=========================================================
+
+nodeByCmHandleAndXpath:
+ get:
+ description: Get a node with an option to retrieve all the children for a given cm Handle
+ tags:
+ - network-cm-proxy
+ 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'
+ 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'
+ 501:
+ $ref: 'components.yaml#/components/responses/NotImplemented'
+
+nodesByCmHandleAndCpsPath:
+ get:
+ description: Query nodes for the given cps path and cm Handle
+ tags:
+ - network-cm-proxy
+ summary: Query data nodes
+ operationId: queryNodesByCmHandleAndCpsPath
+ parameters:
+ - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
+ - $ref: 'components.yaml#/components/parameters/cpsPathInQuery'
+ - $ref: 'components.yaml#/components/parameters/includeDescendantsOptionInQuery'
+ 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:
+ - network-cm-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:
+ - network-cm-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