Commit a84e92b6 authored by Robert Gazda's avatar Robert Gazda
Browse files

Update README.md - adjusting width of table columns.

parent f5239716
Loading
Loading
Loading
Loading
+9 −9
Original line number Diff line number Diff line
@@ -233,7 +233,7 @@ References:


##### Query Endpoints
| Endpoint: | Spec Description      | Sandbox Usage:        | Notes:         |
| <div style="width:200px"> Endpoint: <div> | <div style="width:300px"> Spec Description <div> | <div style="width:300px"> Sandbox Usage: <div> | <div style="width:300px"> Notes: <div> |
| ----------| --------------------- | --------------------- | -------------- |
| /queries/rab_info | This resource is queried to retrieve information on Radio Access Bearers. | Terminals are identified via UE_IPV4_ADDRESS type in associateId <br><br> Sandbox query input utilizes: <ul><li> cell_id (array): returns RabInfo for all terminals connected within the input cells (RabInfo includes terminal's assoicateId = IP address) </li><li> ue_ipv4_address (array): returns RabInfo for all input terminal's based on IP address (RabInfo includes terminal's connected Cell Id) </li><li> If no parameters are included: returns all RabInfo for all connected terminals in all cells </li><li> Both parameters are considered an "and" </li></ul> <br> All other parameter are ignored, including MEC app instance ID (Sandbox models all Service API requests coming from the same MEC App instance)  | Although the MEC Sandbox does not include data paths to terminals, the rab_info query can be used to discover terminals and their connected cells in the Sandbox.  <br><br> As a Sandbox user, I can use this call to learn about all terminals in the network connected to 3GPP PoAs. I do not need to know the Terminal Id or the Cell Id. Input = null.  <br><br> As a Sandbox user, if I know a Terminal's Id (IP address), I can use this call to determine if and where that terminal is 3GPP connected (input = terminal IP address)  <br><br> As a Sandbox user, if I know a Cell Id, I can use this call to learn what terminals may be connected in that cell (input = cell id in EGCI format). <br><br> RABs will have a consistent QCI value (e.g. non-GBR, QCI = 80 -- Low latency eMBB applications, TCP/UDP-based).
| /queries/plmn_info |  This resource is queried to retrieve information on the underlying Mobile Network that the mobile edge application is associated to. | Returns Sandbox PLMN: <ul><li> MCC = 001; <li> MNC = 001 </ul> | As a Sandbox user, I can use this query to learn the PLMN of the Sandbox Network. <br><br> RNIS v1: cellId set to static value <br><br> Application instance identifier is ignored. |
@@ -242,8 +242,8 @@ References:

##### Subscription Endpoints

| Endpoint: | Spec Description | Sandbox Usage:        | Notes:         |
| ----------| ---------------- | --------------------- | -------------- |
| <div style="width:200px"> Endpoint: <div> | <div style="width:300px"> Spec Description <div> | <div style="width:300px"> Sandbox Usage: <div> | <div style="width:300px"> Notes: <div> |
| ----------| --------------------- | --------------------- | -------------- |
| /subscriptions | The GET method is used to request information about the subscriptions for this requestor. Upon success, the response contains entity body with the list of links to the subscriptions that are present for the requestor. | Return list of all RNIS subscriptions | Sandbox supports a single requester (i.e. single ME app calling MEC services). |
| /subscriptions/cell_change	| Cell change notifications |	Notifications report cell changes based on input filters <br><br> Supported filters include: <ul><li> associateId: list of terminals based on IP address <li> plmnId: ignored <li> cellId: list of cells (if not present, all cell changes) <li> hoStatus: ignored (notifications on COMPLETE) </ul> Filters are considered an "and" between types, then an "or" within the list of a type. For example: UEs (1,2,3) + Cells (a,b,c). Notification will trigger if any of the UEs handover with any of the cells; Otherwise not. UE1 handover with Cell4 for example. <br><br> Expiry Deadline is ignored. | As a Sandbox User, I can set a notification with no filters and I will get all cell change events that occur in the sandbox. <br><br> As a Sandbox User, I can set a notification for a specific terminal (or set) and monitor its handover changes across the 3GPP points of access. <br><br> As a Sandbox User, I can set a notification to monitor a specific cell (or set of cells) and monitor handover events for that cell.
| /subscriptions/rab_est	| RAB establishment notification	| Notifications report RAB establishments in the network, i.e. when a terminal connects to the 3GPP network. <br><br> Sandbox examples include: <ul> <li> Terminal is added to the Macro Network Scenario by the user <li> Terminal connects to a 3GPP PoA after being connected to WiFi </ul> <br>Supported filters include: <ul> <li> plmnId: ignored <li> cellId: list of cell (if not present, RAB establishment on any cell) <li> QCI: ignored </ul> <br> Expiry Deadline is ignored. <br> <br> Notification returns: <ul><li> associateId: IPv4 address of the terminal <li> erabId: RAB Id for the terminal's bearer </ul> | As a Sandbox User, I can set a notification with no filters and I will get all RAB establishment events on any cell (terminal connection to 3GPP anywhere in the network). <br><br> As a Sandbox User, I can set a notification for a specific cell (or set of cells) and monitor RAB establishments for those cells. |
@@ -271,14 +271,14 @@ References:
* https://www.etsi.org/deliver/etsi_gs/MEC/001_099/028/02.01.01_60/gs_mec028v020101p.pdf

##### Query Endpoints
| Endpoint: | Spec Description      | Sandbox Usage:        | Notes:         |
| <div style="width:200px"> Endpoint: <div> | <div style="width:300px"> Spec Description <div> | <div style="width:300px"> Sandbox Usage: <div> | <div style="width:300px"> Notes: <div> |
| ----------| --------------------- | --------------------- | -------------- |
| Access Point information	<br><br> /queries/ap/ap_information | This resource is queried to retrieve information on WLAN Access Points in the network.  It can be used to query for all access points in the network, or sub-sets based on Access Point identity (MAC Address), SSID, etc.   | WLAN AP's uniquely identified via MAC Address.  <br><br> All APs share the same SSID. <br><br> "filter" (attribute-based filtering pattern from MEC009) expression used to select queries for specific APs (based on MAC Address) or group of APs (based on SSID).    | As a Sandbox user, I can use this call to learn about all the WLAN Hotspots in the network, including for each AP:  identity (MAC Address and SSID), # of connected terminals, BSS Load, geolocation, etc.  I do not need to know anything about the AP's and I can discovery them.  Filter input = null. <br><br><br>  As a Sandbox user, I can use this call to query status of a specific AP (if I know the AP MAC Address). For example, to learn the AP's current BSS Load, including # of connected STAs. |
| Station information	<br><br> /queries/sta/sta_information | This resource is queried to retrieve information on terminals (STA) connected to WLAN Access Points in the network.  It can be used to query and discover all terminals connected to WLAN.  Or, it can be used to query the current status of a terminal (STA), based on MAC Address or IPV4 Address  | Terminals maintain a consistent IPV4 Address between 3GPP cellular (4G or 5G) and WLAN access connections, following the 3GPP trusted non-3GPP access model. <br><br> "filter" (attribute-based filtering pattern from MEC009) expression used to select queries for specific STA's (based on MAC Address or IPV4 Address). | As a Sandbox user, I can use this call to learn about all the terminals that are connected to WLAN Hotspots in the network, including for each STA: it's identity (STA MAC Address and IPV4 Address), connected AP (AP MAC Address and SSID), signal level in RSSI (calculated based on distance from AP in Sandbox).  I do not need to know anything about the STA's and I can discover them. Filter input = null.   <br><br><br> As a Sandbox user, I can use this call to query status of a specific terminal (if I know the STA's MAC Address or IPV4 Address).  For example, to learn current RSSI signal level or connected AP status.

##### Subscription Endpoints

| Endpoint: | Spec Description | Sandbox Usage:        | Notes:         |
| <div style="width:200px"> Endpoint: <div> | <div style="width:300px"> Spec Description <div> | <div style="width:300px"> Sandbox Usage: <div> | <div style="width:300px"> Notes: <div> |
| ----------| ---------------- | --------------------- | -------------- |
| /subscriptions | The GET method is used to request information about the subscriptions for this requestor. Upon success, the response contains entity body with the list of links to the subscriptions that are present for the requestor. | Return list of all WAIS subscriptions | Sandbox supports a single requester (i.e. single MEC app calling MEC services). |
| /subscriptions/assoc_sta | WLAN event notifications about associated stations (terminals).  <br><br> Notification providing STA connection status on a per AP basis.  Notification includes: <ul><li> AP Id (MAC Address and SSID) <li> List of connected terminals (STA Id - MAC address and IPV4 address) </ul> Subscriptions must be created individually on an AP by AP basis (one AP per subscription per the spec data model). | Sandbox issues this notification on a change in STA connections on an AP (whenever a STA connects or disconnects from the AP). | As a Sandbox user, I can use this notification subscription to monitor connections on WLAN access points of interest.  <br><br> After learning from this notification that a STA is connected to a specific AP, I can:  <ul><li> Query ap_information to see how busy the AP may be (via BSS Load); <li> Query sta_information to check the WLAN signal level (via RSSI) of the STA.