[NCMP] Add Basic Auth to OpenAPI Definitions

[cps.git] / cps-rest / docs / openapi / openapi.yml

diff --git a/cps-rest/docs/openapi/openapi.yml b/cps-rest/docs/openapi/openapi.yml
index b1f1c17..290bbf4 100644 (file)
--- a/cps-rest/docs/openapi/openapi.yml
+++ b/cps-rest/docs/openapi/openapi.yml
@@ -1,11 +1,14 @@
 #  ============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.
@@ -33,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'
 
@@ -65,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