Commit a1bb8923 authored by Mike Roy's avatar Mike Roy
Browse files

Editorial

parent ff27d6f5
Loading
Loading
Loading
Loading
+4 −4
Original line number Diff line number Diff line
@@ -48,16 +48,16 @@ References:
| `.../services` <br> `.../services/{serviceId}`  | GET - Returns a list/individual MEC service(s) | Available MEC services in the Sandbox can be discovered <br><br> Includes: <ul><li> Built-in MEC Services:  MEC012, MEC013, MEC028 <li> User MEC Services:  services registered by user MEC apps |
| `.../applications/{appInstanceId}/services` | GET - Returns a list of MEC services offered by an individual application instance <br><br> POST - Creates or registers a MEC service with the Sandbox's MEC System offered by an individual application instance | Available MEC services offered by a app instance can be discovered <br><br> MEC apps or services use POST to create their service resource and offer it for other MEC apps to discover |
| `.../applications/{appInstanceId}/services/{serviceId}` | GET - Returns an individual MEC service offered by an individual application instance <br><br> PUT - updates an existing service resource <br><br> DELETE removes an existing service resource | An available MEC service offered by a individual app instance can be discovered <br><br> MEC apps and services use PUT to modify their service resource <br><br>  MEC apps and services use DELETE when terminating or removing a registered service |
| `.../applications/{appInstanceId}/subscriptions` | GET - Returns a list of subscriptions for a MEC app instance <br><br> POST - creates a subscription |  Built-in MEC services don't use this endpoint <br><br> User or user MEC app can subscribe to MEC services management events (e.g. service availability notification) |
| `.../applications/{appInstanceId}/subscriptions/{subscriptionId}` | GET - Returns an individual subscription <br><br> DELETE - removes an existing subscription | Built-in MEC services don't use this endpoint <br><br> User or user MEC app can delete subscription(s) |
| `.../applications/{appInstanceId}/subscriptions` | GET - Returns a list of subscriptions for a MEC Application instance <br><br> POST - creates a subscription |  Built-in MEC services don't use this endpoint <br><br> User or user MEC Application can subscribe to MEC services management events (e.g. service availability notification) |
| `.../applications/{appInstanceId}/subscriptions/{subscriptionId}` | GET - Returns an individual subscription <br><br> DELETE - removes an existing subscription | Built-in MEC services don't use this endpoint <br><br> User or user MEC Application can delete subscription(s) |
| `.../transports` | GET - Returns a list of supported MEC transports | Only HTTP supported by the MEC Sandbox |
| `.../<dynamic-liveness-uri>` | GET - Returns info about the liveness of a MEC service of an application instance <br><br> PATCH - Sends a "heartbeat" message related to a MEC service instance | MEC applications use this endpoint to report their liveness

### Application Support API Endpoints
| Endpoint | Sandbox Usage |Notes |
| ---------- | --------------------- | -------------- |
| `.../applications/{appInstanceId}/subscriptions` | GET - Returns a list of subscriptions <br><br> POST - creates a subscription |  Built-in MEC services don't use this endpoint <br><br> User or user MEC app can subscribe to MEC application management events |
| `.../applications/{appInstanceId}/subscriptions/{subscriptionId}` | GET - Returns an individual subscription <br><br> DELETE - removes an existing subscription |  Built-in MEC services don't use this endpoint <br><br> User or user MEC app can delete subscription(s) |
| `.../applications/{appInstanceId}/subscriptions` | GET - Returns a list of subscriptions <br><br> POST - creates a subscription |  Built-in MEC services don't use this endpoint <br><br> User or user MEC Application can subscribe to MEC application management events |
| `.../applications/{appInstanceId}/subscriptions/{subscriptionId}` | GET - Returns an individual subscription <br><br> DELETE - removes an existing subscription |  Built-in MEC services don't use this endpoint <br><br> User or user MEC Application can delete subscription(s) |
| `.../applications/{appInstanceId}/confirm_ready` | POST - confirms the application is ready |  MEC application report readiness
| `.../applications/{appInstanceId}/confirm_termination` | POST - confirms the application is terminated | MEC applications reports termination |
| `.../timing/timing_caps` | GET - returns information about timing capabililities | Mocked information returned since no NTP server is used
+5 −5

File changed.

Preview size limit exceeded, changes collapsed.

+6 −6
Original line number Diff line number Diff line
@@ -25,12 +25,12 @@ References:

| **Endpoint**    | **Sandbox Usage**          | **Notes**          |
| ----------------|--------------------------- | ------------------ |
| [/subscriptions/zonalTraffic](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs013-location-api/raw/v2.1.1/LocationAPI.yaml#/location/zonalTrafficSubGET) | Subscription related to changes for a zone:  users (devices) entering zone, exiting zone, transition across access points within a zone. <br><br>  Input = <ul><li> zoneId </li><li> interestRealm </li><li> userEventCriteria </li><li> duration of reporting </li></ul> | Notification == Zonal Presence Notification <br><br> As a MEC Sandbox User or MEC App, I use this notification to monitor changes in a zone.   |
| [/subscriptions/userTracking](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs013-location-api/raw/v2.1.1/LocationAPI.yaml#/location/userTrackingSubGET) | Subscription related to changes of a specific user:  zone enter, zone exit, transition across points of access. <br><br> Input = <ul><li> address (device id, user id), </li><li> userEventCriteria </li></ul> | Notification == Zonal Presence Notification <br><br> As a MEC Sandbox User or MEC App, I use this notification to track location changes for a specific user (or device). |
| [/subscriptions/zonalStatus](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs013-location-api/raw/v2.1.1/LocationAPI.yaml#/location/zoneStatusSubGET) | Subscription related to changes in zone status:  # of users in a zone, # of users per AP in a zone, etc. <br><br> Input = <ul><li> zoneId </li><li> numberOfUsersZoneThreshold  </li><li> numberOfUsersAPThreshold </li></ul>  | Notification == Zonal Status Notification <br><br> As a MEC Sandbox User or MEC App, I use this notification to monitor changes in a zone. |
| [/subscriptions/area/circle](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs013-location-api/raw/v2.1.1/LocationAPI.yaml#/location/areaCircleSubGET) <br><br> *New STF599* | Subscription to monitor the location of a specific user (device) or list of users in relation to a circle area, geo-located circle (defined by coordinates and a radius).  <br><br> Subscription input: <ul><li> UE address(s) </li><li> Circle info: latitude, longitude, radius </li><li> accuracy </li><li> criteria: entering, leaving </li><li> check immediately on subscription </li><li> max frequency of reporting </li><li> duration of reporting </li><li> max count (total number of notifications) </li></ul>  | Notification (Subscription Notification) – issued on criteria: <ul><li> UE address </li><li> Current UE Location </li></ul> <br><br>  As a MEC Sandbox User or MEC App, I use this notification to monitor a specific location area of my choosing (circle area) in relation to a device or set of devices, also of my choosing.    |
| [/subscriptions/distance](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs013-location-api/raw/v2.1.1/LocationAPI.yaml#/location/distanceSubGET) <br><br> *New STF599* | Subscription to monitor the distance of a specific set of user devices (UE), towards another set of user devices.  <br><br> Subscription input: <ul><li> reference address(s) </li><li> monitored address(s) </li><li> distance </li><li> accuracy </li><li> criteria: all within, any within, all beyond, all beyond </li><li> check immediately on subscription </li><li> max frequency of reporting </li><li> duration of reporting </li><li> max count (total number of notifications) </li></ul> | Notification (Subscription Notification) – issued on criteria: <ul><li> address and current location for all UEs (reference and monitored) </li><li> notification criteria: all within, any within, all beyond, all beyond </li></ul> <br><br>  As a MEC Sandbox User or MEC App, I use this notification to monitor the distance status between two user devices (UEs or terminals) or two sets if user devices.  |
| [/subscriptions/periodic](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs013-location-api/raw/v2.1.1/LocationAPI.yaml#/location/periodicSubGET)<br><br> *New STF599* | Subscription to monitor the location of a specific set of user devices (UE).  <br><br>Subscription input: <ul><li> UE address(s) </li><li> max frequency of reporting </li><li> duration or reporting </li><li> max count (total number of notifications) </li></ul> | Notification (Subscription Notification) issued on criteria: period (frequency), duration, total # of notifications. <br><br>  As a MEC Sandbox User or MEC App, I use this notification to periodicaly monitor the geo-location of a specific device or set of devices.  |
| [/subscriptions/zonalTraffic](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs013-location-api/raw/v2.1.1/LocationAPI.yaml#/location/zonalTrafficSubGET) | Subscription related to changes for a zone:  users (devices) entering zone, exiting zone, transition across access points within a zone. <br><br>  Input = <ul><li> zoneId </li><li> interestRealm </li><li> userEventCriteria </li><li> duration of reporting </li></ul> | Notification == Zonal Presence Notification <br><br> As a MEC Sandbox User or MEC Application, I use this notification to monitor changes in a zone.   |
| [/subscriptions/userTracking](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs013-location-api/raw/v2.1.1/LocationAPI.yaml#/location/userTrackingSubGET) | Subscription related to changes of a specific user:  zone enter, zone exit, transition across points of access. <br><br> Input = <ul><li> address (device id, user id), </li><li> userEventCriteria </li></ul> | Notification == Zonal Presence Notification <br><br> As a MEC Sandbox User or MEC Application, I use this notification to track location changes for a specific user (or device). |
| [/subscriptions/zonalStatus](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs013-location-api/raw/v2.1.1/LocationAPI.yaml#/location/zoneStatusSubGET) | Subscription related to changes in zone status:  # of users in a zone, # of users per AP in a zone, etc. <br><br> Input = <ul><li> zoneId </li><li> numberOfUsersZoneThreshold  </li><li> numberOfUsersAPThreshold </li></ul>  | Notification == Zonal Status Notification <br><br> As a MEC Sandbox User or MEC Application, I use this notification to monitor changes in a zone. |
| [/subscriptions/area/circle](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs013-location-api/raw/v2.1.1/LocationAPI.yaml#/location/areaCircleSubGET) <br><br> *New STF599* | Subscription to monitor the location of a specific user (device) or list of users in relation to a circle area, geo-located circle (defined by coordinates and a radius).  <br><br> Subscription input: <ul><li> UE address(s) </li><li> Circle info: latitude, longitude, radius </li><li> accuracy </li><li> criteria: entering, leaving </li><li> check immediately on subscription </li><li> max frequency of reporting </li><li> duration of reporting </li><li> max count (total number of notifications) </li></ul>  | Notification (Subscription Notification) – issued on criteria: <ul><li> UE address </li><li> Current UE Location </li></ul> <br><br>  As a MEC Sandbox User or MEC Application, I use this notification to monitor a specific location area of my choosing (circle area) in relation to a device or set of devices, also of my choosing.    |
| [/subscriptions/distance](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs013-location-api/raw/v2.1.1/LocationAPI.yaml#/location/distanceSubGET) <br><br> *New STF599* | Subscription to monitor the distance of a specific set of user devices (UE), towards another set of user devices.  <br><br> Subscription input: <ul><li> reference address(s) </li><li> monitored address(s) </li><li> distance </li><li> accuracy </li><li> criteria: all within, any within, all beyond, all beyond </li><li> check immediately on subscription </li><li> max frequency of reporting </li><li> duration of reporting </li><li> max count (total number of notifications) </li></ul> | Notification (Subscription Notification) – issued on criteria: <ul><li> address and current location for all UEs (reference and monitored) </li><li> notification criteria: all within, any within, all beyond, all beyond </li></ul> <br><br>  As a MEC Sandbox User or MEC Application, I use this notification to monitor the distance status between two user devices (UEs or terminals) or two sets if user devices.  |
| [/subscriptions/periodic](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs013-location-api/raw/v2.1.1/LocationAPI.yaml#/location/periodicSubGET)<br><br> *New STF599* | Subscription to monitor the location of a specific set of user devices (UE).  <br><br>Subscription input: <ul><li> UE address(s) </li><li> max frequency of reporting </li><li> duration or reporting </li><li> max count (total number of notifications) </li></ul> | Notification (Subscription Notification) issued on criteria: period (frequency), duration, total # of notifications. <br><br>  As a MEC Sandbox User or MEC Application, I use this notification to periodicaly monitor the geo-location of a specific device or set of devices.  |


+4 −0
Original line number Diff line number Diff line
@@ -4,6 +4,10 @@ This section describes a use case that the user can accomplish using the MEC San

Objective:
  * As a MEC Sandbox User, I have a MEC Application that can execute in different MEC platforms with different localities within the Sandbox emulated edge network.
    * `mep1` locality is Zone 1 & 2
    * `mep2` locality is Zone 3 & 4
  * MEC Application can register in one of the MEC platform to discover available MEC services available via the local MEP
  * MEC Application learns that
    * Location service is available at the _ZONE_GROUP_ level
      * total of 2 instances; 1 instance per MEC platform
    * RNIS, WAIS are available at the _MEC_SYSTEM_ level