summaryrefslogtreecommitdiffstats
path: root/cps-nf-proxy-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-nf-proxy-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-nf-proxy-rest/docs/openapi')
-rw-r--r--cps-nf-proxy-rest/docs/openapi/components.yaml107
-rwxr-xr-xcps-nf-proxy-rest/docs/openapi/openapi.yml16
-rw-r--r--cps-nf-proxy-rest/docs/openapi/xnfProxy.yml102
3 files changed, 0 insertions, 225 deletions
diff --git a/cps-nf-proxy-rest/docs/openapi/components.yaml b/cps-nf-proxy-rest/docs/openapi/components.yaml
deleted file mode 100644
index af95723cb7..0000000000
--- a/cps-nf-proxy-rest/docs/openapi/components.yaml
+++ /dev/null
@@ -1,107 +0,0 @@
-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 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
- 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-nf-proxy-rest/docs/openapi/openapi.yml b/cps-nf-proxy-rest/docs/openapi/openapi.yml
deleted file mode 100755
index a6d0949f23..0000000000
--- a/cps-nf-proxy-rest/docs/openapi/openapi.yml
+++ /dev/null
@@ -1,16 +0,0 @@
-openapi: 3.0.1
-info:
- title: xNF to CPS Proxy API
- description: xNF to CPS Proxy API
- version: "1.0"
-servers:
- - url: //localhost:8088/
-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
deleted file mode 100644
index 141e472582..0000000000
--- a/cps-nf-proxy-rest/docs/openapi/xnfProxy.yml
+++ /dev/null
@@ -1,102 +0,0 @@
-nodeByCmHandleAndXpath:
- get:
- description: Get a node with an option to retrieve all the children for a given cm Handle
- tags:
- - nf-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:
- - nf-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:
- - 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