Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update from notificationsUri to notificationsUrl #89

Merged
merged 1 commit into from
Jan 18, 2023
Merged

Update from notificationsUri to notificationsUrl #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions code/API_definitions/qod-api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 6 additions & 6 deletions documentation/API_documentation/QoD_API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ Following table defines API endpoints of exposed REST based for QoD management o
<td>Qualifier for the requested latency/throughput profile, e.g. QOS_E</td>
</tr>
<tr>
<td><b>notificationUri (optional)</b></td>
<td><b>notificationUrl (optional)</b></td>
<td>URI of the callback receiver. Allows asynchronous delivery of session related events, e.g. 'https://application-server.com/notifications'</td>
</tr>
<tr>
Expand All @@ -166,7 +166,7 @@ Following table defines API endpoints of exposed REST based for QoD management o
<b>uePorts (optional):</b> The requested port(s) on the user equipment<br>
<b>asPorts (optional):</b> The requested port(s) on the application server<br>
<b>qos:</b> Qualifier of the requested throughput profile<br>
<b>notificationUri (optional):</b> URI of the callback receiver<br>
<b>notificationUrl (optional):</b> URL of the callback receiver<br>
<b>notificationAuthToken (optional):</b> Authentication token for callback API<br>
<b>id:</b> Session ID in UUID format, e.g. 123e4567-e89b-12d3-a456-426614174000<br>
<b>startedAt:</b> Timestamp of session start, in seconds since Unix epoch, e.g. 1639479600<br>
Expand Down Expand Up @@ -231,7 +231,7 @@ Following table defines API endpoints of exposed REST based for QoD management o
<b>uePorts (optional):</b> The requested port(s) on the user equipment<br>
<b>asPort (optional):</b> The requested port(s) on the application server<br>
<b>qos:</b> Qualifier of the requested QoS profile<br>
<b>notificationUri (optional):</b> URI of the callback receiver<br>
<b>notificationUrl (optional):</b> URL of the callback receiver<br>
<b>notificationAuthToken (optional):</b> Authentication token for callback API<br>
<b>id:</b> Session ID in UUID format<br>
<b>startedAt:</b> Timestamp of session start in seconds since Unix epoch<br>
Expand Down Expand Up @@ -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` <br> -H 'accept: application/json' <br> -H 'Content-Type: application/json'<br> -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...."<br> -d '{<br> "ueId": {"ipv6Addr": "2001:db8:85a3:8d3:1319:8a2e:370:7344"},<br> "asId": {"ipv4Addr": "54.204.25.0/28"},<br> "asPorts": "33001",<br> "qos": "QOS_E",<br> "notificationUri": `https://your-callback-server.com/notifications`,<br> "notificationAuthToken": "c8974e592c2fa383d4a3960714"<br> }' |
| Snippet 1. Create QoS session resource |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| curl -X 'POST' `https://sample-base-url/qod/v0/sessions` <br> -H 'accept: application/json' <br> -H 'Content-Type: application/json'<br> -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...."<br> -d '{<br> "ueId": {"ipv6Addr": "2001:db8:85a3:8d3:1319:8a2e:370:7344"},<br> "asId": {"ipv4Addr": "54.204.25.0/28"},<br> "asPorts": "33001",<br> "qos": "QOS_E",<br> "notificationUrl": `https://your-callback-server.com`,<br> "notificationAuthToken": "c8974e592c2fa383d4a3960714"<br> }' |
<br>
Snippet 2, elaborates sample QoS notification "SESSION_TERMINATION" message distributed from QoD backend to client callback function.

Expand Down