cps-rest/docs/openapi/openapi.yml

   1 #  ============LICENSE_START=======================================================
   2 #  Copyright (C) 2021 Nordix Foundation
   3 #  Modifications Copyright (C) 2021 Pantheon.tech
   4 #  Modifications Copyright (C) 2021 Bell Canada.
   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 openapi: 3.0.1
  22 info:
  23   title: ONAP Open API v3 Configuration Persistence Service
  24   description: Configuration Persistence Service is a Model Driven Generic Database
  25   version: "1.0.0"
  26   contact:
  27      name: ONAP
  28      url: "https://onap.readthedocs.io"
  29      email: "onap-discuss@lists.onap.org"
  30   license:
  31       name: "Apache 2.0"
  32       url: "http://www.apache.org/licenses/LICENSE-2.0"
  33   x-planned-retirement-date: "202212"
  34   x-component: "Modeling"
  35   x-logo:
  36       url: "cps_logo.png"
  37
  38 servers:
  39   - url: /cps/api
  40 components:
  41   securitySchemes:
  42     basicAuth:
  43       type: http
  44       scheme: basic
  45 tags:
  46   - name: cps-admin
  47     description: cps Admin
  48   - name: cps-data
  49     description: cps Data
  50 paths:
  51
  52   /v1/dataspaces:
  53     $ref: 'cpsAdmin.yml#/dataspaces'
  54
  55   /v1/dataspaces/{dataspace-name}/anchors:
  56     $ref: 'cpsAdmin.yml#/anchorsByDataspace'
  57
  58   /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}:
  59     $ref: 'cpsAdmin.yml#/anchorByDataspaceAndAnchorName'
  60
  61   /v1/dataspaces/{dataspace-name}/schema-sets:
  62     $ref: 'cpsAdmin.yml#/schemaSet'
  63
  64   /v1/dataspaces/{dataspace-name}/schema-sets/{schema-set-name}:
  65     $ref: 'cpsAdmin.yml#/schemaSetBySchemaSetName'
  66
  67   /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/node:
  68     $ref: 'cpsData.yml#/nodeByDataspaceAndAnchor'
  69
  70   /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes:
  71     $ref: 'cpsData.yml#/nodesByDataspaceAndAnchor'
  72
  73   /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes:
  74     $ref: 'cpsData.yml#/listElementByDataspaceAndAnchor'
  75
  76   /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query:
  77     $ref: 'cpsQuery.yml#/nodesByDataspaceAndAnchorAndCpsPath'
  78
  79 security:
  80   - basicAuth: []