From 523bca96b059f6bf3fcfb161ca20ba06eadfed0a Mon Sep 17 00:00:00 2001 From: Cody Lundie Date: Thu, 5 Feb 2026 16:48:33 -0500 Subject: [PATCH] pre-release artifact assembly --- CHANGELOG.md | 51 +++++++++++-------- .../network-access-management-template.yaml | 4 +- .../network-access-management.yaml | 4 +- ...cess-management-API-Readiness-Checklist.md | 10 ++-- 4 files changed, 38 insertions(+), 31 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5e2f265..d79a7eb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,53 +2,60 @@ ## Table of Contents -- **[r1.0-rc.1](#r10-rc1)** +- **[r1.1](#r11)** **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.** -# r1.0-rc.1 +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 + +# r1.1 ## Release Notes -This public release contains the definition and documentation of +This pre-release contains the definition and documentation of - network-access-management v0.1.0-alpha.1 The API definition(s) are based on -- Commonalities v0.5.0 -- Identity and Consent Management v0.3.0 +- Commonalities r3.4 +- Identity and Consent Management r3.3 ## network-access-management v0.1.0-alpha.1 -Version 0.1.0-alpha.1 is in the initial release. +**network-access-management v0.1.0-alpha.1 is the first alpha release of this API.** - API definition **with inline documentation**: - - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceIdentifier/r1.1/code/API_definitions/device-identifier.yaml&nocors) - - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceIdentifier/r1.1/code/API_definitions/device-identifier.yaml) - - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceIdentifier/blob/r1.1/code/API_definitions/device-identifier.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NetworkAccessManagement/r1.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/r1.1/code/API_definitions/network-access-management.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/NetworkAccessManagement/blob/r1.1/code/API_definitions/network-access-management.yaml) ### Added -- Adds linting by @RandyLevensalor in -- Adds initial API spec YAML by @caubut in -- Adds linting config by @RandyLevensalor in -- Adds linting rules by @RandyLevensalor in +- Initial API definition for managing network operator-supplied network access devices, focused on Trust Domain lifecycle management and Reboot Request management +- Trust Domain CRUD operations with support for multiple access types: Wi-Fi (WPA Personal, WPA Enterprise) and Thread (Structured, TLV) +- Trust Domain capabilities discovery endpoint for querying provider-supported configurations +- Configurable Trust Domain policies: device limits, bandwidth control (upstream/downstream), and egress allowed lists +- Trust Domain expiration support for ephemeral/time-bounded network configurations +- Reboot Request CRUD operations with immediate and scheduled execution modes +- Reboot Request device targeting: explicit (by device UUID) and inferred (default device) +- Service and Network Access Device read endpoints for subscriber resource enumeration +- Scope-based authorization model with resource isolation by API client identity +- Alignment with Commonalities r3.4 error response patterns and `CAMARA_common.yaml` schemas ### Changed -- Removes family name prefix by @MarkusKuemmerle in -- Updates ICM by @RandyLevensalor in -- Adds @benhepworth as a CODEOWNER by @benhepworth in -- Adds meeting info to `README.md` by @wrathwolf in -- Standardizes errors to follow commonalities by @caubut-charter in -- Commonalities and ICM update by @caubut-charter in +- N/A (first release) ### Fixed -- Corrects links from initial template in `README.md` by @wrathwolf in -- Corrects mailing list in `README.md` by @caubut-charter in +- N/A (first release) ### Removed -**Full Changelog**: +- N/A (first release) \ No newline at end of file diff --git a/code/API_definitions/Templates/network-access-management-template.yaml b/code/API_definitions/Templates/network-access-management-template.yaml index a107285..800c6c0 100644 --- a/code/API_definitions/Templates/network-access-management-template.yaml +++ b/code/API_definitions/Templates/network-access-management-template.yaml @@ -5,7 +5,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: wip + version: 0.1.0-alpha.1 x-camara-commonalities: 0.6 description: | Service enabling API for managing network operator supplied network access devices. This API's initial focus is on @@ -172,7 +172,7 @@ externalDocs: url: https://github.com/camaraproject/NetworkAccessManagement servers: - - url: "{apiRoot}/network-access-management/vwip" + - url: "{apiRoot}/network-access-management/v0.1alpha1" variables: apiRoot: default: http://localhost:9091 diff --git a/code/API_definitions/network-access-management.yaml b/code/API_definitions/network-access-management.yaml index dd837e7..c45b1e0 100644 --- a/code/API_definitions/network-access-management.yaml +++ b/code/API_definitions/network-access-management.yaml @@ -4,7 +4,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: wip + version: 0.1.0-alpha.1 x-camara-commonalities: 0.6 description: | Service enabling API for managing network operator supplied network access devices. This API's initial focus is on @@ -166,7 +166,7 @@ info: As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API. servers: - - url: '{apiRoot}/network-access-management/vwip' + - url: '{apiRoot}/network-access-management/v0.1alpha1' variables: apiRoot: default: http://localhost:9091 diff --git a/documentation/API_documentation/network-access-management-API-Readiness-Checklist.md b/documentation/API_documentation/network-access-management-API-Readiness-Checklist.md index 6ee276e..a70ea9f 100644 --- a/documentation/API_documentation/network-access-management-API-Readiness-Checklist.md +++ b/documentation/API_documentation/network-access-management-API-Readiness-Checklist.md @@ -7,16 +7,16 @@ Checklist for network-access-management 0.1.0-alpha.1 in r1.1. | 1 | API definition | M | M | M | M | Y | [relative link](../../code/API_definitions/network-access-management.yaml) | | 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | r3.4 | | 3 | Guidelines from ICM applied | O | M | M | M | Y | r3.3 | -| 4 | API versioning convention applied | M | M | M | M | Y | | +| 4 | API versioning convention applied | M | M | M | M | Y | 0.1.0-alpha.1 | | 5 | API documentation | M | M | M | M | Y | inline in yaml | -| 6 | User stories | O | O | O | M | N | | +| 6 | User stories | O | O | O | M | Y | [Trust Domains User Story](../../documentation/API_documentation/TrustDomainsUser_Story.md) - [Device Reboot Request User Story](../../documentation/API_documentation/DeviceRebootRequest_User_Story.md) | | 7 | Basic API test cases & documentation | O | M | M | M | N | | | 8 | Enhanced API test cases & documentation | O | O | O | M | N | | | 9 | Test result statement | O | O | O | M | N | | -| 10 | API release numbering convention applied | M | M | M | M | N | | -| 11 | Change log updated | M | M | M | M | N | [relative link](../../CHANGELOG.md) | +| 10 | API release numbering convention applied | M | M | M | M | Y | r1.1 | +| 11 | Change log updated | M | M | M | M | Y | [relative link](../../CHANGELOG.md) | | 12 | Previous public release was certified | O | O | O | M | N | | -| 13 | API description (for marketing) | O | O | M | M | N | [wiki link](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/81166949/NetworkAccessManagement+API+description) | +| 13 | API description (for marketing) | O | O | M | M | Y | [wiki link](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/81166949/NetworkAccessManagement+API+description) | To fill the checklist: