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       '401':
  35         $ref: 'components.yml#/components/responses/Unauthorized'
  36       '403':
  37         $ref: 'components.yml#/components/responses/Forbidden'
  38       '409':
  39         $ref: 'components.yml#/components/responses/Conflict'
  40       '500':
  41         $ref: 'components.yml#/components/responses/InternalServerError'
  42
  43 anchorsByDataspace:
  44   post:
  45     deprecated: true
  46     description: Create a new anchor in the given dataspace
  47     tags:
  48       - cps-admin
  49     summary: Create an anchor
  50     operationId: createAnchor
  51     parameters:
  52       - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
  53       - $ref: 'components.yml#/components/parameters/schemaSetNameInQuery'
  54       - $ref: 'components.yml#/components/parameters/anchorNameInQuery'
  55     responses:
  56       '201':
  57         $ref: 'components.yml#/components/responses/Created'
  58       '400':
  59         $ref: 'components.yml#/components/responses/BadRequest'
  60       '401':
  61         $ref: 'components.yml#/components/responses/Unauthorized'
  62       '403':
  63         $ref: 'components.yml#/components/responses/Forbidden'
  64       '409':
  65         $ref: 'components.yml#/components/responses/Conflict'
  66       '500':
  67         $ref: 'components.yml#/components/responses/InternalServerError'
  68
  69 schemaSet:
  70   post:
  71     deprecated: true
  72     description: Create a new schema set in the given dataspace
  73     tags:
  74       - cps-admin
  75     summary: Create a schema set
  76     operationId: createSchemaSet
  77     parameters:
  78       - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
  79       - $ref: 'components.yml#/components/parameters/schemaSetNameInQuery'
  80     requestBody:
  81       required: true
  82       content:
  83         multipart/form-data:
  84           schema:
  85             $ref: 'components.yml#/components/schemas/MultipartFile'
  86     responses:
  87       '201':
  88         $ref: 'components.yml#/components/responses/Created'
  89       '400':
  90         $ref: 'components.yml#/components/responses/BadRequest'
  91       '401':
  92         $ref: 'components.yml#/components/responses/Unauthorized'
  93       '403':
  94         $ref: 'components.yml#/components/responses/Forbidden'
  95       '409':
  96         $ref: 'components.yml#/components/responses/Conflict'
  97       '500':
  98         $ref: 'components.yml#/components/responses/InternalServerError'