From cd615d5b81395e9add1db0ac9af8320ce1ac5031 Mon Sep 17 00:00:00 2001 From: emil-cheung <90314555+emil-cheung@users.noreply.github.com> Date: Tue, 2 Apr 2024 18:02:23 +0800 Subject: [PATCH] Update qod-api.yaml --- code/API_definitions/qod-api.yaml | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/code/API_definitions/qod-api.yaml b/code/API_definitions/qod-api.yaml index b01354ac88..7ba66924d3 100644 --- a/code/API_definitions/qod-api.yaml +++ b/code/API_definitions/qod-api.yaml @@ -334,7 +334,16 @@ paths: - QoS Sessions summary: "Extend the duration of an active session" description: | - Extend the duration of an active QoS session. If this operation is executed successfully, the new duration of the target session will be the original duration plus the additional duration. The remaining duration plus the requested additional duration shall not exceed the maximum limit. Otherwise, the new remaining duration will be the maximum limit. + Extend the duration of an active QoS session. If this operation is executed successfully, the new duration of the target session will be the original duration plus the additional duration. + + The new remaining duration shall not exceed the maximum duration limit. Otherwise, the new remaining duration will be set to the maximum limit. The remaining duration is calculated as the 'expiresAt' minus the current time of the extendDuration API call. + + An example: A QoD session was orginally created with duration 80,000 seconds. 10,000 seconds later, the deveoper wants to extend the session with 20,000 seconds. + - Original duration: 80,000 seconds + - Elapsed time: 10,000 seconds + - Remaining duration: 70,000 seconds + - New remaining duration: 86,400 seconds + - New duration: 96,400 seconds operationId: extendQosSessionDuration parameters: - name: sessionId