CAMARA Home Devices Quality on Demand API as published on the GSMA Open Gateway developer portal. Requests a prioritised quality-of-service profile for a device on a fixed or home broadband connection rather than a mobile connection. OpenAPI 3.0.3, version 0.4.0, 1 path(s) and 1 operation(s); authorization is OpenID Connect (openIdConnect security scheme) with per-operation CAMARA scopes.
openapi: 3.0.3
info:
title: Home Devices QoD
description: |
Service Enabling Network Function API for *QoS-on-demand* (QoD) control applied to devices connected to the user's home network. API clients can request to change, on demand, the desired QoS behaviour for the IP traffic corresponding to a specific user home device. The QoS behaviour is determined by the Service Class provided by the API Client, which is mapped to a DSCP value according to [RFC4594](https://datatracker.ietf.org/doc/html/rfc4594) guidelines.
# Introduction
It may be useful for application developers to request on-demand QoS behaviours (service classes) to be configured at the user's home WiFi access point to ensure the required quality of experience for those services/applications running on a specific home device.
For example, the QoD control capability could be useful in scenarios such as:
- A user using head-mounted display device for VR/AR applications. VR/AR applications require high bandwidth for the big amount of data to be streamed.
- A user using VoIP application in a home device. Lower latency improves call quality or avoids dropped calls.
Generally speaking, QoS on demand may improve the qualty of experience for real time services like Videocomms, Cloud Gaming and Virtual Reality.
# Relevant terms and definitions
- **Home Device**:
User device connected to the user's home network.
- **Service Class**:
A statement of the required QoS characteristics of a traffic aggregate. Conceptually, a service class refers to applications with similar characteristics and performance requirements.
- **DSCP**:
*Differentiated Services (DiffServ) Code Point*. DiffServ is a simple and scalable mechanism for classifying and managing network traffic and providing quality of service (QoS) on IP networks. The DSCP value will be used to classify the traffic of the target home device in order to be treated accordingly.
# API Functionality
This API allows to third party clients to set, on demand, the desired QoS behaviour (service class) associated to the traffic of the device connected to the user's home network that matches the input criteria provided. The device traffic is classified (by DSCP) and treated accordingly.
- **NOTE: The scope of the API is as follows**:
- QoS treatment is applied to a target user device **only within the user's home network** (i.e., between the device and the home router)
- QoS treatment **only applies to downstream IP traffic** (i.e., from the home router to the target device)
- QoS treatment **only applies to home devices using WiFi access** (i.e., home router WiFi interface)
The API provides a single endpoint/operation:
- Set the desired QoS behaviour for a user home device.
# Authorization and authentication
The "Camara Security and Interoperability Profile" provides details on how a client requests an access token. Please refer to Identify and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the Profile.
Which specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation.
It is important to remark that in cases where personal user data is processed by the API, and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of 3-legged access tokens becomes mandatory. This measure ensures that the API remains in strict compliance with user privacy preferences and regulatory obligations, upholding the principles of transparency and user-centric data control.
In the case of the Home Devices QoD API scenario and according to the API definition, 3-legged access tokens must be used by API clients to invoke this API with dedicated scope. The API client must authenticate on behalf of a specific user to use this service. This can be done via IP-based authentication (i.e. using the public IP of the device in this case).
The 3-legged access of the Home Devices QoD API could also be combined with end-user consent management, depending on the legal basis applied. User consent would be required before personal data is processed by API clients for a specific purpose.
# Further info and support
(FAQs will be added in a later version of the documentation)
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: 0.4.0
x-camara-commonalities: 0.4.0
servers:
- url: "{apiRoot}/home-devices-qod/v0.4"
variables:
apiRoot:
default: http://localhost:9091
description: API root, defined by the service provider, e.g. `api.example.com` or `api.example.com/somepath`
paths:
/qos:
put:
summary: Set the desired QoS behaviour for a user home device
description: |
Set the desired QoS behaviour for the traffic corresponding to the user home device matching the input criteria. **QoS behaviour is determined by the service class provided by the API Client. Setting `standard` service class restores default traffic treatment for the target home device.**
- The operation is executed for the user whose `sub` is in the access token used to call this endpoint, and for the home network also deducted from the information included in the access token.
- The target user device is identified by the internal IP address of that device in the home network.
- In case there is no device matching the input criteria, the operation returns a 404 error.
tags:
- Home Devices QoD
operationId: setQos
parameters:
- $ref: "#/components/parameters/x-correlator"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/QosOnDemandUpdate"
example:
serviceClass: real_time_interactive
ipAddress: 192.168.1.27
required: true
responses:
"204":
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
description: Requested QoS passed all validations and was applied
"400":
$ref: "#/components/responses/Generic400"
"401":
$ref: "#/components/responses/Generic401"
"403":
$ref: "#/components/responses/setQosPermissionDenied403"
"404":
$ref: "#/components/responses/setQosNotFound404"
"409":
$ref: "#/components/responses/setQosConflict409"
"500":
$ref: "#/components/responses/Generic500"
"503":
$ref: "#/components/responses/setQosServiceUnavailable503"
"504":
$ref: "#/components/responses/Generic504"
components:
schemas:
QosOnDemandUpdate:
type: object
description: Payload to change the QoS behaviour associated to a home device.
required:
- serviceClass
- ipAddress
properties:
serviceClass:
type: string
description: |
The name of the service class requested by the API client. It is associated with QoS behaviours optimised for a particular application type. Each service class is mapped to a DSCP value according to [RFC4594](https://datatracker.ietf.org/doc/html/rfc4594) guidelines. The DSCP value is used to classify the target home device's traffic so that it can be treated accordingly (i.e. to meet its QoS needs).
The following service classes are supported:
| Service Class Name | DSCP Name | DSCP value (decimal) | DCSP value (binary) | Application Examples |
|-----------------------|-----------|----------------------|---------------------|-----------------------------------------------|
| Real-Time Interactive | CS4 | 32 | 100000 | Video conferencing and Interactive gaming |
| Multimedia Streaming | AF31 | 26 | 011010 | Streaming video and audio on demand |
| Broadcast Video | CS3 | 24 | 011000 | Broadcast TV & live events |
| Low-Latency Data | AF21 | 18 | 010010 | Client/server transactions Web-based ordering |
| High-Throughput Data | AF11 | 10 | 001010 | Store and forward applications |
| Low-Priority Data | CS1 | 8 | 001000 | Any flow that has no BW assurance |
| Standard | DF(CS0) | 0 | 000000 | Undifferentiated applications |
enum:
- real_time_interactive
- multimedia_streaming
- broadcast_video
- low_latency_data
- high_throughput_data
- low_priority_data
- standard
example: real_time_interactive
ipAddress:
type: string
format: ipv4
description: Internal IP address of the connected device in the LAN.
example: 192.168.1.27
ErrorInfo:
type: object
required:
- message
- status
- code
properties:
message:
type: string
description: A human readable description of what the event represent
status:
type: integer
description: HTTP response status code
code:
type: string
description: Friendly Code to describe the error
responses:
Generic400:
description: Bad Request
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorInfo"
example:
status: 400
code: INVALID_ARGUMENT
message: Client specified an invalid argument, request body or query param
Generic401:
description: Unauthorized
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorInfo"
example:
status: 401
code: UNAUTHENTICATED
message: Request not authenticated due to missing, invalid, or expired credentials
setQosPermissionDenied403:
description: Forbidden
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorInfo"
examples:
PermissionDenied:
value:
status: 403
code: PERMISSION_DENIED
message: Client does not have sufficient permissions to perform this action
InvalidTokenContext:
value:
status: 403
code: INVALID_TOKEN_CONTEXT
message: User home network cannot be deducted from access token context
setQosNotFound404:
description: Not found
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorInfo"
examples:
NotFound:
value:
status: 404
code: NOT_FOUND
message: The specified resource is not found
NoDeviceMatch:
value:
status: 404
code: DEVICE_NOT_FOUND
message: No connected device found for the input criteria provided
setQosConflict409:
description: Conflict
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorInfo"
examples:
Conflict:
value:
status: 409
code: CONFLICT
message: Conflict with the current state of the target resource
TooManyDevices:
value:
status: 409
code: HOME_DEVICES_QOD.TOO_MANY_DEVICES
message: Exceeded the maximum quantity of devices with non-default QoS behaviour
RssiBelowThreshold:
value:
status: 409
code: HOME_DEVICES_QOD.RSSI_BELOW_THRESHOLD
message: RSSI from device is below allowed threshold
QosTooHigh:
value:
status: 409
code: HOME_DEVICES_QOD.QOS_TOO_HIGH
message: Requested QoS is higher than the maximum QoS allowed
OccupancyAboveThreshold:
value:
status: 409
code: HOME_DEVICES_QOD.OCCUPANCY_ABOVE_THRESHOLD
message: The occupancy is above the allowed threshold
NotConnectedToRequiredInterface:
value:
status: 409
code: HOME_DEVICES_QOD.NOT_CONNECTED_TO_REQUIRED_INTERFACE
message: Device is not connected to the required interface (e.g. WiFi 5GHz interface)
NotSupportedRequiredInterface:
value:
status: 409
code: HOME_DEVICES_QOD.NOT_SUPPORTED_REQUIRED_INTERFACE
message: Device does not support required interface (e.g. WiFi 5GHz interface)
QosAlreadySetToDefault:
value:
status: 409
code: HOME_DEVICES_QOD.QOS_ALREADY_SET_TO_DEFAULT
message: Device QoS is already set to default value
Generic500:
description: Internal Server Error
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorInfo"
example:
status: 500
code: INTERNAL
message: Server error
setQosServiceUnavailable503:
description: Service Unavailable
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorInfo"
examples:
Unavailable:
value:
status: 503
code: UNAVAILABLE
message: Service Unavailable
RouterOffline:
value:
status: 503
code: HOME_DEVICES_QOD.ROUTER_OFFLINE
message: Router is not online. Try it later
Generic504:
description: Gateway Timeout
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorInfo"
example:
status: 504
code: TIMEOUT
message: Request timeout exceeded
parameters:
x-correlator:
name: x-correlator
in: header
description: Correlation id for the different services
schema:
type: string
headers:
x-correlator:
description: Correlation id for the different services
schema:
type: string
securitySchemes:
openId:
description: |
OpenID Connect 3-legged access tokens must be used by API clients to invoke this API with dedicated scope. The API client must authenticate on behalf of a specific user to use this service. This can be done via IP-based authentication (i.e. using the public IP of the device in this case).
The 3-legged access of the Home Devices QoD API could also be combined with end-user consent management, depending on the legal basis applied. User consent would be required before personal data is processed by API clients for a specific purpose.
type: openIdConnect
openIdConnectUrl: https://example.com/.well-known/openid-configuration
security:
- openId:
- home-devices-qod:qos:write
tags:
- name: Home Devices QoD
description: QoD control operations for home devices
externalDocs:
description: Project documentation at CAMARA
url: https://github.com/camaraproject/HomeDevicesQoD