diff options
Diffstat (limited to 'cps-nf-proxy-rest/docs')
| -rw-r--r-- | cps-nf-proxy-rest/docs/openapi/components.yaml | 30 | ||||
| -rwxr-xr-x | cps-nf-proxy-rest/docs/openapi/openapi.yml | 6 | ||||
| -rw-r--r-- | cps-nf-proxy-rest/docs/openapi/xnfProxy.yml | 31 |
3 files changed, 43 insertions, 24 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: diff --git a/cps-nf-proxy-rest/docs/openapi/openapi.yml b/cps-nf-proxy-rest/docs/openapi/openapi.yml index 0dbab34eef..efa8e7253e 100755 --- a/cps-nf-proxy-rest/docs/openapi/openapi.yml +++ b/cps-nf-proxy-rest/docs/openapi/openapi.yml @@ -6,8 +6,6 @@ info: servers: - url: //localhost:8088/ paths: - /v1/hello-world: - $ref: 'xnfProxy.yml#/helloWorld' - /v1/hello-error: - $ref: 'xnfProxy.yml#/helloError' + /v1/cm-handles/{cm-handle}/node: + $ref: 'xnfProxy.yml#/nodeByCmHandleAndXpath' 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' |