cps-rest/docs/api/swagger/components.yml

   1 components:
   2   schemas:
   3     ErrorMessage:
   4       type: object
   5       title: Error
   6       properties:
   7         status:
   8           type: string
   9           example: 400
  10         message:
  11           type: string
  12           example: Dataspace not found
  13         details:
  14           type: string
  15           example: Dataspace with name D1 does not exist.
  16
  17     MultipartFile:
  18       required:
  19         - file
  20       properties:
  21         multipartFile:
  22           type: string
  23           description: multipartFile
  24           format: binary
  25           example: http://example.com/examples/example.yang
  26
  27   parameters:
  28     dataspaceNameInQuery:
  29       name: dataspace-name
  30       in: query
  31       description: dataspace-name
  32       required: true
  33       schema:
  34         type: string
  35     dataspaceNameInPath:
  36       name: dataspace-name
  37       in: path
  38       description: dataspace-name
  39       required: true
  40       schema:
  41         type: string
  42     anchorNameInPath:
  43       name: anchor-name
  44       in: path
  45       description: anchor-name
  46       required: true
  47       schema:
  48         type: string
  49     schemaSetNameInQuery:
  50       name: schema-set-name
  51       in: query
  52       description: schema-set-name
  53       required: true
  54       schema:
  55         type: string
  56     schemaSetNameInPath:
  57       name: schema-set-name
  58       in: path
  59       description: schema-set-name
  60       required: true
  61       schema:
  62         type: string
  63     anchorNameInQuery:
  64       name: anchor-name
  65       in: query
  66       description: anchor-name
  67       required: true
  68       schema:
  69         type: string
  70     xpathInQuery:
  71       name: xpath
  72       in: query
  73       description: xpath
  74       required: false
  75       schema:
  76         type: string
  77         default: /
  78     requiredXpathInQuery:
  79       name: xpath
  80       in: query
  81       description: xpath
  82       required: true
  83       schema:
  84         type: string
  85     cpsPathInQuery:
  86       name: cps-path
  87       in: query
  88       description: cps-path
  89       required: false
  90       schema:
  91         type: string
  92         default: /
  93     includeDescendantsOptionInQuery:
  94       name: include-descendants
  95       in: query
  96       description: include-descendants
  97       required: false
  98       schema:
  99         type: boolean
 100         default: false
 101
 102   responses:
 103     NotFound:
 104       description: The specified resource was not found
 105       content:
 106         application/json:
 107           schema:
 108             $ref: '#/components/schemas/ErrorMessage'
 109     Unauthorized:
 110       description: Unauthorized
 111       content:
 112         application/json:
 113           schema:
 114             $ref: '#/components/schemas/ErrorMessage'
 115     Forbidden:
 116       description: Forbidden
 117       content:
 118         application/json:
 119           schema:
 120             $ref: '#/components/schemas/ErrorMessage'
 121     BadRequest:
 122       description: Bad Request
 123       content:
 124         application/json:
 125           schema:
 126             $ref: '#/components/schemas/ErrorMessage'
 127     Conflict:
 128       description: Conflict
 129       content:
 130         application/json:
 131           schema:
 132             $ref: '#/components/schemas/ErrorMessage'
 133     Ok:
 134       description: OK
 135       content:
 136         application/json:
 137           schema:
 138             type: object
 139     Created:
 140       description: Created
 141       content:
 142         text/plain:
 143           schema:
 144             type: string
 145     NoContent:
 146       description: No Content
 147       content: {}