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

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