aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJosephKeenan <joseph.keenan@est.tech>2022-10-20 10:33:24 +0100
committerJosephKeenan <joseph.keenan@est.tech>2022-10-24 16:22:06 +0100
commit1a65023937c209ae05c8e84093376b737e78320c (patch)
tree352635a2f6291167568bafe0b6be26408aa5ff65
parentb24639de32b2c89346d9888ba0acc9443babb2be (diff)
[NCMP] Add Basic Auth to OpenAPI Definitions
-Adding basic auth to OpenAPI definitions Issue-ID: CPS-1350 Signed-off-by: JosephKeenan <joseph.keenan@est.tech> Change-Id: Iab677f2abc07eed8c3e2910191b15ba27028ee88
-rwxr-xr-xcps-ncmp-rest/docs/openapi/openapi-inventory.yml9
-rwxr-xr-xcps-ncmp-rest/docs/openapi/openapi.yml7
-rw-r--r--cps-rest/docs/openapi/openapi.yml8
-rw-r--r--docs/api/swagger/cps/openapi.yaml7
-rw-r--r--docs/api/swagger/ncmp/openapi-inventory.yaml7
-rw-r--r--docs/api/swagger/ncmp/openapi.yaml7
-rwxr-xr-xdocs/release-notes.rst1
7 files changed, 45 insertions, 1 deletions
diff --git a/cps-ncmp-rest/docs/openapi/openapi-inventory.yml b/cps-ncmp-rest/docs/openapi/openapi-inventory.yml
index 08270bc680..8f8dfe2924 100755
--- a/cps-ncmp-rest/docs/openapi/openapi-inventory.yml
+++ b/cps-ncmp-rest/docs/openapi/openapi-inventory.yml
@@ -24,9 +24,16 @@ info:
version: "1.0"
servers:
- url: /ncmpInventory
+components:
+ securitySchemes:
+ basicAuth:
+ type: http
+ scheme: basic
paths:
/v1/ch:
$ref: 'ncmp-inventory.yml#/updateDmiRegistration'
/v1/ch/cmHandles:
- $ref: 'ncmp-inventory.yml#/getAllCmHandleIdsForRegisteredDmi' \ No newline at end of file
+ $ref: 'ncmp-inventory.yml#/getAllCmHandleIdsForRegisteredDmi'
+security:
+ - basicAuth: [] \ No newline at end of file
diff --git a/cps-ncmp-rest/docs/openapi/openapi.yml b/cps-ncmp-rest/docs/openapi/openapi.yml
index 4c546beb26..fe0c4acfc7 100755
--- a/cps-ncmp-rest/docs/openapi/openapi.yml
+++ b/cps-ncmp-rest/docs/openapi/openapi.yml
@@ -25,6 +25,11 @@ info:
version: "1.0"
servers:
- url: /ncmp
+components:
+ securitySchemes:
+ basicAuth:
+ type: http
+ scheme: basic
paths:
/v1/ch/{cm-handle}/data/ds/{ncmp-datastore-name}:
$ref: 'ncmp.yml#/resourceDataForCmHandle'
@@ -52,3 +57,5 @@ paths:
/v1/ch/{cm-handle}/data-sync:
$ref: 'ncmp.yml#/setDataSyncEnabledFlag'
+security:
+ - basicAuth: [] \ No newline at end of file
diff --git a/cps-rest/docs/openapi/openapi.yml b/cps-rest/docs/openapi/openapi.yml
index 76bdb80c23..290bbf44b2 100644
--- a/cps-rest/docs/openapi/openapi.yml
+++ b/cps-rest/docs/openapi/openapi.yml
@@ -37,6 +37,11 @@ info:
servers:
- url: /cps/api
+components:
+ securitySchemes:
+ basicAuth:
+ type: http
+ scheme: basic
tags:
- name: cps-admin
description: cps Admin
@@ -70,3 +75,6 @@ paths:
/v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query:
$ref: 'cpsQuery.yml#/nodesByDataspaceAndAnchorAndCpsPath'
+
+security:
+ - basicAuth: [] \ No newline at end of file
diff --git a/docs/api/swagger/cps/openapi.yaml b/docs/api/swagger/cps/openapi.yaml
index 874f2a0774..e8f13d4df9 100644
--- a/docs/api/swagger/cps/openapi.yaml
+++ b/docs/api/swagger/cps/openapi.yaml
@@ -1537,6 +1537,10 @@ paths:
details: Internal Server Error occurred
x-codegen-request-body-name: xpath
components:
+ securitySchemes:
+ basicAuth:
+ type: http
+ scheme: basic
schemas:
ErrorMessage:
title: Error
@@ -1609,3 +1613,6 @@ components:
name: SciFi
- code: 2
name: kids
+
+security:
+ - basicAuth: [] \ No newline at end of file
diff --git a/docs/api/swagger/ncmp/openapi-inventory.yaml b/docs/api/swagger/ncmp/openapi-inventory.yaml
index 2d34f0a61a..9e84f3a194 100644
--- a/docs/api/swagger/ncmp/openapi-inventory.yaml
+++ b/docs/api/swagger/ncmp/openapi-inventory.yaml
@@ -148,6 +148,10 @@ paths:
message: Internal Server Error
details: Internal Server Error occurred
components:
+ securitySchemes:
+ basicAuth:
+ type: http
+ scheme: basic
schemas:
RestDmiPluginRegistration:
type: object
@@ -234,3 +238,6 @@ components:
errorText:
type: string
example: Unknown error. <error-details>
+
+security:
+ - basicAuth: [] \ No newline at end of file
diff --git a/docs/api/swagger/ncmp/openapi.yaml b/docs/api/swagger/ncmp/openapi.yaml
index 44cc2b88a6..b9eee5603d 100644
--- a/docs/api/swagger/ncmp/openapi.yaml
+++ b/docs/api/swagger/ncmp/openapi.yaml
@@ -1193,6 +1193,10 @@ paths:
http-code: 400
body: Bad Request
components:
+ securitySchemes:
+ basicAuth:
+ type: http
+ scheme: basic
schemas:
ErrorMessage:
title: Error
@@ -1477,3 +1481,6 @@ components:
- conditionName: cmHandleWithCpsPath
conditionParameters:
- cpsPath: "//state[@data-sync-enabled='true']"
+
+security:
+ - basicAuth: []
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 2bb7a03ebe..113dbc05fa 100755
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -45,6 +45,7 @@ Features
Bug Fixes
---------
- `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control
+ - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_ [CPS/NCMP] Add Basic Auth to CPS/NCMP OpenAPI Definitions
Known Limitations, Issues and Workarounds
-----------------------------------------