From 137da35528b48a7539c387ee48f31eec1e1f96c9 Mon Sep 17 00:00:00 2001 From: Maximilian Laue Date: Tue, 17 Jan 2023 11:29:40 +0100 Subject: [PATCH] feat: update to notificationsUrl and QoD_API.md --- code/API_definitions/qod-api.yaml | 4 ++-- documentation/API_documentation/QoD_API.md | 12 ++++++------ 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/code/API_definitions/qod-api.yaml b/code/API_definitions/qod-api.yaml index b83e20ce19..e502229948 100644 --- a/code/API_definitions/qod-api.yaml +++ b/code/API_definitions/qod-api.yaml @@ -265,10 +265,10 @@ components: $ref: "#/components/schemas/PortsSpec" qos: $ref: "#/components/schemas/QosProfile" - notificationUri: + notificationUrl: type: string format: uri - example: "https://application-server.com/notifications" + example: "https://application-server.com" description: Allows asynchronous delivery of session related events notificationAuthToken: type: string diff --git a/documentation/API_documentation/QoD_API.md b/documentation/API_documentation/QoD_API.md index e47a3f0588..b717817691 100644 --- a/documentation/API_documentation/QoD_API.md +++ b/documentation/API_documentation/QoD_API.md @@ -148,7 +148,7 @@ Following table defines API endpoints of exposed REST based for QoD management o Qualifier for the requested latency/throughput profile, e.g. QOS_E - notificationUri (optional) + notificationUrl (optional) URI of the callback receiver. Allows asynchronous delivery of session related events, e.g. 'https://application-server.com/notifications' @@ -166,7 +166,7 @@ Following table defines API endpoints of exposed REST based for QoD management o uePorts (optional): The requested port(s) on the user equipment
asPorts (optional): The requested port(s) on the application server
qos: Qualifier of the requested throughput profile
- notificationUri (optional): URI of the callback receiver
+ notificationUrl (optional): URL of the callback receiver
notificationAuthToken (optional): Authentication token for callback API
id: Session ID in UUID format, e.g. 123e4567-e89b-12d3-a456-426614174000
startedAt: Timestamp of session start, in seconds since Unix epoch, e.g. 1639479600
@@ -231,7 +231,7 @@ Following table defines API endpoints of exposed REST based for QoD management o uePorts (optional): The requested port(s) on the user equipment
asPort (optional): The requested port(s) on the application server
qos: Qualifier of the requested QoS profile
- notificationUri (optional): URI of the callback receiver
+ notificationUrl (optional): URL of the callback receiver
notificationAuthToken (optional): Authentication token for callback API
id: Session ID in UUID format
startedAt: Timestamp of session start in seconds since Unix epoch
@@ -334,9 +334,9 @@ N/A Please note, the credentials for API authentication purposes need to be adjusted based on target security system configuration. -| Snippet 1. Create QoS session resource | -| ----------------------------------------------- | -| curl -X 'POST' `https://sample-base-url/qod/v0/sessions`
-H 'accept: application/json'
-H 'Content-Type: application/json'
-H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...."
-d '{
"ueId": {"ipv6Addr": "2001:db8:85a3:8d3:1319:8a2e:370:7344"},
"asId": {"ipv4Addr": "54.204.25.0/28"},
"asPorts": "33001",
"qos": "QOS_E",
"notificationUri": `https://your-callback-server.com/notifications`,
"notificationAuthToken": "c8974e592c2fa383d4a3960714"
}' | +| Snippet 1. Create QoS session resource | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| curl -X 'POST' `https://sample-base-url/qod/v0/sessions`
-H 'accept: application/json'
-H 'Content-Type: application/json'
-H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...."
-d '{
"ueId": {"ipv6Addr": "2001:db8:85a3:8d3:1319:8a2e:370:7344"},
"asId": {"ipv4Addr": "54.204.25.0/28"},
"asPorts": "33001",
"qos": "QOS_E",
"notificationUrl": `https://your-callback-server.com`,
"notificationAuthToken": "c8974e592c2fa383d4a3960714"
}' |
Snippet 2, elaborates sample QoS notification "SESSION_TERMINATION" message distributed from QoD backend to client callback function.