diff options
Diffstat (limited to 'cps-ncmp-rest/docs')
| -rw-r--r-- | cps-ncmp-rest/docs/openapi/components.yaml | 8 | ||||
| -rwxr-xr-x | cps-ncmp-rest/docs/openapi/ncmproxy.yml | 28 | ||||
| -rwxr-xr-x | cps-ncmp-rest/docs/openapi/openapi.yml | 4 |
3 files changed, 40 insertions, 0 deletions
diff --git a/cps-ncmp-rest/docs/openapi/components.yaml b/cps-ncmp-rest/docs/openapi/components.yaml index 69c37ad7a7..5ff30994f9 100644 --- a/cps-ncmp-rest/docs/openapi/components.yaml +++ b/cps-ncmp-rest/docs/openapi/components.yaml @@ -1,5 +1,6 @@ # ============LICENSE_START======================================================= # Modification (C) 2021 Nordix Foundation +# Modifications Copyright (C) 2021 Pantheon.tech # ================================================================================ # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -52,6 +53,13 @@ components: schema: type: string default: / + requiredXpathInQuery: + name: xpath + in: query + description: xpath + required: true + schema: + type: string includeDescendantsOptionInQuery: name: include-descendants in: query diff --git a/cps-ncmp-rest/docs/openapi/ncmproxy.yml b/cps-ncmp-rest/docs/openapi/ncmproxy.yml index d5358cc5d4..00e0cc78f8 100755 --- a/cps-ncmp-rest/docs/openapi/ncmproxy.yml +++ b/cps-ncmp-rest/docs/openapi/ncmproxy.yml @@ -142,4 +142,32 @@ nodesByCmHandleAndXpath: 403: $ref: 'components.yaml#/components/responses/Forbidden' 404: + $ref: 'components.yaml#/components/responses/NotFound' + +listNodeByCmHandleAndXpath: + post: + description: Add one or more list-node child elements under existing node for the given CM Handle + tags: + - network-cm-proxy + summary: Add list-node child element(s) + operationId: addListNodeElements + parameters: + - $ref: 'components.yaml#/components/parameters/cmHandleInPath' + - $ref: 'components.yaml#/components/parameters/requiredXpathInQuery' + requestBody: + required: true + content: + application/json: + schema: + type: string + responses: + 201: + $ref: 'components.yaml#/components/responses/Created' + 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 index 7575022f83..862837ea28 100755 --- a/cps-ncmp-rest/docs/openapi/openapi.yml +++ b/cps-ncmp-rest/docs/openapi/openapi.yml @@ -1,5 +1,6 @@ # ============LICENSE_START======================================================= # Modification (C) 2021 Nordix Foundation +# Modifications Copyright (C) 2021 Pantheon.tech # ================================================================================ # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -26,6 +27,9 @@ paths: /v1/cm-handles/{cm-handle}/node: $ref: 'ncmproxy.yml#/nodeByCmHandleAndXpath' + /v1/cm-handles/{cm-handle}/list-node: + $ref: 'ncmproxy.yml#/listNodeByCmHandleAndXpath' + /v1/cm-handles/{cm-handle}/nodes/query: $ref: 'ncmproxy.yml#/nodesByCmHandleAndCpsPath' |