Merge pull request #57 from camaraproject/release-review/r1.2-a5e16b7

cnzj-Gc · web-flow · commit f809daef6f38 · 2026-05-22T09:10:30.000+08:00
Release Review: NetworkInsights r1.2 (rc)
diff --git a/CHANGELOG/CHANGELOG-r1.md b/CHANGELOG/CHANGELOG-r1.md
@@ -2,6 +2,7 @@
 
 <!-- TOC:START -->
 ## Table of Contents
+- [r1.2](#r12)
 - [r1.1](#r11)
 <!-- TOC:END -->
 
@@ -14,6 +15,126 @@ The below sections record the changes for each API version in each release as fo
 * 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.2
+
+## Release Notes
+
+This release candidate contains the definition and documentation of
+* network-health-assessment 0.1.0-rc.1
+* network-traffic-analysis 0.1.0-rc.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 config.yml - replace placeholder $repo_name$ and update link to API Design Guide by @hdamker in https://github.com/camaraproject/NetworkInsights/pull/4
+* Update MAINTAINERS.MD by @cnzj-Gc in https://github.com/camaraproject/NetworkInsights/pull/6
+* Update README.md by @cnzj-Gc in https://github.com/camaraproject/NetworkInsights/pull/9
+* commit network health assessment api definition by @cnzj-Gc in https://github.com/camaraproject/NetworkInsights/pull/10
+* presentation upload by @cnzj-Gc in https://github.com/camaraproject/NetworkInsights/pull/11
+* Update MAINTAINERS.MD by @cnzj-Gc in https://github.com/camaraproject/NetworkInsights/pull/12
+* upload and update files by @cnzj-Gc in https://github.com/camaraproject/NetworkInsights/pull/15
+* repair linting errors by @cnzj-Gc in https://github.com/camaraproject/NetworkInsights/pull/16
+* admin: migrate to centralized linting workflows by @hdamker-bot in https://github.com/camaraproject/NetworkInsights/pull/13
+* Update network-traffic-analysis.yaml by @cnzj-Gc in https://github.com/camaraproject/NetworkInsights/pull/17
+* repair feature errors by @cnzj-Gc in https://github.com/camaraproject/NetworkInsights/pull/18
+* repair tag identation by @cnzj-Gc in https://github.com/camaraproject/NetworkInsights/pull/19
+* Update network-health-assessment.yaml by @cnzj-Gc in https://github.com/camaraproject/NetworkInsights/pull/20
+* Reset API and test code version by @cnzj-Gc in https://github.com/camaraproject/NetworkInsights/pull/22
+* Add user story files by @cnzj-Gc in https://github.com/camaraproject/NetworkInsights/pull/24
+* seperate PRs for release r1.1 by @cnzj-Gc in https://github.com/camaraproject/NetworkInsights/pull/28
+* Release r1.1 with NHA v0.1.0-alpha.1 and NTA v0.1.0-alpha(check lists) by @cnzj-Gc in https://github.com/camaraproject/NetworkInsights/pull/29
+* [bulk] Sync Release Information section (2026-02-19-001) by @hdamker-bot in https://github.com/camaraproject/NetworkInsights/pull/32
+* [bulk] Add release-plan.yaml (2026-02-23-001) by @hdamker-bot in https://github.com/camaraproject/NetworkInsights/pull/33
+* Updates following release review by @cnzj-Gc in https://github.com/camaraproject/NetworkInsights/pull/31
+* Update release-plan.yaml by @cnzj-Gc in https://github.com/camaraproject/NetworkInsights/pull/35
+* Reset API and test code version information to wip by @hdamker in https://github.com/camaraproject/NetworkInsights/pull/39
+* [bulk] Enable release automation process (2026-03-24-001) by @camara-release-automation[bot] in https://github.com/camaraproject/NetworkInsights/pull/41
+* Update release-plan.yaml for r1.1 by @hdamker in https://github.com/camaraproject/NetworkInsights/pull/42
+* Updates to NTA yaml and its feature file by @ChinaUnicomXiaoDongrui in https://github.com/camaraproject/NetworkInsights/pull/36
+* Updates to NHA yaml and its feature file by @cnzj-Gc in https://github.com/camaraproject/NetworkInsights/pull/37
+* Release Review: NetworkInsights r1.1 (alpha) by @camara-release-automation[bot] in https://github.com/camaraproject/NetworkInsights/pull/44
+* Release snapshot/r1.1 9295e48 by @cnzj-Gc in https://github.com/camaraproject/NetworkInsights/pull/45
+* Revert "Release snapshot/r1.1 9295e48" by @hdamker in https://github.com/camaraproject/NetworkInsights/pull/46
+* Release Automation: Post-release sync (r1.1) by @camara-release-automation[bot] in https://github.com/camaraproject/NetworkInsights/pull/47
+* [bulk] Update release-automation + validation callers by @camara-release-automation[bot] in https://github.com/camaraproject/NetworkInsights/pull/48
+* Update Spring26 M4 release plan to rc by @cnzj-Gc in https://github.com/camaraproject/NetworkInsights/pull/50
+* Sync common files from Commonalities r4.2 by @camara-release-automation[bot] in https://github.com/camaraproject/NetworkInsights/pull/51
+* [bulk] Update release-automation + validation callers by @camara-release-automation[bot] in https://github.com/camaraproject/NetworkInsights/pull/55
+* fix: Update API definitions for Commonalities r4.2 compliance by @cnzj-Gc in https://github.com/camaraproject/NetworkInsights/pull/56
+
+## New Contributors
+* @hdamker made their first contribution in https://github.com/camaraproject/NetworkInsights/pull/4
+* @cnzj-Gc made their first contribution in https://github.com/camaraproject/NetworkInsights/pull/6
+* @hdamker-bot made their first contribution in https://github.com/camaraproject/NetworkInsights/pull/13
+* @camara-release-automation[bot] made their first contribution in https://github.com/camaraproject/NetworkInsights/pull/41
+* @ChinaUnicomXiaoDongrui made their first contribution in https://github.com/camaraproject/NetworkInsights/pull/36
+
+</details>
+<!-- END:AUTOGENERATED:CANDIDATE_CHANGES -->
+
+## network-health-assessment 0.1.0-rc.1
+
+**network-health-assessment 0.1.0-rc.1 is the first release-candidate version of the Network Insights API**
+
+- API definition **with inline documentation**:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NetworkInsights/r1.2/code/API_definitions/network-health-assessment.yaml&nocors)
+  - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NetworkInsights/r1.2/code/API_definitions/network-health-assessment.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/NetworkInsights/blob/r1.2/code/API_definitions/network-health-assessment.yaml)
+
+### Added
+
+This is the initial release,  the network-health-assessment API allows users to query network health scores, enabling them to intuitively view the overall network health status and enhancing visualization capabilities.
+
+### Changed
+
+Update API definitions for Commonalities r4.2 compliance
+
+### Fixed
+
+N/A
+
+### Removed
+
+N/A
+
+## network-traffic-analysis 0.1.0-rc.1
+
+**network-traffic-analysis 0.1.0-rc.1 is the first release-candidate version of the Network Insights API**
+
+- API definition **with inline documentation**:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NetworkInsights/r1.2/code/API_definitions/network-traffic-analysis.yaml&nocors)
+  - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NetworkInsights/r1.2/code/API_definitions/network-traffic-analysis.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/NetworkInsights/blob/r1.2/code/API_definitions/network-traffic-analysis.yaml)
+
+### Added
+
+This is the initial release, the network-traffic-analysis API provides time-based queries for individual service requests, including access counts and uplink/downlink traffic. This facilitates the analysis of overall network load conditions and provides analytical support for subsequent resource allocation.
+
+### Changed
+
+Update API definitions for Commonalities r4.2 compliance
+
+### Fixed
+
+N/A
+
+### Removed
+
+N/A
+
+**Full Changelog**: https://github.com/camaraproject/NetworkInsights/commits/r1.2
+
 # r1.1
 
 ## Release Notes
diff --git a/README.md b/README.md
@@ -30,11 +30,11 @@ Sandbox API Repository to describe, develop, document, and test the NetworkInsig
 > [!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 [r1.1](https://github.com/camaraproject/NetworkInsights/releases/tag/r1.1) (alpha), with the following API versions:
-  * **network-health-assessment 0.1.0-alpha.1**
-  [[YAML]](https://github.com/camaraproject/NetworkInsights/blob/r1.1/code/API_definitions/network-health-assessment.yaml)  [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NetworkInsights/r1.1/code/API_definitions/network-health-assessment.yaml&nocors)  [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NetworkInsights/r1.1/code/API_definitions/network-health-assessment.yaml)
-  * **network-traffic-analysis 0.1.0-alpha.1**
-  [[YAML]](https://github.com/camaraproject/NetworkInsights/blob/r1.1/code/API_definitions/network-traffic-analysis.yaml)  [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NetworkInsights/r1.1/code/API_definitions/network-traffic-analysis.yaml&nocors)  [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NetworkInsights/r1.1/code/API_definitions/network-traffic-analysis.yaml)
+* The latest pre-release is [r1.2](https://github.com/camaraproject/NetworkInsights/releases/tag/r1.2) (release candidate), with the following API versions:
+  * **network-health-assessment 0.1.0-rc.1**
+  [[YAML]](https://github.com/camaraproject/NetworkInsights/blob/r1.2/code/API_definitions/network-health-assessment.yaml)  [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NetworkInsights/r1.2/code/API_definitions/network-health-assessment.yaml&nocors)  [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NetworkInsights/r1.2/code/API_definitions/network-health-assessment.yaml)
+  * **network-traffic-analysis 0.1.0-rc.1**
+  [[YAML]](https://github.com/camaraproject/NetworkInsights/blob/r1.2/code/API_definitions/network-traffic-analysis.yaml)  [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NetworkInsights/r1.2/code/API_definitions/network-traffic-analysis.yaml&nocors)  [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NetworkInsights/r1.2/code/API_definitions/network-traffic-analysis.yaml)
 
 * For changes see [CHANGELOG](https://github.com/camaraproject/NetworkInsights/tree/main/CHANGELOG)
 
