X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=cps-rest%2Fdocs%2Fopenapi%2Fopenapi.yml;h=290bbf44b2ab73a380048d3a379d807a3980c534;hb=1a65023937c209ae05c8e84093376b737e78320c;hp=3c0cc09e598d6e2624328f2983945fe76308607e;hpb=eef2e112d1f447b47f2f19d24e9dfd9a76550333;p=cps.git diff --git a/cps-rest/docs/openapi/openapi.yml b/cps-rest/docs/openapi/openapi.yml index 3c0cc09e5..290bbf44b 100644 --- a/cps-rest/docs/openapi/openapi.yml +++ b/cps-rest/docs/openapi/openapi.yml @@ -1,3 +1,23 @@ +# ============LICENSE_START======================================================= +# Copyright (C) 2021 Nordix Foundation +# Modifications Copyright (C) 2021 Pantheon.tech +# Modifications Copyright (C) 2021 Bell Canada. +# ================================================================================ +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# SPDX-License-Identifier: Apache-2.0 +# ============LICENSE_END========================================================= + openapi: 3.0.1 info: title: ONAP Open API v3 Configuration Persistence Service @@ -16,20 +36,22 @@ info: url: "cps_logo.png" servers: - - url: //localhost:8088 + - url: /cps/api +components: + securitySchemes: + basicAuth: + type: http + scheme: basic tags: - name: cps-admin description: cps Admin - name: cps-data - description: cps Data + description: cps Data paths: /v1/dataspaces: $ref: 'cpsAdmin.yml#/dataspaces' - /v1/dataspaces/{dataspace-name}: - $ref: 'cpsAdmin.yml#/dataspaceByDataspaceName' - /v1/dataspaces/{dataspace-name}/anchors: $ref: 'cpsAdmin.yml#/anchorsByDataspace' @@ -48,11 +70,11 @@ paths: /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes: $ref: 'cpsData.yml#/nodesByDataspaceAndAnchor' - /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-node: - $ref: 'cpsData.yml#/listNodeByDataspaceAndAnchor' - - /v1/dataspaces/{dataspace-name}/nodes: - $ref: 'cpsData.yml#/nodesByDataspace' + /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes: + $ref: 'cpsData.yml#/listElementByDataspaceAndAnchor' /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query: - $ref: 'cpsQuery.yml#/nodesByDataspaceAndAnchorAndCpsPath' \ No newline at end of file + $ref: 'cpsQuery.yml#/nodesByDataspaceAndAnchorAndCpsPath' + +security: + - basicAuth: [] \ No newline at end of file