diff --git a/documentation/API_documentation/README.MD b/documentation/API_documentation/README.MD deleted file mode 100644 index 5a4ac93..0000000 --- a/documentation/API_documentation/README.MD +++ /dev/null @@ -1 +0,0 @@ -Here you can add your documentation and delete this README.MD file diff --git a/documentation/API_documentation/home_devices_qod_user_stories.md b/documentation/API_documentation/home_devices_qod_user_stories.md new file mode 100644 index 0000000..c6598ba --- /dev/null +++ b/documentation/API_documentation/home_devices_qod_user_stories.md @@ -0,0 +1,11 @@ +**User Story: Configure traffic profile (DSCP)** +
+ +| **Item** | **Details** | +| ---- | ------- | +| ***Summary*** | As an application developer belonging to an enterprise, I want to request (using my application server/backend service) specific traffic profiles (DSCP marks) to be configured at my end-user’s residential home WiFi Access Point in order to ensure the Quality of Experience I need for my service/app. | +| ***Roles, Actors and Scope*** | **Roles:** Customer:User
**Actors:** Application service providers, hyperscalers, application developers.
**Scope:** Configure traffic profiles to ensure needed Quality of Experience for a given device within a Residential LAN | +| ***Pre-conditions*** |The preconditions are listed below:
  1. The End-user is connected to a Residential WiFi Access Point.
  2. The End-user is running an application/service developed by the Customer (Application Developer) that includes calls to the API.
  3. Security and Privacy requirements are fulfilled as defined in Commonalities.
| +| ***Activities/Steps*** | **Starts when:** The server/backend service calls the API specifying the traffic profile (DSCP) required and the target device.
**Ends when:** The requested traffic profile (DSCP) has been configured and the server/backend has being informed about it.
| +| ***Post-conditions*** | Traffic profile (DSCP) is applied and Customer (Application Developer) app/service continues. | +| ***Exceptions*** | Several exceptions might occur during the Home Devices QoS API operations
|