Merge "#2 NCMP : Replacing the word 'Batch' as 'DataOperation'."

[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 0dfe3c8..7ceb4fe 100755 (executable)
--- a/cps-ncmp-rest/docs/openapi/openapi.yml
+++ b/cps-ncmp-rest/docs/openapi/openapi.yml
@@ -1,6 +1,7 @@
 #  ============LICENSE_START=======================================================
-#  Copyright (C) 2021 Nordix Foundation
+#  Copyright (C) 2021-2023 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.
@@ -17,31 +18,50 @@
 #  SPDX-License-Identifier: Apache-2.0
 #  ============LICENSE_END=========================================================
 
-openapi: 3.0.1
+openapi: 3.0.3
 info:
   title: NCMP to CPS Proxy API
   description: NCMP to CPS Proxy API
   version: "1.0"
 servers:
-  - url: //localhost:8088/
+  - 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/{datastore-name}:
+    $ref: 'ncmp.yml#/resourceDataForCmHandle'
 
-  /v1/cm-handles/{cm-handle}/list-node:
-    $ref: 'ncmproxy.yml#/listNodeByCmHandleAndXpath'
+  /v1/data:
+    $ref: 'ncmp.yml#/dataOperationForCmHandle'
 
-  /v1/cm-handles/{cm-handle}/nodes/query:
-    $ref: 'ncmproxy.yml#/nodesByCmHandleAndCpsPath'
+  /v1/ch/{cm-handle}/data/ds/{datastore-name}/query:
+    $ref: 'ncmp.yml#/queryResourceDataForCmHandle'
 
-  /v1/cm-handles/{cm-handle}/nodes:
-    $ref: 'ncmproxy.yml#/nodesByCmHandleAndXpath'
+  /v1/ch/{cm-handle}/modules:
+    $ref: 'ncmp.yml#/fetchModuleReferencesByCmHandle'
 
-  /ncmp-dmi/v1/ch:
-    $ref: 'ncmproxy.yml#/updateDmiRegistration'
+  /v1/ch/{cm-handle}/modules/definitions:
+    $ref: 'ncmp.yml#/fetchModuleDefinitionsByCmHandle'
 
-  /v1/ch/{cm-handle}/data/ds/ncmp-datastore:passthrough-operational/{resourceIdentifier}:
-    $ref: 'ncmproxy.yml#/getResourceDataForPassthroughOperational'
+  /v1/ch/searches:
+    $ref: 'ncmp.yml#/searchCmHandles'
 
-  /v1/ch/{cm-handle}/data/ds/ncmp-datastore:passthrough-running/{resourceIdentifier}:
-    $ref: 'ncmproxy.yml#/resourceDataForPassthroughRunning'
\ No newline at end of file
+  /v1/ch/{cm-handle}:
+    $ref: 'ncmp.yml#/retrieveCmHandleDetailsById'
+
+  /v1/ch/{cm-handle}/properties:
+    $ref: 'ncmp.yml#/getCmHandlePropertiesById'
+
+  /v1/ch/id-searches:
+    $ref: 'ncmp.yml#/searchCmHandleIds'
+
+  /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