cps-rest/docs/openapi/cpsQuery.yml

   1 #  ============LICENSE_START=======================================================
   2 #  Copyright (C) 2021 Nordix Foundation
   3 #  Copyright (C) 2021-2022 Nordix Foundation
   4 #  ================================================================================
   5 #  Licensed under the Apache License, Version 2.0 (the "License");
   6 #  you may not use this file except in compliance with the License.
   7 #  You may obtain a copy of the License at
   8 #
   9 #        http://www.apache.org/licenses/LICENSE-2.0
  10 #
  11 #  Unless required by applicable law or agreed to in writing, software
  12 #  distributed under the License is distributed on an "AS IS" BASIS,
  13 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 #  See the License for the specific language governing permissions and
  15 #  limitations under the License.
  16 #
  17 #  SPDX-License-Identifier: Apache-2.0
  18 #  ============LICENSE_END=========================================================
  19
  20 nodesByDataspaceAndAnchorAndCpsPath:
  21   get:
  22     description: Query data nodes for the given dataspace and anchor using CPS path
  23     tags:
  24       - cps-query
  25     summary: Query data nodes
  26     operationId: getNodesByDataspaceAndAnchorAndCpsPath
  27     parameters:
  28       - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
  29       - $ref: 'components.yml#/components/parameters/anchorNameInPath'
  30       - $ref: 'components.yml#/components/parameters/cpsPathInQuery'
  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               dataSampleResponse:
  41                 $ref: 'components.yml#/components/examples/dataSampleResponse'
  42       '400':
  43         $ref: 'components.yml#/components/responses/BadRequest'
  44       '401':
  45         $ref: 'components.yml#/components/responses/Unauthorized'
  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