cps-rest/docs/openapi/openapi.yml

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