cps-rest/docs/openapi/cpsQueryV1Deprecated.yml

   1 #  ============LICENSE_START=======================================================
   2 #  Copyright (C) 2021 Nordix Foundation
   3 #  Modifications Copyright (c) 2022 Bell Canada.
   4 #  Modifications Copyright (c) 2023 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 nodesByDataspaceAndAnchorAndCpsPath:
  22   get:
  23     description: Query data nodes for the given dataspace and anchor using CPS path
  24     tags:
  25       - cps-query
  26     summary: Query data nodes
  27     deprecated: true
  28     operationId: getNodesByDataspaceAndAnchorAndCpsPath
  29     parameters:
  30       - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
  31       - $ref: 'components.yml#/components/parameters/anchorNameInPath'
  32       - $ref: 'components.yml#/components/parameters/cpsPathInQuery'
  33       - $ref: 'components.yml#/components/parameters/includeDescendantsOptionInQuery'
  34     responses:
  35       '200':
  36         description: OK
  37         content:
  38           application/json:
  39             schema:
  40               type: object
  41             examples:
  42               dataSample:
  43                 $ref: 'components.yml#/components/examples/dataSample'
  44       '400':
  45         $ref: 'components.yml#/components/responses/BadRequest'
  46       '403':
  47         $ref: 'components.yml#/components/responses/Forbidden'
  48       '500':
  49         $ref: 'components.yml#/components/responses/InternalServerError'
  50     x-codegen-request-body-name: xpath