aboutsummaryrefslogtreecommitdiffstats
path: root/cps-ncmp-rest/docs/openapi
diff options
context:
space:
mode:
authortragait <rahul.tyagi@est.tech>2021-03-30 12:02:27 +0100
committertragait <rahul.tyagi@est.tech>2021-04-06 10:06:04 +0100
commit34a94b92edd0c359291445735eb3d7e974deea1f (patch)
tree2720fef43a9edcd23ca6349136c017773af05680 /cps-ncmp-rest/docs/openapi
parent2b0b0368cf6c62f8c05ed8a98a701e1102427861 (diff)
rename nf-proxy to network-cm-proxy
This commit renames two modules cps-nf-proxy-rest and cps-nf-proxy-service to cps-ncmp-rest, cps-ncmp-service. Docker image names are also changed respectively. Swagger auto generated api files are also modified. Signed-off-by: tragait <rahul.tyagi@est.tech> Issue-ID: CPS-315 Change-Id: Ic2a2f8c4bafe8cffa3c83ccb52499720aaba1415
Diffstat (limited to 'cps-ncmp-rest/docs/openapi')
-rw-r--r--cps-ncmp-rest/docs/openapi/components.yaml124
-rw-r--r--cps-ncmp-rest/docs/openapi/ncmproxy.yml119
-rwxr-xr-xcps-ncmp-rest/docs/openapi/openapi.yml33
3 files changed, 276 insertions, 0 deletions
diff --git a/cps-ncmp-rest/docs/openapi/components.yaml b/cps-ncmp-rest/docs/openapi/components.yaml
new file mode 100644
index 000000000..69c37ad7a
--- /dev/null
+++ b/cps-ncmp-rest/docs/openapi/components.yaml
@@ -0,0 +1,124 @@
+# ============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=========================================================
+
+components:
+ schemas:
+ ErrorMessage:
+ type: object
+ title: Error
+ properties:
+ status:
+ type: string
+ message:
+ type: string
+ details:
+ type: string
+ MultipartFile:
+ required:
+ - file
+ properties:
+ multipartFile:
+ type: string
+ description: multipartFile
+ 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 Network CM 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
+ cpsPathInQuery:
+ name: cps-path
+ in: query
+ description: cps-path
+ required: false
+ schema:
+ type: string
+ default: /
+
+
+ responses:
+ NotFound:
+ description: The specified resource was not found
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorMessage'
+ Unauthorized:
+ description: Unauthorized
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorMessage'
+ Forbidden:
+ description: Forbidden
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorMessage'
+ BadRequest:
+ description: Bad Request
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorMessage'
+ Conflict:
+ description: Conflict
+ content:
+ 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:
+ application/json:
+ schema:
+ type: object
+ Created:
+ description: Created
+ content:
+ text/plain:
+ schema:
+ type: string
+ NoContent:
+ description: No Content
+ content: {}
diff --git a/cps-ncmp-rest/docs/openapi/ncmproxy.yml b/cps-ncmp-rest/docs/openapi/ncmproxy.yml
new file mode 100644
index 000000000..2a70d70a6
--- /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
diff --git a/cps-ncmp-rest/docs/openapi/openapi.yml b/cps-ncmp-rest/docs/openapi/openapi.yml
new file mode 100755
index 000000000..7575022f8
--- /dev/null
+++ b/cps-ncmp-rest/docs/openapi/openapi.yml
@@ -0,0 +1,33 @@
+# ============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=========================================================
+
+openapi: 3.0.1
+info:
+ title: NCMP to CPS Proxy API
+ description: NCMP to CPS Proxy API
+ version: "1.0"
+servers:
+ - url: //localhost:8088/
+paths:
+ /v1/cm-handles/{cm-handle}/node:
+ $ref: 'ncmproxy.yml#/nodeByCmHandleAndXpath'
+
+ /v1/cm-handles/{cm-handle}/nodes/query:
+ $ref: 'ncmproxy.yml#/nodesByCmHandleAndCpsPath'
+
+ /v1/cm-handles/{cm-handle}/nodes:
+ $ref: 'ncmproxy.yml#/nodesByCmHandleAndXpath' \ No newline at end of file