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 #  Modifications Copyright (C) 2022-2023 TechMahindra Ltd.
   6 #  ================================================================================
   7 #  Licensed under the Apache License, Version 2.0 (the "License");
   8 #  you may not use this file except in compliance with the License.
   9 #  You may obtain a copy of the License at
  10 #
  11 #        http://www.apache.org/licenses/LICENSE-2.0
  12 #
  13 #  Unless required by applicable law or agreed to in writing, software
  14 #  distributed under the License is distributed on an "AS IS" BASIS,
  15 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16 #  See the License for the specific language governing permissions and
  17 #  limitations under the License.
  18 #
  19 #  SPDX-License-Identifier: Apache-2.0
  20 #  ============LICENSE_END=========================================================
  21
  22 openapi: 3.0.1
  23 info:
  24   title: ONAP Open API v3 Configuration Persistence Service
  25   description: Configuration Persistence Service is a Model Driven Generic Database
  26   version: "1.0.0"
  27   contact:
  28      name: ONAP
  29      url: "https://onap.readthedocs.io"
  30      email: "onap-discuss@lists.onap.org"
  31   license:
  32       name: "Apache 2.0"
  33       url: "http://www.apache.org/licenses/LICENSE-2.0"
  34   x-planned-retirement-date: "202212"
  35   x-component: "Modeling"
  36   x-logo:
  37       url: "cps_logo.png"
  38
  39 servers:
  40   - url: /cps/api
  41 components:
  42   securitySchemes:
  43     basicAuth:
  44       type: http
  45       scheme: basic
  46 tags:
  47   - name: cps-admin
  48     description: cps Admin
  49   - name: cps-data
  50     description: cps Data
  51 paths:
  52
  53   /v1/dataspaces:
  54     $ref: 'cpsAdminV1Deprecated.yml#/dataspaces'
  55
  56   /{apiVersion}/dataspaces:
  57     $ref: 'cpsAdmin.yml#/dataspaces'
  58
  59   /v2/dataspaces:
  60     $ref: 'cpsAdminV2.yml#/dataspaces'
  61
  62   /{apiVersion}/admin/dataspaces:
  63     $ref: 'cpsAdmin.yml#/adminDataspaces'
  64
  65   /{apiVersion}/admin/dataspaces/{dataspace-name}:
  66     $ref: 'cpsAdmin.yml#/adminDataspace'
  67
  68   /v1/dataspaces/{dataspace-name}/anchors:
  69     $ref: 'cpsAdminV1Deprecated.yml#/anchorsByDataspace'
  70
  71   /v2/dataspaces/{dataspace-name}/anchors:
  72     $ref: 'cpsAdminV2.yml#/anchorsByDataspace'
  73
  74   /{apiVersion}/dataspaces/{dataspace-name}/anchors:
  75     $ref: 'cpsAdmin.yml#/anchorsByDataspace'
  76
  77   /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}:
  78     $ref: 'cpsAdmin.yml#/anchorByDataspaceAndAnchorName'
  79
  80   /v1/dataspaces/{dataspace-name}/schema-sets:
  81     $ref: 'cpsAdminV1Deprecated.yml#/schemaSet'
  82
  83   /v2/dataspaces/{dataspace-name}/schema-sets:
  84     $ref: 'cpsAdminV2.yml#/schemaSet'
  85
  86   /{apiVersion}/dataspaces/{dataspace-name}/schema-sets:
  87     $ref: 'cpsAdmin.yml#/schemaSet'
  88
  89   /{apiVersion}/dataspaces/{dataspace-name}/schema-sets/{schema-set-name}:
  90     $ref: 'cpsAdmin.yml#/schemaSetBySchemaSetName'
  91
  92   /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/node:
  93     $ref: 'cpsDataV1Deprecated.yml#/nodeByDataspaceAndAnchor'
  94
  95   /v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/node:
  96     $ref: 'cpsDataV2.yml#/nodeByDataspaceAndAnchor'
  97
  98   /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes:
  99     $ref: 'cpsData.yml#/nodesByDataspaceAndAnchor'
 100
 101   /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes:
 102     $ref: 'cpsDataV1Deprecated.yml#/listElementByDataspaceAndAnchor'
 103
 104   /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes:
 105     $ref: 'cpsData.yml#/listElementByDataspaceAndAnchor'
 106
 107   /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query:
 108     $ref: 'cpsQueryV1Deprecated.yml#/nodesByDataspaceAndAnchorAndCpsPath'
 109
 110   /v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query:
 111     $ref: 'cpsQueryV2.yml#/nodesByDataspaceAndAnchorAndCpsPath'
 112
 113   /v2/dataspaces/{dataspace-name}/nodes/query:
 114     $ref: 'cpsQueryV2.yml#/nodesByDataspaceAndCpsPath'
 115
 116 security:
 117   - basicAuth: []