Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
127 changes: 127 additions & 0 deletions CHANGELOG/CHANGELOG-r2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
# Changelog NetworkAccessManagement

<!-- TOC:START -->
## Table of Contents
- [r2.1](#r21)
<!-- TOC:END -->

**Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until it has been released. For example, changes may be reverted before a release is published. For the best results, use the latest published release.**

The below sections record the changes for each API version in each release as follows:

* for an alpha release, the delta with respect to the previous release
* for the first release-candidate, all changes since the last public release
* for subsequent release-candidate(s), only the delta to the previous release-candidate
* for a public release, the consolidated changes since the previous public release

# r2.1

## Release Notes

This pre-release contains the definition and documentation of
* network-access-management 0.2.0-alpha.1

The API definition(s) are based on
* Commonalities 0.8.0-rc.2
* Identity and Consent Management 0.5.0

<!-- BEGIN:AUTOGENERATED:CANDIDATE_CHANGES -->
> **Working area — candidate changes (auto-removed on merge)**
> Copy relevant entries into the Added/Changed/Fixed/Removed sections below.
> You may edit this list while triaging; it will be removed on merge.
> This working-area section is removed automatically when the PR is merged.

<details>
<summary>Candidate changes (auto-generated from merged PRs)</summary>

## What's Changed
* Update README.md by @wrathwolf in https://github.com/camaraproject/NetworkAccessManagement/pull/1
* fix: removes trailing substitution marker from mailing list contact by @caubut-charter in https://github.com/camaraproject/NetworkAccessManagement/pull/3
* Add linting for OpenAPI and Camara guidelines by @RandyLevensalor in https://github.com/camaraproject/NetworkAccessManagement/pull/5
* Change Sub Project name in Readme by @MarkusKuemmerle in https://github.com/camaraproject/NetworkAccessManagement/pull/6
* Adding config files for spectral and yamllint by @RandyLevensalor in https://github.com/camaraproject/NetworkAccessManagement/pull/9
* Moving the linting fixes from init to new PR by @RandyLevensalor in https://github.com/camaraproject/NetworkAccessManagement/pull/11
* chore: adds initial proposal from the backlog working group by @caubut-charter in https://github.com/camaraproject/NetworkAccessManagement/pull/7
* Add benhepworth as maintainer so he can review PRs by @benhepworth in https://github.com/camaraproject/NetworkAccessManagement/pull/23
* Update README.md with meeting info by @wrathwolf in https://github.com/camaraproject/NetworkAccessManagement/pull/24
* Updating mandatory ICM text by @RandyLevensalor in https://github.com/camaraproject/NetworkAccessManagement/pull/21
* fix: standardize errors to track with commonalities by @caubut-charter in https://github.com/camaraproject/NetworkAccessManagement/pull/30
* fix: updates commonalities, icm, and version by @caubut-charter in https://github.com/camaraproject/NetworkAccessManagement/pull/32
* Update Meeting Minutes Link to new location by @benhepworth in https://github.com/camaraproject/NetworkAccessManagement/pull/41
* Update README.md - alignment with current template by @hdamker in https://github.com/camaraproject/NetworkAccessManagement/pull/45
* chore: migrate swagger editor links to CAMARA swagger-ui by @hdamker-bot in https://github.com/camaraproject/NetworkAccessManagement/pull/50
* admin: add line 13 (API description for marketing) to API readiness checklists by @hdamker-bot in https://github.com/camaraproject/NetworkAccessManagement/pull/51
* Add Cody as Maintainer. Swap out Randy for Cody as Owner. by @benhepworth in https://github.com/camaraproject/NetworkAccessManagement/pull/54
* Create user story docs for Isolated Networks and Device Reboot Requests by @clundie-CL in https://github.com/camaraproject/NetworkAccessManagement/pull/55
* 38 operator device capability discovery by @clundie-CL in https://github.com/camaraproject/NetworkAccessManagement/pull/49
* feat: adds deviceStatus field to Device model by @caubut-charter in https://github.com/camaraproject/NetworkAccessManagement/pull/56
* feat: adds the ability to provision a Thread network by @caubut-charter in https://github.com/camaraproject/NetworkAccessManagement/pull/64
* Add section on additional CAMARA error responses by @benhepworth in https://github.com/camaraproject/NetworkAccessManagement/pull/68
* Update Commonalities to 0.6 by @benhepworth in https://github.com/camaraproject/NetworkAccessManagement/pull/69
* Remove IDENTIFIER_MISMATCH from 422 error by @benhepworth in https://github.com/camaraproject/NetworkAccessManagement/pull/67
* Remove 401 AUTHENTICATION_REQUIRED as per commonalities by @benhepworth in https://github.com/camaraproject/NetworkAccessManagement/pull/66
* fix: aligns base Device type with commonalities by @caubut-charter in https://github.com/camaraproject/NetworkAccessManagement/pull/70
* admin: migrate to centralized linting workflows by @hdamker-bot in https://github.com/camaraproject/NetworkAccessManagement/pull/83
* Reset versions in yaml files to 'wip' by @clundie-CL in https://github.com/camaraproject/NetworkAccessManagement/pull/98
* Reconcile release candidate scope with main by @clundie-CL in https://github.com/camaraproject/NetworkAccessManagement/pull/107
* [bulk] Sync Release Information section (2026-02-19-001) by @hdamker-bot in https://github.com/camaraproject/NetworkAccessManagement/pull/111
* Update API Repository wiki page link in README by @hdamker in https://github.com/camaraproject/NetworkAccessManagement/pull/112
* [bulk] Add release-plan.yaml (2026-02-23-001) by @hdamker-bot in https://github.com/camaraproject/NetworkAccessManagement/pull/113
* 115 refactor per commonalities 577 by @clundie-CL in https://github.com/camaraproject/NetworkAccessManagement/pull/117
* 110 add zto device registration by @clundie-CL in https://github.com/camaraproject/NetworkAccessManagement/pull/118
* docs(maintainers): removes stale maintainer by @caubut-charter in https://github.com/camaraproject/NetworkAccessManagement/pull/119
* Move common/ and modules/ up one level under code/ by @clundie-CL in https://github.com/camaraproject/NetworkAccessManagement/pull/121
* [bulk] Enable release automation and validation by @camara-release-automation[bot] in https://github.com/camaraproject/NetworkAccessManagement/pull/125
* 52 create gherkin feature file by @clundie-CL in https://github.com/camaraproject/NetworkAccessManagement/pull/120
* Plan release r2.1 with API network-access-management alpha 0.2.0 by @hdamker in https://github.com/camaraproject/NetworkAccessManagement/pull/126
* Sync common files from Commonalities r4.2 by @camara-release-automation[bot] in https://github.com/camaraproject/NetworkAccessManagement/pull/131
* Feat/wkso bootstrapping by @clundie-CL in https://github.com/camaraproject/NetworkAccessManagement/pull/122
* fix: pin validation caller to tooling S-037 hotfix SHA by @hdamker in https://github.com/camaraproject/NetworkAccessManagement/pull/138

## New Contributors
* @wrathwolf made their first contribution in https://github.com/camaraproject/NetworkAccessManagement/pull/1
* @caubut-charter made their first contribution in https://github.com/camaraproject/NetworkAccessManagement/pull/3
* @RandyLevensalor made their first contribution in https://github.com/camaraproject/NetworkAccessManagement/pull/5
* @MarkusKuemmerle made their first contribution in https://github.com/camaraproject/NetworkAccessManagement/pull/6
* @benhepworth made their first contribution in https://github.com/camaraproject/NetworkAccessManagement/pull/23
* @hdamker made their first contribution in https://github.com/camaraproject/NetworkAccessManagement/pull/45
* @hdamker-bot made their first contribution in https://github.com/camaraproject/NetworkAccessManagement/pull/50
* @camara-release-automation[bot] made their first contribution in https://github.com/camaraproject/NetworkAccessManagement/pull/125

</details>
<!-- END:AUTOGENERATED:CANDIDATE_CHANGES -->

## network-access-management 0.2.0-alpha.1

**network-access-management 0.2.0-alpha.1 is** the first consumable alpha of NAM, providing Trust Domain management, Zero-Touch Onboarding for subscriber devices, and reboot-request operations on operator-supplied network access devices.

- API definition **with inline documentation**:
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NetworkAccessManagement/r2.1/code/API_definitions/network-access-management.yaml&nocors)
- [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NetworkAccessManagement/r2.1/code/API_definitions/network-access-management.yaml)
- OpenAPI [YAML spec file](https://github.com/camaraproject/NetworkAccessManagement/blob/r2.1/code/API_definitions/network-access-management.yaml)

### Added

* Initial Network Access Management API surface:
- **Trust Domains** — CRUD operations for declarative LAN-scoped network configurations, with policy-driven control over device admission, bandwidth, and egress. Capability discovery endpoint (`GET /trust-domains/capabilities`) exposes operator-supported configurations. Wi-Fi (WPA Personal/Enterprise) and Thread (Structured/TLV) access types supported.
- **Trust Domain Devices** — CRUD operations for registering subscriber and IoT devices into Trust Domains with Zero-Touch Onboarding via DPP, Matter, and Well-Known SSID Onboarding (WKSO) bootstrapping protocols (#118, #122).
- **Reboot Requests** — CRUD operations for immediate or scheduled reboot of operator-supplied network access devices.
- **Services** — read-only enumeration of subscriber service instances (`GET /services`, `GET /services/{serviceId}`).
- **Network Access Devices** — read-only enumeration of operator-supplied network access equipment (`GET /network-access-devices`, `GET /network-access-devices/{networkAccessDeviceId}`).
* Basic-tier Gherkin test definitions covering sunny-day scenarios for every operation (#120).
* Local cache of `CAMARA_common.yaml` and a project-local `modules/` directory under `code/`, aligned with the Commonalities Consumption-and-Bundling Design (#117, #121).

### Changed

* Dependency on Commonalities updated to r4.2 (0.8.0-rc.2); ICM dependency updated to r4.2 (#126, #131).

### Fixed

_none_

### Removed

_none_

**Full Changelog**: https://github.com/camaraproject/NetworkAccessManagement/commits/r2.1

11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,16 @@ Sandbox API Repository to describe, develop, document, and test the NetworkAcces

## Release Information

The repository has no (pre)releases yet, work in progress is within the main branch.
> [!NOTE]
> This repository has only pre-release versions available yet. Pre-releases are for testing and may change before public release.

* The latest pre-release is [r2.1](https://github.com/camaraproject/NetworkAccessManagement/releases/tag/r2.1) (alpha), with the following API versions:
* **network-access-management 0.2.0-alpha.1**
[[YAML]](https://github.com/camaraproject/NetworkAccessManagement/blob/r2.1/code/API_definitions/network-access-management.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NetworkAccessManagement/r2.1/code/API_definitions/network-access-management.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NetworkAccessManagement/r2.1/code/API_definitions/network-access-management.yaml)

* For changes see [CHANGELOG](https://github.com/camaraproject/NetworkAccessManagement/tree/main/CHANGELOG)

_The above section is automatically synchronized by CAMARA project-administration._
<!-- CAMARA:RELEASE-INFO:END -->

## Contributing
Expand Down
Loading