Skip to content

Commit

Permalink
Add notes on 2- and 3-legged token use
Browse files Browse the repository at this point in the history
  • Loading branch information
eric-murray authored Jun 24, 2024
1 parent 489d401 commit 7cce24b
Showing 1 changed file with 19 additions and 5 deletions.
24 changes: 19 additions & 5 deletions code/API_definitions/quality-on-demand.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -105,10 +105,11 @@ paths:
A `QOS_STATUS_CHANGED` event notification with `qosStatus` as `UNAVAILABLE` will also be send if the network terminates the session before the requested duration expired
NOTE: in case of a `QOS_STATUS_CHANGED` event with `qosStatus` as `UNAVAILABLE` and `statusInfo` as `NETWORK_TERMINATED` the resources of the QoS session are not directly released, but will get deleted automatically at earliest 360 seconds after the event.
This behavior allows clients which are not receiving notification events but are polling to get the session information with
the `qosStatus` `UNAVAILABLE` and `statusInfo` `NETWORK_TERMINATED`. Before a client can attempt to create a new QoD session
for the same device and flow period they must release the session resources with an explicit `delete` operation if not yet automatically deleted.
**NOTES:**
- In case of a `QOS_STATUS_CHANGED` event with `qosStatus` as `UNAVAILABLE` and `statusInfo` as `NETWORK_TERMINATED` the resources of the QoS session are not directly released, but will get deleted automatically at earliest 360 seconds after the event.
This behavior allows clients which are not receiving notification events but are polling to get the session information with the `qosStatus` `UNAVAILABLE` and `statusInfo` `NETWORK_TERMINATED`. Before a client can attempt to create a new QoD session for the same device and flow period they must release the session resources with an explicit `delete` operation if not yet automatically deleted.
- The access token may be either 2-legged or 3-legged. If a 3-legged access token is used, the end user identified by the `device` parameter must also be associated with the access token.

Check failure on line 112 in code/API_definitions/quality-on-demand.yaml

View workflow job for this annotation

GitHub Actions / MegaLinter

112:196 [trailing-spaces] trailing spaces
operationId: createSession
security:
Expand Down Expand Up @@ -274,7 +275,12 @@ paths:
tags:
- QoS Sessions
summary: Get QoS session information
description: Querying for QoS session resource information details
description: |
Querying for QoS session resource information details
**NOTES:**
- The access token may be either 2-legged or 3-legged. If a 3-legged access token is used, the end user associated with the session must also be associated with the access token.
operationId: getSession
security:
- openId:
Expand Down Expand Up @@ -326,6 +332,10 @@ paths:
- `qosStatus` as `UNAVAILABLE` and
- `statusInfo` as `DELETE_REQUESTED`
There will be no notification event if the `qosStatus` was already `UNAVAILABLE`.
**NOTES:**
- The access token may be either 2-legged or 3-legged. If a 3-legged access token is used, the end user associated with the session must also be associated with the access token.
operationId: deleteSession
security:
- openId:
Expand Down Expand Up @@ -369,6 +379,10 @@ paths:
- Previous duration: 30,000 seconds
- Requested additional duration: 30,000 seconds
- New overall session duration: 50,000 seconds (the maximum allowed)
**NOTES:**
- The access token may be either 2-legged or 3-legged. If a 3-legged access token is used, the end user associated with the session must also be associated with the access token.
operationId: extendQosSessionDuration
security:
- openId:
Expand Down

0 comments on commit 7cce24b

Please sign in to comment.