cps-rest/docs/openapi/cpsAdmin.yml

   1 # ============LICENSE_START=======================================================
   2 # Copyright (c) 2021 Bell Canada.
   3 # Modifications Copyright (C) 2021-2022 Nordix Foundation
   4 # Modifications Copyright (C) 2022 TechMahindra Ltd.
   5 # ================================================================================
   6 # Licensed under the Apache License, Version 2.0 (the "License");
   7 # you may not use this file except in compliance with the License.
   8 # You may obtain a copy of the License at
   9 #
  10 #       http://www.apache.org/licenses/LICENSE-2.0
  11 #
  12 # Unless required by applicable law or agreed to in writing, software
  13 # distributed under the License is distributed on an "AS IS" BASIS,
  14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15 # See the License for the specific language governing permissions and
  16 # limitations under the License.
  17 #
  18 # SPDX-License-Identifier: Apache-2.0
  19 # ============LICENSE_END=========================================================
  20
  21 dataspaces:
  22   post:
  23     description: Create a new dataspace
  24     tags:
  25       - cps-admin
  26     summary: Create a dataspace
  27     operationId: createDataspace
  28     parameters:
  29       - $ref: 'components.yml#/components/parameters/dataspaceNameInQuery'
  30     responses:
  31       '201':
  32         $ref: 'components.yml#/components/responses/Created'
  33       '400':
  34         $ref: 'components.yml#/components/responses/BadRequest'
  35       '401':
  36         $ref: 'components.yml#/components/responses/Unauthorized'
  37       '403':
  38         $ref: 'components.yml#/components/responses/Forbidden'
  39       '409':
  40         $ref: 'components.yml#/components/responses/Conflict'
  41       '500':
  42         $ref: 'components.yml#/components/responses/InternalServerError'
  43   delete:
  44     description: Delete a dataspace
  45     tags:
  46       - cps-admin
  47     summary: Delete a dataspace
  48     operationId: deleteDataspace
  49     parameters:
  50       - $ref: 'components.yml#/components/parameters/dataspaceNameInQuery'
  51     responses:
  52       '204':
  53         $ref: 'components.yml#/components/responses/NoContent'
  54       '400':
  55         $ref: 'components.yml#/components/responses/BadRequest'
  56       '401':
  57         $ref: 'components.yml#/components/responses/Unauthorized'
  58       '403':
  59         $ref: 'components.yml#/components/responses/Forbidden'
  60       '409':
  61         $ref: 'components.yml#/components/responses/Conflict'
  62       '500':
  63         $ref: 'components.yml#/components/responses/InternalServerError'
  64
  65 schemaSet:
  66   post:
  67     description: Create a new schema set in the given dataspace
  68     tags:
  69       - cps-admin
  70     summary: Create a schema set
  71     operationId: createSchemaSet
  72     parameters:
  73       - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
  74       - $ref: 'components.yml#/components/parameters/schemaSetNameInQuery'
  75     requestBody:
  76       required: true
  77       content:
  78         multipart/form-data:
  79           schema:
  80             $ref: 'components.yml#/components/schemas/MultipartFile'
  81     responses:
  82       '201':
  83         $ref: 'components.yml#/components/responses/Created'
  84       '400':
  85         $ref: 'components.yml#/components/responses/BadRequest'
  86       '401':
  87         $ref: 'components.yml#/components/responses/Unauthorized'
  88       '403':
  89         $ref: 'components.yml#/components/responses/Forbidden'
  90       '409':
  91         $ref: 'components.yml#/components/responses/Conflict'
  92       '500':
  93         $ref: 'components.yml#/components/responses/InternalServerError'
  94
  95 schemaSetBySchemaSetName:
  96   get:
  97     description: Read a schema set given a schema set name and a dataspace
  98     tags:
  99       - cps-admin
 100     summary: Get a schema set
 101     operationId: getSchemaSet
 102     parameters:
 103       - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
 104       - $ref: 'components.yml#/components/parameters/schemaSetNameInPath'
 105     responses:
 106       '200':
 107         description: OK
 108         content:
 109           application/json:
 110             schema:
 111               $ref: 'components.yml#/components/schemas/SchemaSetDetails'
 112       '400':
 113         $ref: 'components.yml#/components/responses/BadRequest'
 114       '401':
 115         $ref: 'components.yml#/components/responses/Unauthorized'
 116       '403':
 117         $ref: 'components.yml#/components/responses/Forbidden'
 118       '500':
 119         $ref: 'components.yml#/components/responses/InternalServerError'
 120   delete:
 121     description: Delete a schema set given a schema set name and a dataspace
 122     tags:
 123       - cps-admin
 124     summary: Delete a schema set
 125     operationId: deleteSchemaSet
 126     parameters:
 127       - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
 128       - $ref: 'components.yml#/components/parameters/schemaSetNameInPath'
 129     responses:
 130       '204':
 131         $ref: 'components.yml#/components/responses/NoContent'
 132       '400':
 133         $ref: 'components.yml#/components/responses/BadRequest'
 134       '401':
 135         $ref: 'components.yml#/components/responses/Unauthorized'
 136       '403':
 137         $ref: 'components.yml#/components/responses/Forbidden'
 138       '409':
 139         $ref: 'components.yml#/components/responses/Conflict'
 140       '500':
 141         $ref: 'components.yml#/components/responses/InternalServerError'
 142
 143 anchorsByDataspace:
 144   get:
 145     description: Read all anchors, given a dataspace
 146     tags:
 147       - cps-admin
 148     summary: Get anchors
 149     operationId: getAnchors
 150     parameters:
 151       - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
 152     responses:
 153       '200':
 154         description: OK
 155         content:
 156           application/json:
 157             schema:
 158               type: array
 159               items:
 160                 $ref: 'components.yml#/components/schemas/AnchorDetails'
 161       '400':
 162         $ref: 'components.yml#/components/responses/BadRequest'
 163       '401':
 164         $ref: 'components.yml#/components/responses/Unauthorized'
 165       '403':
 166         $ref: 'components.yml#/components/responses/Forbidden'
 167       '500':
 168         $ref: 'components.yml#/components/responses/InternalServerError'
 169   post:
 170     description: Create a new anchor in the given dataspace
 171     tags:
 172       - cps-admin
 173     summary: Create an anchor
 174     operationId: createAnchor
 175     parameters:
 176       - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
 177       - $ref: 'components.yml#/components/parameters/schemaSetNameInQuery'
 178       - $ref: 'components.yml#/components/parameters/anchorNameInQuery'
 179     responses:
 180       '201':
 181         $ref: 'components.yml#/components/responses/Created'
 182       '400':
 183         $ref: 'components.yml#/components/responses/BadRequest'
 184       '401':
 185         $ref: 'components.yml#/components/responses/Unauthorized'
 186       '403':
 187         $ref: 'components.yml#/components/responses/Forbidden'
 188       '409':
 189         $ref: 'components.yml#/components/responses/Conflict'
 190       '500':
 191         $ref: 'components.yml#/components/responses/InternalServerError'
 192
 193 anchorByDataspaceAndAnchorName:
 194   get:
 195     description: Read an anchor given an anchor name and a dataspace
 196     tags:
 197       - cps-admin
 198     summary: Get an anchor
 199     operationId: getAnchor
 200     parameters:
 201       - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
 202       - $ref: 'components.yml#/components/parameters/anchorNameInPath'
 203     responses:
 204       '200':
 205         description: OK
 206         content:
 207           application/json:
 208             schema:
 209               $ref: 'components.yml#/components/schemas/AnchorDetails'
 210       '400':
 211         $ref: 'components.yml#/components/responses/BadRequest'
 212       '401':
 213         $ref: 'components.yml#/components/responses/Unauthorized'
 214       '403':
 215         $ref: 'components.yml#/components/responses/Forbidden'
 216       '500':
 217         $ref: 'components.yml#/components/responses/InternalServerError'
 218   delete:
 219     description: Delete an anchor given an anchor name and a dataspace
 220     tags:
 221       - cps-admin
 222     summary: Delete an anchor
 223     operationId: deleteAnchor
 224     parameters:
 225       - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
 226       - $ref: 'components.yml#/components/parameters/anchorNameInPath'
 227     responses:
 228       '204':
 229         $ref: 'components.yml#/components/responses/NoContent'
 230       '400':
 231         $ref: 'components.yml#/components/responses/BadRequest'
 232       '401':
 233         $ref: 'components.yml#/components/responses/Unauthorized'
 234       '403':
 235         $ref: 'components.yml#/components/responses/Forbidden'
 236       '500':
 237         $ref: 'components.yml#/components/responses/InternalServerError'
 238
 239 adminDataspaces:
 240  get:
 241    description: Read all dataspaces
 242    tags:
 243      - cps-admin
 244    summary: Get all dataspaces
 245    operationId: getAllDataspaces
 246    responses:
 247      '200':
 248        description: OK
 249        content:
 250          application/json:
 251            schema:
 252              type: array
 253              items:
 254                $ref: 'components.yml#/components/schemas/DataspaceDetails'
 255      '400':
 256        $ref: 'components.yml#/components/responses/BadRequest'
 257      '401':
 258        $ref: 'components.yml#/components/responses/Unauthorized'
 259      '403':
 260        $ref: 'components.yml#/components/responses/Forbidden'
 261      '500':
 262        $ref: 'components.yml#/components/responses/InternalServerError'
 263
 264 adminDataspace:
 265  get:
 266    description: Read a dataspace given a dataspace name
 267    tags:
 268      - cps-admin
 269    summary: Get a dataspace
 270    operationId: getDataspace
 271    parameters:
 272       - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
 273    responses:
 274      '200':
 275        description: OK
 276        content:
 277          application/json:
 278            schema:
 279              $ref: 'components.yml#/components/schemas/DataspaceDetails'
 280      '400':
 281        $ref: 'components.yml#/components/responses/BadRequest'
 282      '401':
 283        $ref: 'components.yml#/components/responses/Unauthorized'
 284      '403':
 285        $ref: 'components.yml#/components/responses/Forbidden'
 286      '500':
 287        $ref: 'components.yml#/components/responses/InternalServerError'