Fix to convert service name to IP during Route update Request

[ric-plt/rtmgr.git] / docs / api-docs.rst

diff --git a/docs/api-docs.rst b/docs/api-docs.rst
index 882f99a..7a43b1e 100644 (file)
--- a/docs/api-docs.rst
+++ b/docs/api-docs.rst
@@ -27,16 +27,94 @@ This is the API-docs of ROUTING MANAGER
 
 .. note
 
-.. This section is used to describe a software API exposed from a O-RAN software component.  
-   
-.. This note must be removed after content has been added.
-
 
 API Introduction
 -----------------
-.. Please add what API a component have exposed.
+Routing Manager interacts with the following RIC platform components.
+
+.. code::
+
+   * Appmgr:
+
+     1. POST API to request the xapp list available
+      http://<rtmgr_http_service_IP>/ric/v1/xapps
+     2. POST API to send the xapps that either get deployed or undeployed
+      http://<rtmgr_http_service_IP>/ric/v1/handles/xapp-handle
+             
+
+.. code::   
+
+   * Submgr:
+
+     1. POST API to provide the subscription details 
+      http://<rtmgr_http_service_IP>/ric/v1/handles/xapp-subscription-handle
+
+     2. DELETE API to delete the subscription details
+      http://<rtmgr_http_service_IP>/ric/v1/handles/xapp-subscription-handle
+
+     3. PUT API to update the subscriptionID for given xApp.
+      http://<rtmgr_http_service_IP>/ric/v1/handles/xapp-subscription-handle/{subscription_id}
+
+.. code::    
+
+   * E2Mgr:
+
+     1. POST API to Add E2Termination Instance
+      http://<rtmgr_http_service_IP>/ric/v1/handles/e2t
+
+     2. DELETE API to Delete E2Termination Instance
+      http://<rtmgr_http_service_IP>/ric/v1/handles/e2t 
+
+     3. POST API to Associate RAN names to a given E2Termination
+      http://<rtmgr_http_service_IP>/ric/v1/handles/associate-ran-to-e2t
+
+     4. DELETE API to Dissociate RAN names to a given E2Termination
+      http://<rtmgr_http_service_IP>/ric/v1/handles/dissociate-ran
+
+.. code::    
+
+   * Health Check:
+
+     1. GET API's to retrieve the Aliveness and Readyness checks
+      http://<rtmgr_pod_IP>:8080/ric/v1/health/alive
+      http://<rtmgr_pod_IP>:8080/ric/v1/health/ready
+       
+
 
 API Functions
 -------------
-.. Please states the API functions.
+1. Routing Manager request the xapp list and E2Term list available during startup.
+
+.. image:: images/rtmgr_startup.png
+   :width: 600
+
+2. AppMgr send complete xapps list whenever a xapp is deployed/undeployed
+
+.. image:: images/rtmgr_appmgr_cn.png
+   :width: 600
+
+3. Subscription Manager adds/deletes subscription ID 
+
+.. image:: images/rtmgr_submgr_add_delete.png
+   :width: 600
+
+4. Update the subscription ID for given xApp.(Subscription Merge Add)
+
+.. image:: images/rtmgr_submgr_merge_add.png
+   :width: 600
+
+5. Update the subscription ID for given xApp.(Subscription Merge Delete)
+
+.. image:: images/rtmgr_submgr_merge_delete.png
+   :width: 600
+
+6. E2Mgr sends request to Add/Delete E2Termination Instance
+
+.. image:: images/rtmgr_create_delete_e2t.png
+   :width: 600
+
+7. E2Mgr sends request to Associate/Dissociate RAN names to a given E2Termination Instance
+
+.. image:: images/rtmgr_ass_dis_e2t.png
+   :width: 600