cps-ncmp-rest/docs/openapi/components.yaml

   1 #  ============LICENSE_START=======================================================
   2 #  Modification (C) 2021 Nordix Foundation
   3 #  Modifications Copyright (C) 2021 Pantheon.tech
   4 #  ================================================================================
   5 #  Licensed under the Apache License, Version 2.0 (the "License");
   6 #  you may not use this file except in compliance with the License.
   7 #  You may obtain a copy of the License at
   8 #
   9 #        http://www.apache.org/licenses/LICENSE-2.0
  10 #  Unless required by applicable law or agreed to in writing, software
  11 #  distributed under the License is distributed on an "AS IS" BASIS,
  12 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 #  See the License for the specific language governing permissions and
  14 #  limitations under the License.
  15 #
  16 #  SPDX-License-Identifier: Apache-2.0
  17 #  ============LICENSE_END=========================================================
  18
  19 components:
  20   schemas:
  21     ErrorMessage:
  22       type: object
  23       title: Error
  24       properties:
  25         status:
  26           type: string
  27         message:
  28           type: string
  29         details:
  30           type: string
  31     MultipartFile:
  32       required:
  33         - file
  34       properties:
  35         multipartFile:
  36           type: string
  37           description: multipartFile
  38           format: binary
  39
  40   parameters:
  41     cmHandleInPath:
  42       name: cm-handle
  43       in: path
  44       description: The identifier for a network function, network element, subnetwork or any other cm object by managed Network CM Proxy
  45       required: true
  46       schema:
  47         type: string
  48     xpathInQuery:
  49       name: xpath
  50       in: query
  51       description: xpath
  52       required: false
  53       schema:
  54         type: string
  55         default: /
  56     requiredXpathInQuery:
  57       name: xpath
  58       in: query
  59       description: xpath
  60       required: true
  61       schema:
  62         type: string
  63     includeDescendantsOptionInQuery:
  64       name: include-descendants
  65       in: query
  66       description: include-descendants
  67       required: false
  68       schema:
  69         type: boolean
  70         default: false
  71     cpsPathInQuery:
  72       name: cps-path
  73       in: query
  74       description: cps-path
  75       required: false
  76       schema:
  77         type: string
  78         default: /
  79
  80
  81   responses:
  82     NotFound:
  83       description: The specified resource was not found
  84       content:
  85         application/json:
  86           schema:
  87             $ref: '#/components/schemas/ErrorMessage'
  88     Unauthorized:
  89       description: Unauthorized
  90       content:
  91         application/json:
  92           schema:
  93             $ref: '#/components/schemas/ErrorMessage'
  94     Forbidden:
  95       description: Forbidden
  96       content:
  97         application/json:
  98           schema:
  99             $ref: '#/components/schemas/ErrorMessage'
 100     BadRequest:
 101       description: Bad Request
 102       content:
 103         application/json:
 104           schema:
 105             $ref: '#/components/schemas/ErrorMessage'
 106     Conflict:
 107       description: Conflict
 108       content:
 109         application/json:
 110           schema:
 111             $ref: '#/components/schemas/ErrorMessage'
 112     NotImplemented:
 113       description: The given path has not been implemented
 114       content:
 115         application/json:
 116           schema:
 117             $ref: '#/components/schemas/ErrorMessage'
 118     Ok:
 119       description: OK
 120       content:
 121         application/json:
 122           schema:
 123             type: object
 124     Created:
 125       description: Created
 126       content:
 127         text/plain:
 128           schema:
 129             type: string
 130     NoContent:
 131       description: No Content
 132       content: {}