Skip to content

Address r1.1 review findings in the API definition and test definitions - #47

Open
maheshc01 wants to merge 1 commit into
mainfrom
rc-prep/review-findings
Open

maheshc01 wants to merge 1 commit into
mainfrom
rc-prep/review-findings

Conversation

@maheshc01

@maheshc01 maheshc01 commented Sep 14, 2026 •

Copy link
Copy Markdown
Contributor

What type of PR is this?

  • correction
  • cleanup
  • tests

What this PR does / why we need it:

Prepares the API definition and test definitions for the r1.2 release candidate by resolving the content-related review findings collected in #37 from the r1.1 alpha review:

  • Reuses the Rate / RateUnitEnum schemas from QualityOnDemand for the response and renames the property to maxDownstreamMediaRate.
  • Clarifies that the returned value is the maximum downstream media streaming rate the network allows for the device, as enforced for media traffic, not a measurement or forecast of the throughput the device will actually experience.
  • Corrects externalDocs.url to point to this repository.
  • Declares error responses explicitly with only the codes this API can return. 500 is removed; 429 is kept (see Check whether 429 and 500 errors are needed for this API #40).
  • Consolidates the test definitions into a single media-streaming-rate.feature covering happy path, request validation, the Commonalities C01 device error scenarios, 401 and 403.
  • Updates the README scope section.

The spec validates cleanly against the CAMARA Spectral r4 ruleset and the feature file against the CAMARA gplint configuration.

Which issue(s) this PR fixes:

Fixes #39
Fixes #41
Fixes #42

Partially addresses #40 (500 removed; 429 will be finalised with the Commonalities r4.4 alignment). Part of #37.

Special notes for reviewers:

Changelog input

 release-note
- Breaking: response property maxDownstreamMediaBitRateSupported + unit replaced by maxDownstreamMediaRate (Rate object with value and unit)
- Changed: description clarifies the returned value is the maximum rate the network allows for the device, not a throughput measurement or forecast
- Changed: error responses declared explicitly with only applicable codes; 500 INTERNAL no longer documented
- Fixed: externalDocs.url points to this repository
- Added: consolidated test definitions in media-streaming-rate.feature

Additional documentation

docs

@camara-validation

camara-validation Bot commented Sep 14, 2026 •

Copy link
Copy Markdown

CAMARA Validation — PASS

0 errors, 0 warnings, 0 hints | Profile: standard

View full results

- Reuse the Rate / RateUnitEnum schemas from QualityOnDemand for the response
  and rename the property to maxDownstreamMediaRate (#39)
- Clarify that the returned value is the maximum rate the network allows for
  the device, as enforced for media traffic, not a measurement or forecast of
  achievable throughput (#41)
- Point externalDocs.url to this repository (#42)
- Declare error responses explicitly with only the codes this API can return;
  500 removed, 429 kept (#40)
- Consolidate test definitions into a single media-streaming-rate.feature
  covering happy path, request validation, C01 device errors, 401 and 403
- Update README scope to describe the API purpose
@maheshc01
maheshc01 force-pushed the rc-prep/review-findings branch from ff18efa to 7a32b69 Compare September 14, 2026 17:59
@maheshc01 maheshc01 changed the title Rename API to device-media-streaming-rate and address r1.1 review findings Address r1.1 review findings in the API definition and test definitions Sep 14, 2026
@maheshc01

Copy link
Copy Markdown
Contributor Author

@Kevsy Please review these changes based on the review comments you had shared. I will create a separate PR for yaml and api name changes as its causing failures in automated validations.

@maheshc01
maheshc01 requested a review from Kevsy September 14, 2026 18:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant