cps-rest/docs/openapi/cpsQuery.yml

   1 #  ============LICENSE_START=======================================================
   2 #  Copyright (C) 2021 Nordix Foundation
   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 #  Unless required by applicable law or agreed to in writing, software
  10 #  distributed under the License is distributed on an "AS IS" BASIS,
  11 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 #  See the License for the specific language governing permissions and
  13 #  limitations under the License.
  14 #
  15 #  SPDX-License-Identifier: Apache-2.0
  16 #  ============LICENSE_END=========================================================
  17
  18 nodesByDataspaceAndAnchorAndCpsPath:
  19   get:
  20     description: Query data nodes for the given dataspace and anchor using CPS path
  21     tags:
  22       - cps-query
  23     summary: Query data nodes
  24     operationId: getNodesByDataspaceAndAnchorAndCpsPath
  25     parameters:
  26       - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
  27       - $ref: 'components.yml#/components/parameters/anchorNameInPath'
  28       - $ref: 'components.yml#/components/parameters/cpsPathInQuery'
  29       - $ref: 'components.yml#/components/parameters/includeDescendantsOptionInQuery'
  30     responses:
  31       '200':
  32         $ref: 'components.yml#/components/responses/Ok'
  33       '400':
  34         $ref: 'components.yml#/components/responses/BadRequest'
  35       '401':
  36         $ref: 'components.yml#/components/responses/Unauthorized'
  37       '403':
  38         $ref: 'components.yml#/components/responses/Forbidden'
  39       '404':
  40         $ref: 'components.yml#/components/responses/NotFound'
  41     x-codegen-request-body-name: xpath