Northbound APIs
Northbound API Component
The northbound/api_component provides an HTTP/2 REST API for third-party applications to interact with the AF.
It mentions JSON-based APIs for QoS management and event subscriptions, and uses YAML for configuration.
Implemented Endpoints
The following HTTP/2 endpoints are currently implemented in the api_adapter:
| Method | Endpoint | Description |
|---|---|---|
GET |
/health |
Health check endpoint. Returns status "up". |
GET |
/version |
Returns component version and build information. |
POST |
/qos |
Request Quality of Service adjustment. |
GET |
/subscriptions |
Retrieve a list of active subscriptions. |
POST |
/subscriptions |
Create a new subscription. |
GET |
/subscriptions/{id} |
Retrieve details of a specific subscription. |
DELETE |
/subscriptions/{id} |
Delete a specific subscription. |
AF Core message types
The AF Core registers handlers for (non-exhaustive):
health_checkqos_requestget_subscriptions,create_subscription,get_subscription,delete_subscriptionqod_create_session,qod_get_session,qod_delete_session,qod_extend_session,qod_retrieve_sessions
HTTP endpoint → internal message mapping
| HTTP request | Internal message type |
|---|---|
GET /health |
health_check |
POST /qos |
qos_request |
POST /subscriptions |
create_subscription |
GET /subscriptions |
get_subscriptions |
GET /subscriptions/{id} |
get_subscription |
DELETE /subscriptions/{id} |
delete_subscription |
POST /device-status/sessions (CAMARA QoD) |
qod_create_session |
GET /device-status/sessions/{id} |
qod_get_session |
DELETE /device-status/sessions/{id} |
qod_delete_session |
See northbound/api_component/src/api_handlers.cpp
for the full mapping and CAMARA compliance for
spec references.