Skip to content

Release Review: DeviceMediaStreamingRate r1.2 (rc) #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
camara-release-automation wants to merge 2 commits into
base: release-snapshot/r1.2-ad6811f
Choose a base branch
from
+97 −0
Open

Release Review: DeviceMediaStreamingRate r1.2 (rc) #55

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1a9315e
Add CHANGELOG draft for r1.2
camara-release-automation[bot] Oct 22, 2026
a723074
docs: update CHANGELOG for device-media-streaming-rate 0.1.0-rc.1
maheshc01 Oct 22, 2026
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
97 changes: 97 additions & 0 deletions CHANGELOG/CHANGELOG-r1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

<!-- TOC:START -->
## Table of Contents
- [r1.2](#r12)
- [r1.1](#r11)
<!-- TOC:END -->

Expand All @@ -14,6 +15,102 @@ 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
* device-media-streaming-rate 0.1.0-rc.1

The API definition(s) are based on
* Commonalities r4.4 (0.9.0)
* Identity and Consent Management r4.2 (0.5.0)

<!-- BEGIN:AUTOGENERATED:CANDIDATE_CHANGES -->
> **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.

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

## What's Changed
* Update README.md by @hdamker in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/5
* Update CODEOWNERS by @hdamker in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/1
* Update MAINTAINERS.MD by @hdamker in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/2
* Add linting rules by @eric-murray in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/7
* Update MAINTAINERS.MD by @hdamker in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/8
* Update MAINTAINERS.MD by @maheshc01 in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/12
* admin: migrate to centralized linting workflows by @hdamker-bot in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/16
* proposing Mahesh as a code owner by @maheshc01 in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/15
* Initial yaml spec for device max bitrate by @maheshc01 in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/11
* [bulk] Sync Release Information section (2026-02-19-001) by @hdamker-bot in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/19
* Update README.md after repository rename by @hdamker in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/20
* fix(api): reset server URL to vwip on main (fixes #18) by @hdamker in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/22
* [bulk] Add release-plan.yaml (2026-02-22-001) by @hdamker-bot in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/21
* Modify release plan for pre-release by @rartych in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/23
* [bulk] Enable release automation and validation by @camara-release-automation[bot] in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/24
* Sync common files from Commonalities r4.2 by @camara-release-automation[bot] in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/25
* Update API definitions to fix CAMARA validation warnings and hints by @eric-murray in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/29
* Update commonalities_release to r4.3 by @eric-murray in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/33
* Sync common files from Commonalities r4.3 by @camara-release-automation[bot] in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/34
* Delete redundant workflows by @eric-murray in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/36
* Replace relative with absolute links in YAML by @eric-murray in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/44
* Release Automation: Post-release sync (r1.1) by @camara-release-automation[bot] in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/46
* Address r1.1 review findings in the API definition and test definitions by @maheshc01 in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/47
* Rename API to device-media-streaming-rate by @maheshc01 in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/50
* Plan r1.2 release candidate on Commonalities r4.4 by @maheshc01 in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/51
* Sync common files from Commonalities r4.4 by @camara-release-automation[bot] in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/52
* Align with Commonalities r4.4 by @maheshc01 in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/54

## New Contributors
* @hdamker made their first contribution in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/5
* @eric-murray made their first contribution in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/7
* @maheshc01 made their first contribution in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/12
* @hdamker-bot made their first contribution in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/16
* @rartych made their first contribution in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/23

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

## device-media-streaming-rate 0.1.0-rc.1

**device-media-streaming-rate 0.1.0-rc.1 is the first 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/DeviceMediaStreamingRate/r1.2/code/API_definitions/device-media-streaming-rate.yaml&nocors)
- [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceMediaStreamingRate/r1.2/code/API_definitions/device-media-streaming-rate.yaml)
- OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceMediaStreamingRate/blob/r1.2/code/API_definitions/device-media-streaming-rate.yaml)

### Breaking changes

* API renamed from `media-streaming-rate` (0.1.0-alpha.1 in r1.1) to `device-media-streaming-rate`, to match the repository name: API definition file, `info.title`, server URL, scope `device-media-streaming-rate:retrieve-maximum-downstream-media-rate` and schema names by @maheshc01 in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/50
* Response properties `maxDownstreamMediaBitRateSupported` and `unit` replaced by `maxDownstreamMediaRate`, using the `Rate` and `RateUnitEnum` schemas from QualityOnDemand (`value` and `unit`) by @maheshc01 in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/47

### Added

* Added test definitions covering success cases, request validation, the Commonalities C01 device identifier errors, 401 and 403 by @maheshc01 in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/47
* Added 429 test scenarios for `TOO_MANY_REQUESTS` and `QUOTA_EXCEEDED` by @maheshc01 in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/54
* Added a definition of the returned value to the API description: the maximum downstream media streaming rate the network allows for the device, not a measurement or forecast of the throughput by @maheshc01 in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/47

### Changed

* Synced with CAMARA Commonalities r4.4 / 0.9.0 (previously 0.8.0): error responses aligned with the r4.4 response catalogue, `info.description` mandatory sections updated by @maheshc01 in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/54
* API renamed from `media-streaming-rate` (0.1.0-alpha.1 in r1.1) to `device-media-streaming-rate`, to match the repository name: API definition file, `info.title`, server URL, scope `device-media-streaming-rate:retrieve-maximum-downstream-media-rate` and schema names by @maheshc01 in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/50
* Response properties `maxDownstreamMediaBitRateSupported` and `unit` replaced by `maxDownstreamMediaRate`, using the `Rate` and `RateUnitEnum` schemas from QualityOnDemand (`value` and `unit`) by @maheshc01 in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/47
* Removed the "Token usage: two-legged vs three-legged" section of the API description, which duplicated the mandatory "Identifying the device from the access token" section by @maheshc01 in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/47

### Fixed

* Corrected `externalDocs` to point to this repository, with the description "Product documentation at CAMARA" by @maheshc01 in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/47

### Removed

* Removed `400 OUT_OF_RANGE`, `403 INVALID_TOKEN_CONTEXT`, `404 NOT_FOUND` and the `503` response, which are not applicable to this API by @maheshc01 in https://github.com/camaraproject/DeviceMediaStreamingRate/pull/47

**Full Changelog**: https://github.com/camaraproject/DeviceMediaStreamingRate/commits/r1.2

# r1.1

## Release Notes
Expand Down
Loading