cps-rest/docs/openapi/cpsDataV2.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     tags:
  23       - cps-data
  24     summary: Get a node
  25     operationId: getNodeByDataspaceAndAnchorV2
  26     parameters:
  27       - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
  28       - $ref: 'components.yml#/components/parameters/anchorNameInPath'
  29       - $ref: 'components.yml#/components/parameters/xpathInQuery'
  30       - $ref: 'components.yml#/components/parameters/descendantsInQuery'
  31     responses:
  32       '200':
  33         description: OK
  34         content:
  35           application/json:
  36             schema:
  37               type: object
  38             examples:
  39               dataSample:
  40                 $ref: 'components.yml#/components/examples/dataSample'
  41       '400':
  42         $ref: 'components.yml#/components/responses/BadRequest'
  43       '403':
  44         $ref: 'components.yml#/components/responses/Forbidden'
  45       '500':
  46         $ref: 'components.yml#/components/responses/InternalServerError'
  47     x-codegen-request-body-name: xpath
  48
  49 deltaByDataspaceAndAnchors:
  50   get:
  51     description: Get delta between two anchors within a given dataspace
  52     tags:
  53       - cps-data
  54     summary: Get delta between anchors in the same dataspace
  55     operationId: getDeltaByDataspaceAndAnchors
  56     parameters:
  57       - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
  58       - $ref: 'components.yml#/components/parameters/anchorNameInPath'
  59       - $ref: 'components.yml#/components/parameters/targetAnchorNameInQuery'
  60       - $ref: 'components.yml#/components/parameters/xpathInQuery'
  61       - $ref: 'components.yml#/components/parameters/descendantsInQuery'
  62     responses:
  63       '200':
  64         description: OK
  65         content:
  66           application/json:
  67             schema:
  68               type: object
  69             examples:
  70               dataSample:
  71                 $ref: 'components.yml#/components/examples/deltaReportSample'
  72       '400':
  73         $ref: 'components.yml#/components/responses/BadRequest'
  74       '403':
  75         $ref: 'components.yml#/components/responses/Forbidden'
  76       '500':
  77         $ref: 'components.yml#/components/responses/InternalServerError'
  78     x-codegen-request-body-name: xpath