4 description: "This is the Swagger/OpenAPI 2.0 definition of Routing Manager's Northbound\
7 title: "Routing Manager"
10 url: "http://www.apache.org/licenses/LICENSE-2.0.html"
15 description: "Available handles"
17 description: "Health of the system"
25 summary: "Retrive the health of Routing Manager"
26 description: "By performing a GET method on the health resource, the API caller\
27 \ is able to retrieve the health of Routing Manager"
28 operationId: "get_health"
36 description: "The health of the system"
38 $ref: "#/definitions/health-status"
43 summary: "Placeholder for further usage"
44 description: "Placeholder for further usage."
45 operationId: "get_handles"
53 description: "Dummy response"
58 summary: "Provide callback"
59 description: "By performing a POST method on the xapp-handle resource, the API\
60 \ caller is able to perform a callback on Routing Manager."
61 operationId: "provide_xapp_handle"
68 name: "xapp-callback-data"
69 description: "xApp related callback data"
72 $ref: "#/definitions/xapp-callback-data"
73 x-exportParamName: "XappCallbackData"
76 description: "Callback received"
78 description: "Invalid data"
79 /handles/xapp-subscription-handle:
83 summary: "API for updating about new xapp subscription"
84 description: "By performing a POST method on the xapp-subscription-handle resource,\
85 \ the API caller is able to update the Routing manager about the creation\
86 \ of new subscription by an Xapp instance."
87 operationId: "provide_xapp_subscription_handle"
94 name: "xapp-subscription-data"
95 description: "xApp related subscription data"
98 $ref: "#/definitions/xapp-subscription-data"
99 x-exportParamName: "XappSubscriptionData"
102 description: "Xapp Subscription data received"
104 description: "Invalid data"
108 summary: "API for deleting an xapp subscription"
109 description: "By performing the delete operation on xapp-subscription-handle\
110 \ resource, the API caller will be able to update routing manager about the\
111 \ deletion of an xapp's subscription"
112 operationId: "delete_xapp_subscription_handle"
117 name: "xapp-subscription-data"
118 description: "xApp related subscription data"
121 $ref: "#/definitions/xapp-subscription-data"
122 x-exportParamName: "XappSubscriptionData"
125 description: "Xapp Subscription deleted"
127 description: "Content not found"
128 /handles/xapp-subscription-handle/{subscription_id}:
132 summary: "API for updating the subscriber xApp list"
133 description: "By performing a PUT method on a xapp-subscription-handle/{subscription_id}\
134 \ resource, the API caller is able to update the Routing manager about the\
135 \ list of subscriber xApps related to the subscription denoted by the {subsription_id}."
136 operationId: "update_xapp_subscription_handle"
142 - name: "subscription_id"
144 description: "Subscription ID"
148 x-exportParamName: "SubscriptionId"
151 description: "xApp list"
154 $ref: "#/definitions/xapp-list"
155 x-exportParamName: "XappList"
158 description: "Xapp list received"
160 description: "Invalid data"
165 summary: "API for establishing platform routes when a new e2t instance gets\
167 description: "E2T updates its FQDN to E2M during its initialisation, hence\
168 \ after E2M informs routing manager about new E2T instances FQDN. At this\
169 \ point Routing Mgr would establish platform routes"
170 operationId: "create_new_e2t_handle"
178 description: "FQDN of the newly joined E2T instance"
181 $ref: "#/definitions/e2t-data"
182 x-exportParamName: "E2tData"
185 description: "new e2t instance is considered and platform routes are established"
187 description: "Invalid data"
191 summary: "API for clearing routes specific to a particular e2T instance"
192 description: "E2M would monitor E2T instances using its keep alive based mechanism\
193 \ during this time if an E2T instance is detected to be dead, E2M would distribute\
194 \ already associated ran's to other available/healthy E2T instances. Here\
195 \ E2M would share E2T instance address to be removed OR which is unhealthy\
196 \ and list of RAN instances to be dissociated and an association list which\
197 \ contains E2T FQDN and associated RAN names"
198 operationId: "delete_e2t_handle"
206 description: "FQDN of the newly joined E2T instance"
209 $ref: "#/definitions/e2t-delete-data"
210 x-exportParamName: "E2tData"
213 description: "new e2t instance is considered and platform routes are established"
215 description: "Invalid data"
216 /handles/v1/associate-ran-to-e2t:
220 summary: "API for associating a ran to e2t instance"
221 description: "By performing a POST method on rane2tmapping, the API caller is\
222 \ able to update the Routing manager about the ran to e2t mapping which would\
223 \ be finally used to distribute routes to corresponding xApp and E2T instance"
224 operationId: "associate_ran_to_e2t_handle"
232 description: "ran to e2t mapping"
235 $ref: "#/definitions/ran-e2t-map"
236 x-exportParamName: "RanE2tList"
239 description: "e2t ran mapping recieved, platform routes"
241 description: "Invalid data"
242 /handles/v1/dissociate-ran:
246 summary: "API to dissociate ran from e2t"
247 description: "By performing a POST method on rane2tmapping, routing manager\
248 \ will dissociate ran name from e2t instance by updating or clearing routes"
249 operationId: "dissociate_ran"
256 name: "dissociate-list"
257 description: "list of RAN to dissociate"
260 $ref: "#/definitions/ran-e2t-map"
261 x-exportParamName: "DissociateList"
264 description: "ran instances disociated"
266 description: "Invalid data"
290 xapp-subscription-data:
310 $ref: "#/definitions/xapp-element"
327 $ref: "#/definitions/ran-e2t-element"
336 $ref: "#/definitions/ranNamelist"
349 $ref: "#/definitions/ranNamelist"
357 ranNamelistTobeDissociated:
358 $ref: "#/definitions/ranNamelist"
360 $ref: "#/definitions/ran-e2t-map"
362 description: "Routing Manager"
363 url: "http://placeholder"