Release r2.2 (M4 Fall25) by stroncoso-quobis · Pull Request #105 · camaraproject/WebRTC

stroncoso-quobis · 2025-08-29T19:50:07Z

What type of PR is this?

Add one of the following kinds:

subproject management

What this PR does / why we need it:

Stable release for WebRTC APIs - release 2.2

Included on Fall25 meta-release
Fixes issues detected during testing, and code review

Which issue(s) this PR fixes:

Fixes #96
Fixes #115

Special notes for reviewers:

Included PRs since release-candidate

Changelog input

 release-notes
- doc: API & COMMs version bump for release r2.2
- doc: README update for release r2.2
- doc: CHANGELOG update for release r2.2
- doc: Swagger r2.1 (rc) links on CHANGELOG

Additional documentation

docs
- Updated API readiness files to identify r2.2 and ICM/COMMs r3.3

hdamker

Must fix:
The server URL in all YAML and .feature files doesn't match the API version.

For example in webrtc-events:

Description: Server URL version v0.2rc1 doesn't match API version 0.2.0
Location: servers[0].url
Fix: Update server URL to end with /v0.2

webrtc-events - line 722-725: the link into Commonalities within the definition of SubscriptionId is outdated (going to a deprecated document). Use instead the definition as in https://github.com/camaraproject/Commonalities/blob/main/artifacts/camara-cloudevents/event-subscription-template.yaml:

    SubscriptionId:
      type: string
      description: The unique identifier of the subscription in the scope of the subscription manager. When this information is contained within an event notification, this concept SHALL be referred as `subscriptionId` as per [Commonalities Event Notification Model](/documentation/API-design-guidelines.md#122-event-notification).
      example: qs15-h556-rt89-1298

This is also a bug in Commonalities (issue camaraproject/Commonalities#531 created). I propose as short-term solution the definition from sim-swap-subscription:

    SubscriptionId:
      type: string
      description: The unique identifier of the subscription in the scope of the subscription manager. When this information is contained within an event notification, this concept SHALL be referred as subscriptionId as per Commonalities Event Notification Model.
      example: qs15-h556-rt89-1298

hdamker

Should fix (could be done later, non-breaking changes):

Use in all three YAML files the same ErrorInfo definition, with the order status -> code -> message, currently there are different versions with different order of the properties.

Use the latest and fixed version of the definition from https://github.com/camaraproject/Commonalities/blob/main/artifacts/CAMARA_common.yaml (please be aware that CAMARA_common.yaml got fixed after r3.3, it is now aligned with the API Design Guide in r3.3):

    ErrorInfo:
      type: object
      required:
        - status
        - code
        - message
      properties:
        status:
          type: integer
          description: HTTP response status code
        code:
          type: string
          description: A human-readable code to describe the error
        message:
          type: string
          description: A human-readable description of what the event represents

Multiple schema names are not following the PascalCase convention (in webrtc-registration.yaml):

regSessionRequest → should be RegSessionRequest
regSessionResponse → should be RegSessionResponse
regSessionUpdate → should be RegSessionUpdate

Maybe as well the following ones, but that's questionable:

WrtcSDPDescriptor → should be WrtcSdpDescriptor (in both webrtc-call-handling and webrtc-events)
HTTPSubscriptionRequest → should be HttpSubscriptionRequest
HTTPSubscriptionResponse → should be HttpSubscriptionResponse
HTTPSettings → should be HttpSettings

hdamker

You may want to consider:

The headers of the sections # Authorization and authentication and # Additional CAMARA error responses differ from the templates. On the one side does that raise issues of our release review script (as it does not find the sections, see full results here), on the other side are these sections with that differently formatted than in other APIs of the meta-release. As the section itself are there this is not a critical issue.

If you want to fix that:

## 4. Authorization and authentication -> # Authorization and authentication
## 5. Additional CAMARA error responses -> # Additional CAMARA error responses

Test file names are not matching in multiple cases not with the operationIds within the API file (e.g. -deleteSession instead of -deleteSessionById That isn't mandatory to fix as there could reasons for other name choices.

But you might want to fix the typo in webrtc-registration-deleteRegsitartionById.feature (should be deleteRegistrationById).

hdamker

The remaining points found during checks along camaraproject/ReleaseManagement#322

CHANGELOG.md

README.md

documentation/API_documentation/webrtc-call-handling-API-Readiness-Checklist.md

hdamker · 2025-09-12T20:25:58Z

@stroncoso-quobis please find my review results above. The critical points should be easy to fix, also the other points. If you don't want to fix a certain topic now, you can also create issues for the next release.

tanjadegroot · 2025-09-17T12:22:52Z

@stroncoso-quobis Hi Santiago, team, will you be able to release the API before tomorrow's TSC meeting at 4PM CEST ?
we want to declare the M4/M5 tomorrow.
many thanks !

tanjadegroot · 2025-09-17T12:25:33Z

PS. it would be great if you could include the fix on ErrorInfo schema in the yaml files) as indicated above, as all other Fall25 API have fixed it :-)

stroncoso-quobis · 2025-09-18T11:51:28Z

Hi @tanjadegroot , hard deadline, I'm little overloaded this week, it started fine, but I had really no-time to dedicate to this, so I will have some time this late afternoon.

Anyway, I will do my best to get everything ready. Attending to the @hdamker comment, we need a separate PR for ErrorInfo fix, I will try to get the time for the PR, notify my colleagues for PR approve, merge and notify you back...

As said, I will do my best 💪

tanjadegroot · 2025-09-18T12:03:53Z

Hi @tanjadegroot , hard deadline, I'm little overloaded this week, it started fine, but I had really no-time to dedicate to this, so I will have some time this late afternoon.

Anyway, I will do my best to get everything ready. Attending to the @hdamker comment, we need a separate PR for ErrorInfo fix, I will try to get the time for the PR, notify my colleagues for PR approve, merge and notify you back...

As said, I will do my best 💪

Thanks very much Santiago @stroncoso-quobis ! I think we can then consider the API will be release today. Great news.
Thanks to the team for all the efforts. !!

stroncoso-quobis

Review of CHANGELOG and README done. Letting YAML titles and PascalCase object naming as fixes for future PRs.

CHANGELOG.md

README.md

CHANGELOG.md

documentation/API_documentation/webrtc-call-handling-API-Readiness-Checklist.md

stroncoso-quobis · 2025-09-18T19:20:35Z

Hi @hdamker , @tanjadegroot ,

Main fixes done here: CHANGELOG, README & API Readiness files. 2f0b5c0
Also, ErrorInfo object updated at a separated PR #113

I will let as bugs pending to fix the other comments provided, I will create GitHub issues for them:

PascalCase at objects review.
Doc tiltles at YAML.
OperationID at testing files

Most of them come from original commonalites not properly aligned. I really would appreciate a sooner review, that I would have more time to fix them. But them seem minor bugs, we will fix them soon.
Anyway, thanks for your support, review and detailed work! Really appreciated. 🙇

Let me know if something extra is needed and further steps to publish the release.

Best regards,

hdamker

@stroncoso-quobis thanks for the fixes, it looks good to merge, and I'm fine with your decision to postpone further fixes. I'm also ok that the PR is currently not in sync with main, I have reviewed the three commits separately.

Thanks for your understanding regarding the timing we will do next time better (🤞 that with more time available the reviews will distribute better and not still all coming at the deadline).

hdamker · 2025-09-18T21:00:35Z

@stroncoso-quobis the final check has shown, that you have overseen the first must fix from my comments:

The server URL in all YAML and .feature files doesn't match the API version.

For example in webrtc-events:

Description: Server URL version v0.2rc1 doesn't match API version 0.2.0
Location: servers[0].url
Fix: Update server URL to end with /v0.2

That's in all .feature files one small change ... remove the rc1 from the version in all resource lines, e.g.:

`And the resource "/webrtc-call-handling/v0.3rc1/sessions"`->     
`And the resource "/webrtc-call-handling/v0.3/sessions"`

README.md

stroncoso-quobis

Resolvind outdated conversations and proceding to push changes regarding:

README tag links
Inline YAML doc titles
Server URL (remove rc1 suffix)

I will push ASAP and notify.
Regards,

README.md

…view

stroncoso-quobis · 2025-09-22T11:29:15Z

Hi @hdamker , @tanjadegroot

Changes applied to solve critical issue:

Fixed tag links ( 38c1c2d )
YAML inline doc title alignment ( 2289d0f )
Server path updated to stable for YAML and FEATURE test files ( 27554cf )

Also:

Added CHANGELOG due fix: ErrorInfo updated descriptions #113 ( 8d47f71 )

But I wrote 103 instead of 113, the CHANGELOG message is ok, but the commit message wrong. Should I force push the correct commit message?

Best regards

hdamker · 2025-09-22T17:15:32Z

@stroncoso-quobis thanks fa lot or the corrections, almost done now and I considered already to approve, but maybe you want to change the following points:

webrtc-events.yaml: The Authorization and authentication text is not the latest (e.g. API Client -> API consumer) - would be great if you can just copy it over from one of the other APIs
PR #88 is actually not a PR, but the issue for PR 88 commonalities 060 #90. People can easily follow the links to the PR, therefore also ok to keep it if you prefer
ErrInfo schema definition:
- webrtc-events has the correct order status -> code -> message, while
- webrtc-registration and webrtc-call-handling have the (wrong) the reversed order message -> code -> status.

The last point can for sure be considered as a cosmetic and potentially technical irrelevant issue, but these are last two APIs in the complete meta-release of 60 APIs which have this reversed order (and all your examples are in the correct order). Would be good if you also across your own APIs use the same order in the schema. We can also not be completely sure if some code generators might not get irritated by that.

P.S.: I don't care about typos in commit messages.

hdamker · 2025-09-23T08:23:57Z

@stroncoso-quobis ready for final review/approval or will you address ErrInfo as well?

stroncoso-quobis · 2025-09-23T08:30:43Z

Hi @hdamker ,
Currently fixing ErrorInfo, it produces a conflict on the main, so I'm solving before push.

stroncoso-quobis · 2025-09-23T08:37:06Z

Ok @hdamker ,
It seems ready to go. ErrorInfo fixed at c2d9296 and conflicts resolve at a3ab467.
Let me know if it is ok for release.

Best regards,

hdamker · 2025-09-23T12:44:47Z

Ok @hdamker , It seems ready to go. ErrorInfo fixed at c2d9296 and conflicts resolve at a3ab467. Let me know if it is ok for release.

Great @stroncoso-quobis. Seems that you had done the need corrections already within #113 ... just not visible within the release PR as it wasn't updated (btw was the PR 113 more aligned with https://github.com/camaraproject/Commonalities/blob/main/artifacts/CAMARA_common.yaml, but that's now really nits).

I will approve and hope you can create merge and create the release today before 15:00 UTC (start of the Release Management call).

hdamker

Approved on behalf of Release Management 👏

Next steps for the team:

PR merged (by API repository codeowner)
Release created within GitHub (by API repository codeowner)
Release Tracker updated (with creation date of the release and the release tag link)

stroncoso-quobis · 2025-09-23T13:59:41Z

Thansk @hdamker ,
Seems that I need a @camaraproject/web-rtc_codeowner approval.
As soon as approved, I will merge it.

Best regards,

tanjadegroot · 2025-09-23T14:18:39Z

Hi Team, @stroncoso-quobis, please merge, create the release and update the release trackers !!
thanks a lot :-)

stroncoso-quobis · 2025-09-23T14:55:12Z

Merged!

Release created here: https://github.com/camaraproject/WebRTC/releases/latest (r2.2)
release-tracker update in progress -> https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14564612/WebRTC+API+Release+Tracking

@tanjadegroot I will update ASAP
BR,

stroncoso-quobis · 2025-09-23T15:04:26Z

Hi @tanjadegroot ,

Release PR merged ✔️
- Release r2.2 (M4 Fall25) #105
Github Release r2.2 created ✔️
- https://github.com/camaraproject/WebRTC/releases/tag/r2.2
API trackers updated ✔️
- https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14564612/WebRTC+API+Release+Tracking

Let me know if you need anything from my side
Best regards,

stroncoso-quobis added 4 commits August 29, 2025 21:26

fix: Swagger r2.1 (rc) links on CHANGELOG

0713d39

doc: CHANGELOG update for release r2.2

0d3e6a4

doc: README update for release r2.2

8986a82

doc: API & COMMs version bump for release r2.2

2f123ed

stroncoso-quobis requested review from a team, deepakjaiswal1, pradeepachar-mavenir and teikuran as code owners August 29, 2025 19:50

stroncoso-quobis added the subproject management Indicating issues with subproject repository or release management process label Aug 29, 2025

hdamker changed the title ~~Release r22 (meta-release Fall25 stable)~~ Release r2.2 (M4 Fall25) Aug 30, 2025

hdamker mentioned this pull request Aug 30, 2025

WebRTC r2.2 (Fall25 M4) release review camaraproject/ReleaseManagement#322

Closed

34 tasks

hdamker requested changes Sep 12, 2025

View reviewed changes

hdamker reviewed Sep 12, 2025

View reviewed changes

hdamker requested changes Sep 12, 2025

View reviewed changes

CHANGELOG.md Show resolved Hide resolved

CHANGELOG.md Outdated Show resolved Hide resolved

CHANGELOG.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

documentation/API_documentation/webrtc-call-handling-API-Readiness-Checklist.md Show resolved Hide resolved

This was referenced Sep 18, 2025

[Fall25] ErrorInfo misaligned with commonalities r3.3 #112

Closed

fix: ErrorInfo updated descriptions #113

Merged

stroncoso-quobis commented Sep 18, 2025

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

CHANGELOG.md Show resolved Hide resolved

CHANGELOG.md Outdated Show resolved Hide resolved

documentation/API_documentation/webrtc-call-handling-API-Readiness-Checklist.md Show resolved Hide resolved

doc: Fixed API doc release review comments

2f0b5c0

hdamker reviewed Sep 18, 2025

View reviewed changes

tanjadegroot reviewed Sep 18, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

This was referenced Sep 19, 2025

PascalCase for Objects naming #114

Open

Doc titles at YAML #115

Closed

stroncoso-quobis commented Sep 22, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

stroncoso-quobis added 4 commits September 22, 2025 12:54

doc: fix README links to tag r2.2

38c1c2d

doc: Align YAML inline doc titles with template

2289d0f

fix: Replaced server path from [vx.yrc1] to [vx.y]

27554cf

doc: Added to CHANGELOG merged PR camaraproject#103 during release re…

8d47f71

…view

stroncoso-quobis requested review from hdamker and tanjadegroot September 22, 2025 11:23

stroncoso-quobis mentioned this pull request Sep 22, 2025

OperationID review #116

Open

stroncoso-quobis added 3 commits September 23, 2025 08:38

doc: Fixed CHANGELOG link to commonalites PR

76321d0

doc: Aligned contents for Authorization and Authentication

43f36d8

fix: ErrorInfo field order aligned

c2d9296

Conflict resolve: Merge branch 'origin/main' into release-r22

a3ab467

hdamker approved these changes Sep 23, 2025

View reviewed changes

teikuran approved these changes Sep 23, 2025

View reviewed changes

stroncoso-quobis merged commit 7d9f8af into camaraproject:main Sep 23, 2025
2 checks passed

Conversation

stroncoso-quobis commented Aug 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for reviewers:

Changelog input

Additional documentation

Uh oh!

hdamker left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hdamker left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hdamker left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hdamker left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hdamker commented Sep 12, 2025

Uh oh!

tanjadegroot commented Sep 17, 2025

Uh oh!

tanjadegroot commented Sep 17, 2025

Uh oh!

stroncoso-quobis commented Sep 18, 2025

Uh oh!

tanjadegroot commented Sep 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stroncoso-quobis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stroncoso-quobis commented Sep 18, 2025

Uh oh!

hdamker left a comment

Choose a reason for hiding this comment

Uh oh!

hdamker commented Sep 18, 2025

Uh oh!

Uh oh!

stroncoso-quobis left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

stroncoso-quobis commented Sep 22, 2025

Uh oh!

hdamker commented Sep 22, 2025

Uh oh!

hdamker commented Sep 23, 2025

Uh oh!

stroncoso-quobis commented Sep 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stroncoso-quobis commented Sep 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hdamker commented Sep 23, 2025

Uh oh!

hdamker left a comment • edited by stroncoso-quobis Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stroncoso-quobis commented Aug 29, 2025 •

edited

Loading

hdamker left a comment •

edited

Loading

hdamker left a comment •

edited

Loading

hdamker left a comment •

edited

Loading

tanjadegroot commented Sep 18, 2025 •

edited

Loading

stroncoso-quobis left a comment •

edited

Loading

stroncoso-quobis commented Sep 23, 2025 •

edited

Loading

stroncoso-quobis commented Sep 23, 2025 •

edited

Loading

hdamker left a comment •

edited by stroncoso-quobis

Loading