Skip to content

Commit

Permalink
Update documentation/API_documentation/QoD_User_Story.md
Browse files Browse the repository at this point in the history
Co-authored-by: Eric Murray <[email protected]>
  • Loading branch information
hdamker and eric-murray authored Aug 29, 2024
1 parent 53a8c51 commit 39236d7
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion documentation/API_documentation/QoD_User_Story.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

| **Item** | **Details** |
| ---- | ------- |
| ***Summary*** | As an application developer belonging to an enterprise, I want to request (using my application server/backend service), stable latency or stable throughput for a specified App-Flow from a Communication Service Provider (CSP), so that I can ensure better quality of experience for our end users including under network congestion. |
| ***Summary*** | As an application developer belonging to an enterprise, I want to request (using my application server/backend service), stable latency and/or stable throughput for a specified App-Flow from a Communication Service Provider (CSP), so that I can ensure better quality of experience for our end users including under network congestion. |
| ***Roles, Actors and Scope*** | **Roles:** Customer:Developer<br> **Actors:** Application service providers, hyperscalers, application developers. This User Story does not explicitly describe consent management and hence end users are not included as Actors.<br> **Scope:** *Order To Activate (OTA)* \- Create/Remove/Get service instance (QoD session resource)\, get notification about the instance (QoD session resource) |
| ***Pre-conditions*** | The preconditions are listed below:<br><ol><li>Customer:Developer is eligible to use the QoD API, i.e. the Customer has successfully subscribed to the QoD API on the platform of an API Provider</li><li>the customer application server has requested and received an access token for the required scopes of the API. Which specific authorization flows are to be used will be determined during onboarding process.</li><li>Optional: the customer application server has requested the list of available QoS Profiles with the qos-profile API (alternatively an upfront agreed QoS profile will be used)|
| ***Activities/Steps*** | **Starts when:** The customer application server makes a POST request to the QoD API to create a new QoD session resource with a specified duration and an available QoS Profile, and optionally registers a callback URL for receiving notification events.<br>**Ends when:** The customer application server makes a DELETE request to the QoD API, or the QoD session resource deletion was triggered automatically either because the set duration has expired or the session was terminated by the network (e.g. due to lack of resources). |
Expand Down

0 comments on commit 39236d7

Please sign in to comment.