Release Review: WebRTC r3.2 (rc Sync26)

CHANGELOG/CHANGELOG-r3.md

@@ -2,6 +2,7 @@
 
 <!-- TOC:START -->
 ## Table of Contents
+- [r3.2](#r32)
 - [r3.1](#r31)
 <!-- TOC:END -->
 
@@ -14,6 +15,154 @@ 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
 
+# r3.2
+
+## Release Notes
+
+This release candidate contains the definition and documentation of
+* webrtc-call-handling 0.4.0-rc.2
+* webrtc-events-subscriptions 0.3.0-rc.2
+* webrtc-registration 0.4.0-rc.2
+
+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
+* Release Automation: Post-release sync (r3.1) by @camara-release-automation[bot] in https://github.com/camaraproject/WebRTC/pull/232
+* ISSUE-221 - Documentation review by @stroncoso in https://github.com/camaraproject/WebRTC/pull/237
+* ISSUE-236 - Release plan: r3.2 - Commonalities: r4.4 by @stroncoso in https://github.com/camaraproject/WebRTC/pull/238
+* Sync common files from Commonalities r4.4 by @camara-release-automation[bot] in https://github.com/camaraproject/WebRTC/pull/239
+* ISSUE-236: Align API with commonalities r4.4 by @stroncoso in https://github.com/camaraproject/WebRTC/pull/241
+* ISSUE-235 - Test scenarios review and aligment with Commonalities r4.4 by @stroncoso in https://github.com/camaraproject/WebRTC/pull/243
+* ISSUE-234 - Fix API schema inconsistences for r3.2 by @stroncoso in https://github.com/camaraproject/WebRTC/pull/244
+* ISSUE-219 - String patterns, remove S-313 warning annotations by @stroncoso in https://github.com/camaraproject/WebRTC/pull/245
+
+</details>
+<!-- END:AUTOGENERATED:CANDIDATE_CHANGES -->
+
+## webrtc-call-handling 0.4.0-rc.2
+
+**webrtc-call-handling 0.4.0-rc.2 is a release-candidate version of this API.**
+
+Changes documented below are compared to version 0.4.0-rc.1.
+
+- API definition **with inline documentation**:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r3.2/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.2/code/API_definitions/webrtc-call-handling.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/WebRTC/blob/r3.2/code/API_definitions/webrtc-call-handling.yaml)
+
+### Breaking changes
+
+* fix: unsupported EMERGENCY `callType` returns `422 WEBRTC_CALL_HANDLING.CALLTYPE_EMERGENCY_NOT_SUPPORTED` instead of `501` at PR [#241](https://github.com/camaraproject/WebRTC/pull/241)
+* fix: `PUT /sessions/{mediaSessionId}/status` returns `200` with the current session only, `204` removed at PR [#241](https://github.com/camaraproject/WebRTC/pull/241)
+
+### Added
+
+* N/A
+
+### Changed
+
+* fix: unsupported EMERGENCY `callType` returns `422 WEBRTC_CALL_HANDLING.CALLTYPE_EMERGENCY_NOT_SUPPORTED` instead of `501` at PR [#241](https://github.com/camaraproject/WebRTC/pull/241)
+* fix: `PUT /sessions/{mediaSessionId}/status` returns `200` with the current session only, `204` removed at PR [#241](https://github.com/camaraproject/WebRTC/pull/241)
+* task: align with Commonalities r4.4 (0.9.0): common error responses referenced from `CAMARA_common.yaml`, mandatory `info.description` templates updated at PR [#241](https://github.com/camaraproject/WebRTC/pull/241)
+
+### Fixed
+
+* fix: align inline documentation and examples with the API definition (`POST /sessions` example with required `offer`, pick-up example with `Connected` and `answer`) at PR [#237](https://github.com/camaraproject/WebRTC/pull/237)
+* fix: `MediaSessionCreate` no longer inherits `status` and `answer`; status update examples match `MediaSessionStatusChange` at PR [#244](https://github.com/camaraproject/WebRTC/pull/244)
+* fix: add `pattern` to unrestricted string fields at PR [#245](https://github.com/camaraproject/WebRTC/pull/245)
+
+### Removed
+
+* fix: remove unused error codes `INVALID_TOKEN_CONTEXT` and `IDENTIFIER_NOT_FOUND` at PR [#241](https://github.com/camaraproject/WebRTC/pull/241)
+
+## webrtc-events-subscriptions 0.3.0-rc.2
+
+**webrtc-events-subscriptions 0.3.0-rc.2 is a release-candidate version of this API.**
+
+Changes documented below are compared to version 0.3.0-rc.1.
+
+- API definition **with inline documentation**:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r3.2/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.2/code/API_definitions/webrtc-events-subscriptions.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/WebRTC/blob/r3.2/code/API_definitions/webrtc-events-subscriptions.yaml)
+
+### Breaking changes
+
+* fix: `subscriptionId` is required in `MediaSession` and `RegistrationEnds` event data at PR [#244](https://github.com/camaraproject/WebRTC/pull/244)
+* fix: remove unused `initialEvent` and `subscriptionMaxEvents` from `Config`, and `MAX_EVENTS_REACHED` from `TerminationReason` at PR [#244](https://github.com/camaraproject/WebRTC/pull/244)
+* fix: remove `PUT /subscriptions/{subscriptionId}` and the `webrtc-events-subscriptions:update` scope; to change a subscription, delete and create it again at PR [#244](https://github.com/camaraproject/WebRTC/pull/244)
+
+### Added
+
+* N/A
+
+### Changed
+
+* fix: `subscriptionId` is required in `MediaSession` and `RegistrationEnds` event data at PR [#244](https://github.com/camaraproject/WebRTC/pull/244)
+* fix: `registration-ends` event no longer ends the subscription, aligned with webrtc-registration at PR [#237](https://github.com/camaraproject/WebRTC/pull/237)
+* fix: rename callback operationId to `postNotification` (no change on the wire) at PR [#244](https://github.com/camaraproject/WebRTC/pull/244)
+* task: align with Commonalities r4.4 (0.9.0): common error responses referenced from `CAMARA_common.yaml` and `CAMARA_event_common.yaml`, mandatory `info.description` templates updated at PR [#241](https://github.com/camaraproject/WebRTC/pull/241)
+
+### Fixed
+
+* fix: align inline documentation with the API definition (three event types, subscription examples per `deviceId`, `/sessions/{mediaSessionId}` path) at PR [#237](https://github.com/camaraproject/WebRTC/pull/237)
+* fix: `Subscription.types` accepts up to 3 items, matching the request at PR [#244](https://github.com/camaraproject/WebRTC/pull/244)
+* fix: `MediaSession` address pattern matches `Address` in webrtc-call-handling at PR [#244](https://github.com/camaraproject/WebRTC/pull/244)
+* fix: add `pattern` to unrestricted string fields at PR [#245](https://github.com/camaraproject/WebRTC/pull/245)
+
+### Removed
+
+* fix: remove unused `initialEvent` and `subscriptionMaxEvents` from `Config`, and `MAX_EVENTS_REACHED` from `TerminationReason` at PR [#244](https://github.com/camaraproject/WebRTC/pull/244)
+* fix: remove `PUT /subscriptions/{subscriptionId}` and the `webrtc-events-subscriptions:update` scope at PR [#244](https://github.com/camaraproject/WebRTC/pull/244)
+
+## webrtc-registration 0.4.0-rc.2
+
+**webrtc-registration 0.4.0-rc.2 is a release-candidate version of this API.**
+
+Changes documented below are compared to version 0.4.0-rc.1.
+
+- API definition **with inline documentation**:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r3.2/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.2/code/API_definitions/webrtc-registration.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/WebRTC/blob/r3.2/code/API_definitions/webrtc-registration.yaml)
+
+### Breaking changes
+
+* fix: rename API-specific error codes with the `WEBRTC_REGISTRATION.` prefix (`MAX_DEVICES_PER_USER`, `MAX_REGISTRATION_PER_MSISDN`, `MAX_REGISTRATION_PER_USER`) at PR [#241](https://github.com/camaraproject/WebRTC/pull/241)
+* fix: `PUT /sessions/{registrationId}` returns `200` with `expiresAt` only, `204` removed at PR [#241](https://github.com/camaraproject/WebRTC/pull/241)
+
+### Added
+
+* N/A
+
+### Changed
+
+* fix: rename API-specific error codes with the `WEBRTC_REGISTRATION.` prefix (`MAX_DEVICES_PER_USER`, `MAX_REGISTRATION_PER_MSISDN`, `MAX_REGISTRATION_PER_USER`) at PR [#241](https://github.com/camaraproject/WebRTC/pull/241)
+* fix: `PUT /sessions/{registrationId}` returns `200` with `expiresAt` only, `204` removed at PR [#241](https://github.com/camaraproject/WebRTC/pull/241)
+* fix: registration refresh honours the requested `registrationExpireTime` within the allowed range at PR [#237](https://github.com/camaraproject/WebRTC/pull/237)
+* task: align with Commonalities r4.4 (0.9.0): common error responses referenced from `CAMARA_common.yaml`, mandatory `info.description` templates updated at PR [#241](https://github.com/camaraproject/WebRTC/pull/241)
+
+### Fixed
+
+* fix: add `pattern` to unrestricted string fields at PR [#245](https://github.com/camaraproject/WebRTC/pull/245)
+
+### Removed
+
+* fix: remove unused error codes `EMERGENCY_ADDRESS_MISSING`, `INVALID_TOKEN_CONTEXT` and `IDENTIFIER_NOT_FOUND` at PR [#241](https://github.com/camaraproject/WebRTC/pull/241)
+
+**Full Changelog**: https://github.com/camaraproject/WebRTC/compare/r3.1...r3.2
+
 # r3.1
 
 ## Release Notes