cps-rest/docs/openapi/cpsDataV1Deprecated.yml

   1 # ============LICENSE_START=======================================================
   2 # Copyright (C) 2022-2023 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 nodeByDataspaceAndAnchor:
  20   get:
  21     description: Get a node with an option to retrieve all the children for a given anchor and dataspace
  22     deprecated: true
  23     tags:
  24       - cps-data
  25     summary: Get a node
  26     operationId: getNodeByDataspaceAndAnchor
  27     parameters:
  28       - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
  29       - $ref: 'components.yml#/components/parameters/anchorNameInPath'
  30       - $ref: 'components.yml#/components/parameters/xpathInQuery'
  31       - $ref: 'components.yml#/components/parameters/includeDescendantsOptionInQuery'
  32     responses:
  33       '200':
  34         description: OK
  35         content:
  36           application/json:
  37             schema:
  38               type: object
  39             examples:
  40               dataSample:
  41                 $ref: 'components.yml#/components/examples/dataSample'
  42       '400':
  43         $ref: 'components.yml#/components/responses/BadRequest'
  44       '403':
  45         $ref: 'components.yml#/components/responses/Forbidden'
  46       '500':
  47         $ref: 'components.yml#/components/responses/InternalServerError'
  48     x-codegen-request-body-name: xpath
  49
  50 listElementByDataspaceAndAnchor:
  51   delete:
  52     description: Delete one or all list element(s) for a given anchor and dataspace
  53     deprecated: true
  54     tags:
  55       - cps-data
  56     summary: Delete one or all list element(s)
  57     operationId: deleteListOrListElement
  58     parameters:
  59       - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
  60       - $ref: 'components.yml#/components/parameters/anchorNameInPath'
  61       - $ref: 'components.yml#/components/parameters/requiredXpathInQuery'
  62       - $ref: 'components.yml#/components/parameters/observedTimestampInQuery'
  63     responses:
  64       '204':
  65         $ref: 'components.yml#/components/responses/NoContent'
  66       '400':
  67         $ref: 'components.yml#/components/responses/BadRequest'
  68       '403':
  69         $ref: 'components.yml#/components/responses/Forbidden'
  70       '500':
  71         $ref: 'components.yml#/components/responses/InternalServerError'