Commit e08f7ebd authored by Ayesha Ayub's avatar Ayesha Ayub
Browse files

add MEC015.md file

parent a5380273
Loading
Loading
Loading
Loading
+45 −0
Original line number Original line Diff line number Diff line
# MEC015 - Traffic Management Service
> _New STF625_

MEC015 v2.2.1 is divided in two distinct APIs:
- MEC Bandwidth Management API
- MEC Traffic Steering API

The following tables list MEC Sandbox supported endpoints for each MEC015 API.

### Bandwidth Management API
|Supported | Endpoint |  Notes:   |
| --------| -------- | -------- |
| yes | `/bw_allocations` | |
| yes | `/bw_allocations/{allocationId}` | |

### Traffic Steering API
|Supported | Endpoint |  Notes:   | 
| --------| -------- | -------- | 
| yes | `/mts_capability_info` | |
| yes | `/mts_sessions` | |
| yes | `/mts_sessions/{sessionId}` | |

_NOTE TODO


------
## MEC015 v2.2.1 (not published)
References:
* https://www.etsi.org/deliver/etsi_gs/MEC/001_099/015/02.02.01_60/gs_mec015v020201p.pdf
* https://forge.etsi.org/rep/mec/gs015-bandwith-mgmt-api/-/tree/v2.2.1
* https://forge.etsi.org/rep/mec/gs015-bandwith-mgmt-api/-/blob/v2.2.1/BwManagementApi.yaml
* https://forge.etsi.org/rep/mec/gs015-bandwith-mgmt-api/-/blob/v2.1.1/TrafficSteeringApi.yaml

### Bandwidth Management API Endpoints
| Endpoint | Sandbox Usage |Notes |
| ---------- | --------------------- | -------------- |
| [/bw_allocations](https://forge.etsi.org/rep/mec/gs015-bandwith-mgmt-api/-/blob/v2.2.1/BwManagementApi.yaml#/bwm)  | GET - Retrieve information about a list of bandwidthAllocation resources <br><br> Query input: <ul><li> app_instance_id :  Retrieve information about a list of bandwidthAllocation associated with appInsId <li> app_name : Retrieve information about a list of bandwidthAllocation associated with appName <li> session_id : Retrieve information about a list of bandwidthAllocation associated with allocationId <li> If no query parameter passed, it returns with the list of all the bandwidth allocation resources </ul> <br><br> POST -  Create a bandwidthAllocation resource <br><br>Returns a bandwidth allocation resource information along with unique allocationId.| As a MEC Sandbox user, I use this endpoint to list down all the bandwidth allocation resource allocation with/without using query parameters <br><br> As a MEC Sandbox user, I use this endpoint to create a bandwidth allocation resource allocation based on requestType (Application / Session Specific allocation), allocationDirection (uplink/downlink/symmetrical), sessionFilter, fixedAllocation values and allocate each resource with a unique allocationId | 
| [/bw_allocations/{allocationId}](https://forge.etsi.org/rep/mec/gs015-bandwith-mgmt-api/-/blob/v2.2.1/BwManagementApi.yaml#/bwm)  |   GET -  Retrieve information about a specific bandwidthAllocation  <br><br> Returns specific bandwidth allocation resource information <br><br> PUT  -   Update the information about a specific bandwidthAllocation <br><br> PATCH - Modify the information about a specific existing bandwidthAllocation by sending updates on the data structure. <br><br> Returns an updated bandwidth allocation resource information for both PUT/PATCH method <br><br> DELETE - Remove a specific bandwidthAllocation      | <br><br> **As a MEC Sandbox user, I use this endpoint to update/retrieve/delete a specific bandwidth allocation resource** <br><br>  As a MEC Sandbox user, I use this endpoint to retrieve bandwidth allocation resource information of specific allocationId.  <br><br> As a MEC Sandbox user, I use this endpoint to update/replace a bandwidth resource allocation information for a specific allocationId with the requested changes of BwInfo type. <br><br> As a MEC Sandbox user, I use this endpoint to partially update a bandwidth resource allocation information for a specific allocationId with the requested changes in BwInfoDelta type, In which user is allowed to change some of the attributes.  <br><br>  As a MEC Sandbox user, I use this endpoint to delete bandwidth allocation resource information of specific allocationId.

### Traffic Steering API Endpoints
| Endpoint | Sandbox Usage |Notes |
| ---------- | --------------------- | -------------- |
| [/mts_capability_info](https://forge.etsi.org/rep/mec/gs015-bandwith-mgmt-api/-/blob/v2.1.1/TrafficSteeringApi.yaml#/mts)  |  GET - Retrieve the MTS capability information
| [/mts_sessions](https://forge.etsi.org/rep/mec/gs015-bandwith-mgmt-api/-/blob/v2.1.1/TrafficSteeringApi.yaml#/mts)  | GET -   Retrieve information about specific MTS session <br><br> PUT    -   Update the information about specific MTS session <br><br>  DELETE  -    Remove specific MTS session
| [/mts_sessions/{sessionId}](https://forge.etsi.org/rep/mec/gs015-bandwith-mgmt-api/-/blob/v2.1.1/TrafficSteeringApi.yaml#/mts)  | GET -  Retrieve information about a list of MTS sessions <br><br> POST -  Create a MTS session