[NCMP] Add Basic Auth to OpenAPI Definitions

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

diff --git a/cps-ncmp-rest/docs/openapi/openapi.yml b/cps-ncmp-rest/docs/openapi/openapi.yml
index 1620eba..fe0c4ac 100755 (executable)
--- a/cps-ncmp-rest/docs/openapi/openapi.yml
+++ b/cps-ncmp-rest/docs/openapi/openapi.yml
@@ -1,5 +1,5 @@
 #  ============LICENSE_START=======================================================
-#  Copyright (C) 2021 Nordix Foundation
+#  Copyright (C) 2021-2022 Nordix Foundation
 #  Modifications Copyright (C) 2021 Pantheon.tech
 #  Modifications Copyright (C) 2021 Bell Canada
 #  ================================================================================
@@ -25,27 +25,37 @@ info:
   version: "1.0"
 servers:
   - url: /ncmp
+components:
+  securitySchemes:
+    basicAuth:
+      type: http
+      scheme: basic
 paths:
-  /v1/cm-handles/{cm-handle}/node:
-    $ref: 'ncmproxy.yml#/nodeByCmHandleAndXpath'
+  /v1/ch/{cm-handle}/data/ds/{ncmp-datastore-name}:
+    $ref: 'ncmp.yml#/resourceDataForCmHandle'
 
-  /v1/cm-handles/{cm-handle}/list-node:
-    $ref: 'ncmproxy.yml#/listNodeByCmHandleAndXpath'
+  /v1/ch/{cm-handle}/modules:
+    $ref: 'ncmp.yml#/fetchModuleReferencesByCmHandle'
 
-  /v1/cm-handles/{cm-handle}/nodes/query:
-    $ref: 'ncmproxy.yml#/nodesByCmHandleAndCpsPath'
+  /v1/ch/{cm-handle}/modules/definitions:
+    $ref: 'ncmp.yml#/fetchModuleDefinitionsByCmHandle'
 
-  /v1/cm-handles/{cm-handle}/nodes:
-    $ref: 'ncmproxy.yml#/nodesByCmHandleAndXpath'
+  /v1/ch/searches:
+    $ref: 'ncmp.yml#/searchCmHandles'
 
-  /v1/ch:
-    $ref: 'ncmproxy.yml#/updateDmiRegistration'
+  /v1/ch/{cm-handle}:
+    $ref: 'ncmp.yml#/retrieveCmHandleDetailsById'
 
-  /v1/ch/{cm-handle}/data/ds/ncmp-datastore:passthrough-operational:
-    $ref: 'ncmproxy.yml#/getResourceDataForPassthroughOperational'
+  /v1/ch/{cm-handle}/properties:
+    $ref: 'ncmp.yml#/getCmHandlePropertiesById'
 
-  /v1/ch/{cm-handle}/data/ds/ncmp-datastore:passthrough-running:
-    $ref: 'ncmproxy.yml#/resourceDataForPassthroughRunning'
+  /v1/ch/id-searches:
+    $ref: 'ncmp.yml#/searchCmHandleIds'
 
-  /v1/ch/{cm-handle}/modules:
-    $ref: 'ncmproxy.yml#/fetchModuleReferencesByCmHandle'
\ No newline at end of file
+  /v1/ch/{cm-handle}/state:
+    $ref: 'ncmp.yml#/getCmHandleStateById'
+
+  /v1/ch/{cm-handle}/data-sync:
+    $ref: 'ncmp.yml#/setDataSyncEnabledFlag'
+security:
+  - basicAuth: []
\ No newline at end of file