cps-rest/docs/openapi/cpsAdminV1Deprecated.yml

   1 # ============LICENSE_START=======================================================
   2 # Copyright (C) 2022 TechMahindra Ltd.
   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 #
  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 dataspaces:
  20   post:
  21     deprecated: true
  22     description: Create a new dataspace
  23     tags:
  24       - cps-admin
  25     summary: Create a dataspace
  26     operationId: createDataspace
  27     parameters:
  28       - $ref: 'components.yml#/components/parameters/dataspaceNameInQuery'
  29     responses:
  30       '201':
  31         $ref: 'components.yml#/components/responses/Created'
  32       '400':
  33         $ref: 'components.yml#/components/responses/BadRequest'
  34       '403':
  35         $ref: 'components.yml#/components/responses/Forbidden'
  36       '409':
  37         $ref: 'components.yml#/components/responses/Conflict'
  38       '500':
  39         $ref: 'components.yml#/components/responses/InternalServerError'
  40
  41 anchorsByDataspace:
  42   post:
  43     deprecated: true
  44     description: Create a new anchor in the given dataspace
  45     tags:
  46       - cps-admin
  47     summary: Create an anchor
  48     operationId: createAnchor
  49     parameters:
  50       - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
  51       - $ref: 'components.yml#/components/parameters/schemaSetNameInQuery'
  52       - $ref: 'components.yml#/components/parameters/anchorNameInQuery'
  53     responses:
  54       '201':
  55         $ref: 'components.yml#/components/responses/Created'
  56       '400':
  57         $ref: 'components.yml#/components/responses/BadRequest'
  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     deprecated: true
  68     description: Create a new schema set in the given dataspace
  69     tags:
  70       - cps-admin
  71     summary: Create a schema set
  72     operationId: createSchemaSet
  73     parameters:
  74       - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
  75       - $ref: 'components.yml#/components/parameters/schemaSetNameInQuery'
  76     requestBody:
  77       required: true
  78       content:
  79         multipart/form-data:
  80           schema:
  81             $ref: 'components.yml#/components/schemas/MultipartFile'
  82     responses:
  83       '201':
  84         $ref: 'components.yml#/components/responses/Created'
  85       '400':
  86         $ref: 'components.yml#/components/responses/BadRequest'
  87       '403':
  88         $ref: 'components.yml#/components/responses/Forbidden'
  89       '409':
  90         $ref: 'components.yml#/components/responses/Conflict'
  91       '500':
  92         $ref: 'components.yml#/components/responses/InternalServerError'