diff --git a/CHANGELOG/CHANGELOG-r3.md b/CHANGELOG/CHANGELOG-r3.md new file mode 100644 index 0000000..a916a4b --- /dev/null +++ b/CHANGELOG/CHANGELOG-r3.md @@ -0,0 +1,176 @@ +# Changelog NetworkAccessManagement + + +## Table of Contents +- [r3.1](#r31) + + +**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 + +# r3.1 + +## Release Notes + +This release candidate contains the definition and documentation of +* network-access-devices 0.3.0-rc.1 +* network-access-domains 0.3.0-rc.1 + +The API definition(s) are based on +* Commonalities 0.8.0 +* Identity and Consent Management 0.5.0 + + +> **Working area — candidate changes (auto-removed on merge)** +> Copy relevant entries into the Breaking changes/Added/Changed/Fixed/Removed sections below. List breaking changes both in Breaking changes and in their normal change category. +> 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. + +
+Candidate changes (auto-generated from merged PRs) + +## 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 +* chore: revert validation caller to @v1-rc by @hdamker in https://github.com/camaraproject/NetworkAccessManagement/pull/140 +* Release Automation: Post-release sync (r2.1) by @camara-release-automation[bot] in https://github.com/camaraproject/NetworkAccessManagement/pull/141 +* Add intent for sync26 meta-release by @benhepworth in https://github.com/camaraproject/NetworkAccessManagement/pull/144 +* Sync common files from Commonalities r4.3 by @camara-release-automation[bot] in https://github.com/camaraproject/NetworkAccessManagement/pull/145 +* chore: move redocly.yaml and README.md from code/API_definitions/ to code/ (#134) by @clundie-CL in https://github.com/camaraproject/NetworkAccessManagement/pull/148 +* docs: add 400 input-validation responses to read/delete operations (#133) by @clundie-CL in https://github.com/camaraproject/NetworkAccessManagement/pull/149 +* docs: tighten integer format/bounds and string maxLengths (#135) by @clundie-CL in https://github.com/camaraproject/NetworkAccessManagement/pull/150 +* docs: add Rich Woundy to MAINTAINERS.MD (#142) by @clundie-CL in https://github.com/camaraproject/NetworkAccessManagement/pull/151 +* chore: declare split APIs (network-access-devices, network-access-domains) in release-plan as draft (#152) by @clundie-CL in https://github.com/camaraproject/NetworkAccessManagement/pull/154 +* feat: split API into Network Access Devices + Trust Domains (#152) by @clundie-CL in https://github.com/camaraproject/NetworkAccessManagement/pull/153 +* fix: clear r4.3 validation warnings — maxItems + info.description templates (#155) by @clundie-CL in https://github.com/camaraproject/NetworkAccessManagement/pull/156 +* docs: refactor NAM API descriptions and add device registration user story (#143) by @clundie-CL in https://github.com/camaraproject/NetworkAccessManagement/pull/158 +* chore: cut r3.1 release candidate — drop network-access-management, bump split APIs to rc (#152) by @clundie-CL in https://github.com/camaraproject/NetworkAccessManagement/pull/157 +* fix: clear release-review Spectral warnings (S-011/S-015/S-030/S-031) (#162) by @clundie-CL in https://github.com/camaraproject/NetworkAccessManagement/pull/163 + +## 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 + +
+ + +## network-access-devices 0.3.0-rc.1 + +**network-access-devices 0.3.0-rc.1 is a release-candidate version of this API.** + +- API definition **with inline documentation**: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NetworkAccessManagement/r3.1/code/API_definitions/network-access-devices.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NetworkAccessManagement/r3.1/code/API_definitions/network-access-devices.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/NetworkAccessManagement/blob/r3.1/code/API_definitions/network-access-devices.yaml) + +### Breaking changes + +* Carved out of the former `network-access-management` API (alpha, r2.1). Reboot Requests and Network Access Device enumeration are now provided by the **network-access-devices** API, with the reboot scope renamed to `network-access-devices:reboot` (#153). + +### Added + +* Initial **network-access-devices** API surface (split from network-access-management): + - **Reboot Requests** — CRUD operations for immediate or scheduled reboot of operator-supplied network access devices. + - **Network Access Devices** — read-only enumeration of operator-supplied network access equipment (`GET /network-access-devices`, `GET /network-access-devices/{networkAccessDeviceId}`). +* `400` input-validation response on all read and delete operations (#149). + +### Changed + +* Tightened schema constraints: integer `format` with min/max bounds and string `maxLength` (#150), and `maxItems` bounds on array fields (#156). +* Dependency on Commonalities updated to r4.3 (0.8.0); ICM dependency r4.2 (0.5.0) (#144, #145). + +### Fixed + +* N/A + +### Removed + +* N/A + +## network-access-domains 0.3.0-rc.1 + +**network-access-domains 0.3.0-rc.1 is a release-candidate version of this API.** + +- API definition **with inline documentation**: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NetworkAccessManagement/r3.1/code/API_definitions/network-access-domains.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NetworkAccessManagement/r3.1/code/API_definitions/network-access-domains.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/NetworkAccessManagement/blob/r3.1/code/API_definitions/network-access-domains.yaml) + +### Breaking changes + +* Carved out of the former `network-access-management` API (alpha, r2.1). Trust Domains, Trust Domain Devices, and Services are now provided by the **network-access-domains** API, with scopes renamed to `network-access-domains:trust-domains`, `network-access-domains:trust-domains:read-all`, `network-access-domains:devices`, and `network-access-domains:services:read` (#153). + +### Added + +* Initial **network-access-domains** API surface (split from network-access-management): + - **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. + - **Services** — read-only enumeration of subscriber service instances (`GET /services`, `GET /services/{serviceId}`). +* `400` input-validation response on all read and delete operations (#149). + +### Changed + +* Tightened schema constraints: integer `format` with min/max bounds and string `maxLength` (#150), and `maxItems` bounds on array fields (#156). +* Dependency on Commonalities updated to r4.3 (0.8.0); ICM dependency r4.2 (0.5.0) (#144, #145). + +### Fixed + +* N/A + +### Removed + +* N/A + +**Full Changelog**: https://github.com/camaraproject/NetworkAccessManagement/commits/r3.1 + diff --git a/README.md b/README.md index 13ae2a9..1341e8b 100644 --- a/README.md +++ b/README.md @@ -28,9 +28,11 @@ Sandbox API Repository to describe, develop, document, and test the NetworkAcces > [!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) +* The latest pre-release is [r3.1](https://github.com/camaraproject/NetworkAccessManagement/releases/tag/r3.1) (release candidate), with the following API versions: + * **network-access-devices 0.3.0-rc.1** + [[YAML]](https://github.com/camaraproject/NetworkAccessManagement/blob/r3.1/code/API_definitions/network-access-devices.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NetworkAccessManagement/r3.1/code/API_definitions/network-access-devices.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NetworkAccessManagement/r3.1/code/API_definitions/network-access-devices.yaml) + * **network-access-domains 0.3.0-rc.1** + [[YAML]](https://github.com/camaraproject/NetworkAccessManagement/blob/r3.1/code/API_definitions/network-access-domains.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NetworkAccessManagement/r3.1/code/API_definitions/network-access-domains.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NetworkAccessManagement/r3.1/code/API_definitions/network-access-domains.yaml) * For changes see [CHANGELOG](https://github.com/camaraproject/NetworkAccessManagement/tree/main/CHANGELOG)