docs/api-docs.rst

   1 ..  Copyright (c) 2019 AT&T Intellectual Property.
   2 ..  Copyright (c) 2019 Nokia.
   3 ..
   4 ..  Licensed under the Creative Commons Attribution 4.0 International
   5 ..  Public License (the "License"); you may not use this file except
   6 ..  in compliance with the License. You may obtain a copy of the License at
   7 ..
   8 ..    https://creativecommons.org/licenses/by/4.0/
   9 ..
  10 ..  Unless required by applicable law or agreed to in writing, documentation
  11 ..  distributed under the License is distributed on an "AS IS" BASIS,
  12 ..  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 ..
  14 ..  See the License for the specific language governing permissions and
  15 ..  limitations under the License.
  16 ..
  17
  18
  19 API-Docs
  20 ========
  21
  22 This is the API-docs of ROUTING MANAGER
  23
  24 .. contents::
  25    :depth: 3
  26    :local:
  27
  28 .. note
  29
  30
  31 API Introduction
  32 -----------------
  33 Routing Manager interacts with the following RIC platform components.
  34
  35 .. code::
  36
  37    * Appmgr:
  38
  39      1. POST API to request the xapp list available
  40       http://<rtmgr_http_service_IP>/ric/v1/xapps
  41      2. POST API to send the xapps that either get deployed or undeployed
  42       http://<rtmgr_http_service_IP>/ric/v1/handles/xapp-handle
  43
  44
  45 .. code::
  46
  47    * Submgr:
  48
  49      1. POST API to provide the subscription details
  50       http://<rtmgr_http_service_IP>/ric/v1/handles/xapp-subscription-handle
  51
  52      2. DELETE API to delete the subscription details
  53       http://<rtmgr_http_service_IP>/ric/v1/handles/xapp-subscription-handle
  54
  55      3. PUT API to update the subscriptionID for given xApp.
  56       http://<rtmgr_http_service_IP>/ric/v1/handles/xapp-subscription-handle/{subscription_id}
  57
  58 .. code::
  59
  60    * E2Mgr:
  61
  62      1. POST API to Add E2Termination Instance
  63       http://<rtmgr_http_service_IP>/ric/v1/handles/e2t
  64
  65      2. DELETE API to Delete E2Termination Instance
  66       http://<rtmgr_http_service_IP>/ric/v1/handles/e2t
  67
  68      3. POST API to Associate RAN names to a given E2Termination
  69       http://<rtmgr_http_service_IP>/ric/v1/handles/associate-ran-to-e2t
  70
  71      4. DELETE API to Dissociate RAN names to a given E2Termination
  72       http://<rtmgr_http_service_IP>/ric/v1/handles/dissociate-ran
  73
  74 .. code::
  75
  76    * Health Check:
  77
  78      1. GET API's to retrieve the Aliveness and Readyness checks
  79       http://<rtmgr_pod_IP>:8080/ric/v1/health/alive
  80       http://<rtmgr_pod_IP>:8080/ric/v1/health/ready
  81
  82
  83
  84 API Functions
  85 -------------
  86 1. Routing Manager request the xapp list and E2Term list available during startup.
  87
  88 .. image:: images/rtmgr_startup.png
  89    :width: 600
  90
  91 2. AppMgr send complete xapps list whenever a xapp is deployed/undeployed
  92
  93 .. image:: images/rtmgr_appmgr_cn.png
  94    :width: 600
  95
  96 3. Subscription Manager adds/deletes subscription ID
  97
  98 .. image:: images/rtmgr_submgr_add_delete.png
  99    :width: 600
 100
 101 4. Update the subscription ID for given xApp.(Subscription Merge Add)
 102
 103 .. image:: images/rtmgr_submgr_merge_add.png
 104    :width: 600
 105
 106 5. Update the subscription ID for given xApp.(Subscription Merge Delete)
 107
 108 .. image:: images/rtmgr_submgr_merge_delete.png
 109    :width: 600
 110
 111 6. E2Mgr sends request to Add/Delete E2Termination Instance
 112
 113 .. image:: images/rtmgr_create_delete_e2t.png
 114    :width: 600
 115
 116 7. E2Mgr sends request to Associate/Dissociate RAN names to a given E2Termination Instance
 117
 118 .. image:: images/rtmgr_ass_dis_e2t.png
 119    :width: 600
 120