diff options
author | tragait <rahul.tyagi@est.tech> | 2021-03-30 12:02:27 +0100 |
---|---|---|
committer | tragait <rahul.tyagi@est.tech> | 2021-04-06 10:06:04 +0100 |
commit | 34a94b92edd0c359291445735eb3d7e974deea1f (patch) | |
tree | 2720fef43a9edcd23ca6349136c017773af05680 /cps-ncmp-rest/docs/openapi/components.yaml | |
parent | 2b0b0368cf6c62f8c05ed8a98a701e1102427861 (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/components.yaml')
-rw-r--r-- | cps-ncmp-rest/docs/openapi/components.yaml | 124 |
1 files changed, 124 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 0000000000..69c37ad7a7 --- /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: {} |