Skip to content

Release Automation: Post-release sync (r3.1) #232

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

Merged
stroncoso merged 1 commit into from
Sep 25, 2026
+180 −14
Merged

Release Automation: Post-release sync (r3.1) #232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
160 changes: 160 additions & 0 deletions CHANGELOG/CHANGELOG-r3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
# Changelog WebRTC

<!-- TOC:START -->
## Table of Contents
- [r3.1](#r31)
<!-- TOC:END -->

**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.**

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

# r3.1

## Release Notes

This release candidate contains the definition and documentation of
* webrtc-call-handling 0.4.0-rc.1
* webrtc-events-subscriptions 0.3.0-rc.1
* webrtc-registration 0.4.0-rc.1

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

## webrtc-call-handling 0.4.0-rc.1

**webrtc-call-handling 0.4.0-rc.1 is a release-candidate version of this API.**

Changes documented below are compared to version 0.3.0.

- API definition **with inline documentation**:
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r3.1/code/API_definitions/webrtc-call-handling.yaml&nocors)
- [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r3.1/code/API_definitions/webrtc-call-handling.yaml)
- OpenAPI [YAML spec file](https://github.com/camaraproject/WebRTC/blob/r3.1/code/API_definitions/webrtc-call-handling.yaml)

### Breaking changes

* enhance: possibly breaking down MediaSessionInformation into distinct schema at PR [#164](https://github.com/camaraproject/WebRTC/pull/164)

### Added

* feat: add Emergency Calling support (callType + PIDF-LO location) at PR [#120](https://github.com/camaraproject/WebRTC/pull/120)
* feat: use optional originatorLocationDetails as part of the call request at PR [#142](https://github.com/camaraproject/WebRTC/pull/142)
* feat: add anonymous call origination (sip:anonymous@anonymous.invalid) and home local number support to the Address schema at PR [#178](https://github.com/camaraproject/WebRTC/pull/178)

### Changed

* enhance: possibly breaking down MediaSessionInformation into distinct schema at PR [#164](https://github.com/camaraproject/WebRTC/pull/164)
* task: sync common files (error responses, headers, security schemes) to Commonalities r4.2 at PR [#172](https://github.com/camaraproject/WebRTC/pull/172)
* task: sync common files (error responses, headers, security schemes) to Commonalities r4.3 at PR [#193](https://github.com/camaraproject/WebRTC/pull/193)
* task: add mandatory info.description templates (authorization and authentication, additional error responses, request body strictness) at PR [#202](https://github.com/camaraproject/WebRTC/pull/202)
* fix: standardize apiRoot server variable description at PR [#225](https://github.com/camaraproject/WebRTC/pull/225)
* fix: rename tag `Call handling` to `Call Handling` (Title Case) at PR [#226](https://github.com/camaraproject/WebRTC/pull/226)

### Fixed

* fix: Commonalities v4.2 alignment at PR [#174](https://github.com/camaraproject/WebRTC/pull/174)
* fix: add missing x-correlator response header to PUT /sessions/{mediaSessionId}/status 200 and 204 responses at PR [#222](https://github.com/camaraproject/WebRTC/pull/222)
* fix: document RFC 3339 format for LocationDetails timestamp at PR [#227](https://github.com/camaraproject/WebRTC/pull/227)

### Removed

* fix: remove reason and sequenceNumber fields from MediaSessionInformation at PR [#119](https://github.com/camaraproject/WebRTC/pull/119)
* fix: remove clientCorrelator, serverCorrelator, callObjectRef, and offerRequired at PR [#124](https://github.com/camaraproject/WebRTC/pull/124)

## webrtc-events-subscriptions 0.3.0-rc.1

**webrtc-events-subscriptions 0.3.0-rc.1 is a 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/WebRTC/r3.1/code/API_definitions/webrtc-events-subscriptions.yaml&nocors)
- [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r3.1/code/API_definitions/webrtc-events-subscriptions.yaml)
- OpenAPI [YAML spec file](https://github.com/camaraproject/WebRTC/blob/r3.1/code/API_definitions/webrtc-events-subscriptions.yaml)

### Breaking changes

* fix: decouple WebRTC-Events subscriptions from specific media session or registration at PR [#126](https://github.com/camaraproject/WebRTC/pull/126)
* fix: CloudEvent structure review and rename API to webrtc-events-subscriptions at PR [#183](https://github.com/camaraproject/WebRTC/pull/183)
* task: rename events API and bump commonalities release at PR [#185](https://github.com/camaraproject/WebRTC/pull/185)

### Added

* feat: add PUT /subscriptions/{subscriptionId} to update sink credentials and duration at PR [#152](https://github.com/camaraproject/WebRTC/pull/152)
* feat: require differentiating originator and receiver location in event payloads at PR [#142](https://github.com/camaraproject/WebRTC/pull/142)
* fix: support multiple event types per subscription at PR [#156](https://github.com/camaraproject/WebRTC/pull/156)

### Changed

* fix: decouple WebRTC-Events subscriptions from specific media session or registration at PR [#126](https://github.com/camaraproject/WebRTC/pull/126)
* fix: CloudEvent structure review and rename API to webrtc-events-subscriptions at PR [#183](https://github.com/camaraproject/WebRTC/pull/183)
* task: rename events API and bump commonalities release at PR [#185](https://github.com/camaraproject/WebRTC/pull/185)
* fix: update WebRTC subscription examples and developer guidance at PR [#151](https://github.com/camaraproject/WebRTC/pull/151)
* fix: Commonalities v4.2 alignment at PR [#174](https://github.com/camaraproject/WebRTC/pull/174)
* task: sync common files (error responses, headers, security schemes, CloudEvent template) to Commonalities r4.2 at PR [#172](https://github.com/camaraproject/WebRTC/pull/172)
* task: sync common files (error responses, headers, security schemes, CloudEvent template) to Commonalities r4.3 at PR [#193](https://github.com/camaraproject/WebRTC/pull/193)
* task: add mandatory info.description templates (authorization and authentication, additional error responses, request body strictness) at PR [#202](https://github.com/camaraproject/WebRTC/pull/202)
* fix: rename local CloudEvent wrapper schema to WebrtcEventNotification at PR [#212](https://github.com/camaraproject/WebRTC/pull/212)
* fix: standardize apiRoot server variable description at PR [#225](https://github.com/camaraproject/WebRTC/pull/225)
* fix: rename tag `Webrtc-events Subscription` to `Webrtc Events Subscription` (Title Case) at PR [#226](https://github.com/camaraproject/WebRTC/pull/226)

### Fixed

* fix: correct example field name accessTokenExpireUtc to accessTokenExpiresUtc at PR [#151](https://github.com/camaraproject/WebRTC/pull/151)
* fix: mark AccessTokenCredential accessToken and accessTokenType as writeOnly at PR [#223](https://github.com/camaraproject/WebRTC/pull/223)
* fix: document RFC 3339 format for LocationDetails timestamp at PR [#227](https://github.com/camaraproject/WebRTC/pull/227)

### Removed

* fix: remove clientCorrelator, serverCorrelator, callObjectRef, and offerRequired at PR [#124](https://github.com/camaraproject/WebRTC/pull/124)
* fix: remove unused HTTPSubscriptionRequest, HTTPSubscriptionResponse and HTTPSettings schemas at PR [#224](https://github.com/camaraproject/WebRTC/pull/224)

## webrtc-registration 0.4.0-rc.1

**webrtc-registration 0.4.0-rc.1 is a release-candidate version of this API.**

Changes documented below are compared to version 0.3.0.

- API definition **with inline documentation**:
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r3.1/code/API_definitions/webrtc-registration.yaml&nocors)
- [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r3.1/code/API_definitions/webrtc-registration.yaml)
- OpenAPI [YAML spec file](https://github.com/camaraproject/WebRTC/blob/r3.1/code/API_definitions/webrtc-registration.yaml)

### Breaking changes

* feat: add optional phoneNumber to POST /sessions with strict token-type handling at PR [#187](https://github.com/camaraproject/WebRTC/pull/187)

### Added

* feat: add GET /sessions and GET /sessions/{registrationId} at PR [#169](https://github.com/camaraproject/WebRTC/pull/169)
* feat: add optional phoneNumber to POST /sessions with strict token-type handling at PR [#187](https://github.com/camaraproject/WebRTC/pull/187)

### Changed

* fix: clarification on the POST /sessions operation at PR [#180](https://github.com/camaraproject/WebRTC/pull/180)
* fix: clarification on registration expiration at PR [#166](https://github.com/camaraproject/WebRTC/pull/166)
* fix: clarification on registrationExpireTime at PR [#165](https://github.com/camaraproject/WebRTC/pull/165)
* task: sync common files (error responses, headers, security schemes) to Commonalities r4.2 at PR [#172](https://github.com/camaraproject/WebRTC/pull/172)
* task: sync common files (error responses, headers, security schemes) to Commonalities r4.3 at PR [#193](https://github.com/camaraproject/WebRTC/pull/193)
* task: add mandatory info.description templates (authorization and authentication, additional error responses, request body strictness) at PR [#202](https://github.com/camaraproject/WebRTC/pull/202)
* fix: clarify registration retrieval scoping by phoneNumber and correct example registrationId at PR [#204](https://github.com/camaraproject/WebRTC/pull/204)
* fix: clarify client-side phoneNumber requirements per token type at PR [#205](https://github.com/camaraproject/WebRTC/pull/205)
* fix: standardize apiRoot server variable description at PR [#225](https://github.com/camaraproject/WebRTC/pull/225)

### Fixed

* fix: correct POST /sessions response code from 200 to 201 and deviceId field format at PR [#169](https://github.com/camaraproject/WebRTC/pull/169)
* fix: Commonalities v4.2 alignment at PR [#174](https://github.com/camaraproject/WebRTC/pull/174)
* fix: close unclosed backtick in API description at PR [#212](https://github.com/camaraproject/WebRTC/pull/212)

### Removed

* N/A

**Full Changelog**: https://github.com/camaraproject/WebRTC/compare/r2.2...r3.1

34 changes: 20 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,22 +31,28 @@ Sandbox API Repository to describe, develop, document, and test the WebRTC Servi
> [!NOTE]
> 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 a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.

* **NEW**: The latest public release is [r2.2](https://github.com/camaraproject/WebRTC/releases/tag/r2.2) (Fall25), with the following API versions:
* **webrtc-call-handling v0.3.0**
[[YAML]](https://github.com/camaraproject/WebRTC/blob/r2.2/code/API_definitions/webrtc-call-handling.yaml)
[[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r2.2/code/API_definitions/webrtc-call-handling.yaml&nocors)
[[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r2.2/code/API_definitions/webrtc-call-handling.yaml)
* **webrtc-events v0.2.0**
[[YAML]](https://github.com/camaraproject/WebRTC/blob/r2.2/code/API_definitions/webrtc-events.yaml)
[[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r2.2/code/API_definitions/webrtc-events.yaml&nocors)
[[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r2.2/code/API_definitions/webrtc-events.yaml)
* **webrtc-registration v0.3.0**
[[YAML]](https://github.com/camaraproject/WebRTC/blob/r2.2/code/API_definitions/webrtc-registration.yaml)
[[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r2.2/code/API_definitions/webrtc-registration.yaml&nocors)
[[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r2.2/code/API_definitions/webrtc-registration.yaml)
* The latest public release is [r2.2](https://github.com/camaraproject/WebRTC/releases/tag/r2.2), with the following API versions:
* **webrtc-call-handling 0.3.0**
[[YAML]](https://github.com/camaraproject/WebRTC/blob/r2.2/code/API_definitions/webrtc-call-handling.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r2.2/code/API_definitions/webrtc-call-handling.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r2.2/code/API_definitions/webrtc-call-handling.yaml)
* **webrtc-events 0.2.0**
[[YAML]](https://github.com/camaraproject/WebRTC/blob/r2.2/code/API_definitions/webrtc-events.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r2.2/code/API_definitions/webrtc-events.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r2.2/code/API_definitions/webrtc-events.yaml)
* **webrtc-registration 0.3.0**
[[YAML]](https://github.com/camaraproject/WebRTC/blob/r2.2/code/API_definitions/webrtc-registration.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r2.2/code/API_definitions/webrtc-registration.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r2.2/code/API_definitions/webrtc-registration.yaml)

* The latest public release is always available here: https://github.com/camaraproject/WebRTC/releases/latest
* Other releases of this repository are available in https://github.com/camaraproject/WebRTC/releases
* For changes see [CHANGELOG.md](https://github.com/camaraproject/WebRTC/blob/main/CHANGELOG.md)
* For changes see [CHANGELOG](https://github.com/camaraproject/WebRTC/tree/main/CHANGELOG)

### Upcoming Release Preview

* Pre-release: [r3.1](https://github.com/camaraproject/WebRTC/releases/tag/r3.1) (release candidate)
* **webrtc-call-handling 0.4.0-rc.1**
[[YAML]](https://github.com/camaraproject/WebRTC/blob/r3.1/code/API_definitions/webrtc-call-handling.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r3.1/code/API_definitions/webrtc-call-handling.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r3.1/code/API_definitions/webrtc-call-handling.yaml)
* **webrtc-events-subscriptions 0.3.0-rc.1**
[[YAML]](https://github.com/camaraproject/WebRTC/blob/r3.1/code/API_definitions/webrtc-events-subscriptions.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r3.1/code/API_definitions/webrtc-events-subscriptions.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r3.1/code/API_definitions/webrtc-events-subscriptions.yaml)
* **webrtc-registration 0.4.0-rc.1**
[[YAML]](https://github.com/camaraproject/WebRTC/blob/r3.1/code/API_definitions/webrtc-registration.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r3.1/code/API_definitions/webrtc-registration.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r3.1/code/API_definitions/webrtc-registration.yaml)


_The above section is automatically synchronized by CAMARA project-administration._
<!-- CAMARA:RELEASE-INFO:END -->
Expand Down
Loading