-
Notifications
You must be signed in to change notification settings - Fork 2
Description
Problem description
The Network Access Management (NAM) API is ready for its first alpha pre-release (v0.1.0-alpha.1). This release reflects a significant refactor from the original "Isolated Networks" design to a "Trust Domains" model, addressing the architectural and compliance feedback received during the Fall25 meta-release review (PR #73). The review feedback was consolidated in issue #77.
The API enables management of network operator-supplied network access devices, with this release focusing on two primary capabilities:
-
Trust Domain Management — CRUD operations for creating, configuring, and managing logically separated LAN configurations (Trust Domains) on network access devices. Trust Domains support multiple access types including Wi-Fi (WPA Personal/Enterprise) and Thread (Structured/TLV), with configurable policies for device limits, bandwidth control, and egress restrictions. A capabilities discovery endpoint allows API consumers to query provider-supported configurations before creating Trust Domains.
- We have recognized that the capabilities discovery endpoint aligns with the intent of the Capabilities and Runtime Restrictions API and looking at how to deprecate this bespoke discovery endpoint in view of their more generalized solution.
-
Reboot Request Management — CRUD operations for creating and managing reboot requests targeting network access devices, supporting both immediate and scheduled execution with explicit or inferred device targeting.
Supporting resources include Services (representing subscriber/operator commercial relationships) and Network Access Devices (operator-supplied equipment inventory).
Expected action
Prepare and publish the first alpha pre-release of the Network Access Management API:
Release details:
- API version:
0.1.0-alpha.1 - URL version:
v0alpha1 - Release tag:
r1.1 - Release label:
pre-release
Release PR scope:
- Update version fields in the OAS spec (remove
wip) - Update server URL from
vwiptov0alpha1 - Update all repository links to reference the release tag (no
mainpaths, no relative links) - Complete the
NAM-API-Readiness-Checklist.md - Create/update
CHANGELOG.mddocumenting changes since the initial contribution - Update
README.mdas needed - Request review from
camaraproject/release-management_maintainers
Changes addressed since Fall25 meta-release review:
- Refactored core API model from "Isolated Networks" to "Trust Domains" (#77)
- Reduced security scope granularity (#78)
- Removed forbidden
contactfield frominfoobject - Added mandatory
externalDocssection - Corrected
x-camara-commonalitiesversion format - Corrected server URL format
- Added mandatory
info.descriptionsections (Authorization and authentication, Additional CAMARA error responses) - Addressed Herbert Damker's feedback regarding 501 usage by scoping the single spec to focus on Trust Domain and Reboot Request functionality rather than a monolithic interface with many optional endpoints
- Additional compliance refinements per review documents attached to PR #73
Operations included in this release:
| Tag | Operation | Method | Path |
|---|---|---|---|
| Services | getServices | GET | /services |
| Services | getService | GET | /services/{serviceId} |
| Trust Domains | getTrustDomainCapabilities | GET | /trust-domains/capabilities |
| Trust Domains | createTrustDomain | POST | /trust-domains |
| Trust Domains | getTrustDomains | GET | /trust-domains |
| Trust Domains | getTrustDomain | GET | /trust-domains/{trustDomainId} |
| Trust Domains | updateTrustDomain | PATCH | /trust-domains/{trustDomainId} |
| Trust Domains | deleteTrustDomain | DELETE | /trust-domains/{trustDomainId} |
| Reboot Requests | getNetworkAccessDevices | GET | /network-access-devices |
| Reboot Requests | getNetworkAccessDevice | GET | /network-access-devices/{networkAccessDeviceId} |
| Reboot Requests | createRebootRequest | POST | /reboot-requests |
| Reboot Requests | getRebootRequests | GET | /reboot-requests |
| Reboot Requests | getRebootRequest | GET | /reboot-requests/{rebootRequestId} |
| Reboot Requests | updateRebootRequest | PATCH | /reboot-requests/{rebootRequestId} |
| Reboot Requests | deleteRebootRequest | DELETE | /reboot-requests/{rebootRequestId} |
Additional context
Commonalities alignment:
This release targets alignment with Commonalities r3.4 (v0.6.1).
Repository structure:
The current repository includes a bundled YAML and a Redocly configuration that were part of an experiment with CAMARA_common.yaml consumption and multi-file bundling strategies. This experimentation informed Commonalities issue #577, which is actively discussing schema consumption approaches for CAMARA APIs. As that proposal has not yet been formalized, the repository structure for this alpha release retains the current layout. We welcome guidance from the community on whether repo structure changes should be addressed for this alpha or deferred until the Commonalities proposal matures in a future release cycle.
Not targeting Spring '26 meta-release:
This alpha pre-release is intended for early community feedback and is not targeting inclusion in the Spring '26 meta-release. Future release-candidate and public releases will target meta-release alignment as the API matures.
Related issues and PRs:
- PR #73 — Fall25 meta-release review PR with original feedback
- Issue #77 — Consolidated review feedback and tasking
- Commonalities #577 — CAMARA_common.yaml consumption and bundling discussion