Skip to content

Release Review: ClickToDial r2.3 (public Sync26) #134

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 3 commits into
base: release-snapshot/r2.3-daff875
Choose a base branch
from
Open

Release Review: ClickToDial r2.3 (public Sync26) #134

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
af99005
Add CHANGELOG draft for r2.3
camara-release-automation[bot] Oct 23, 2026
93ae8dc
Revise changelog with changes and updates
YadingFang Oct 23, 2026
18c7573
Update CHANGELOG with new user stories and criteria
YadingFang Oct 23, 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
83 changes: 83 additions & 0 deletions CHANGELOG/CHANGELOG-r2.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
- **[r2.3](#r23)**
- [r2.2](#r22)
- [r2.1](#r21)
<!-- TOC:END -->
Expand All @@ -15,6 +16,88 @@ 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

# r2.3

## Release Notes

This public release contains the definition and documentation of
* click-to-dial 0.2.0

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 (r1.4) by @camara-release-automation[bot] in https://github.com/camaraproject/ClickToDial/pull/107
* Update release plan for Sync26 ClickToDial 0.2.0-rc by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/108
* Clarify ClickToDial lifecycle and callback documentation by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/110
* Add enhanced ClickToDial rainy-day test scenarios by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/111
* Fix ClickToDial documentation compliance issues by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/115
* Release Automation: Post-release sync (r2.1) by @camara-release-automation[bot] in https://github.com/camaraproject/ClickToDial/pull/117
* prepare r2.2 with Commonalities r4.4 by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/119
* Sync common files from Commonalities r4.4 by @camara-release-automation[bot] in https://github.com/camaraproject/ClickToDial/pull/120
* Align ClickToDial with Commonalities r4.4 by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/122
* Release Automation: Post-release sync (r2.2) by @camara-release-automation[bot] in https://github.com/camaraproject/ClickToDial/pull/125
* chore: remove obsolete v0 validation caller workflows by @hdamker in https://github.com/camaraproject/ClickToDial/pull/127
* Simplify supplementary error documentation by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/126
* Fix mandatory info description spacing by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/129
* Align ClickToDial callback behavior with Commonalities r4.4 by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/131
* Plan ClickToDial Sync26 M4 public release r2.3 by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/132

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

## click-to-dial 0.2.0

**click-to-dial 0.2.0 is an initial public version of this API.**

Changes documented below are compared to version 0.1.0.

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

### Breaking changes

* Restricted `CreateCallRequest.sink` to HTTPS URLs only. Requests containing a non-HTTPS sink are rejected with `400 INVALID_ARGUMENT`.
* Added `410 SinkGone410` and `429 TooManyRequests429` as documented responses for the callback operation.

### Added

* Added `EVENT_NOTIFICATIONS_NOT_SUPPORTED` as a `422` error when `POST /calls` includes a `sink` but the provider does not support event notification delivery. No call resource is created in this case.
* Added the optional `sink` property to the `Call` resource. An accepted sink URL is returned by `POST /calls` and subsequent `GET /calls/{callId}` responses. Credentials and access tokens are never returned.
* Added detailed user stories and acceptance criteria for creating calls with status notifications, terminating active calls, and retrieving recordings when available.

### Changed

* Restricted `CreateCallRequest.sink` to HTTPS URLs only, rejecting non-HTTPS values with `400 INVALID_ARGUMENT`.
* Clarified callback authentication: `sinkCredential` is optional. When omitted, notifications may be delivered to an HTTPS sink without Bearer authentication. When a credential is provided, the specified authentication mechanism is used. Authentication for API requests remains unchanged.
* Added the `410 SinkGone410` and `429 TooManyRequests429` callback responses.
* Clarified `accessTokenExpiresUtc` semantics: token expiration SHOULD occur after the call's lifetime. If the token expires while the call is active, notifications stop.
* Clarified the aggregate call lifecycle, recording availability conditions, callback delivery failure behavior, and state reconciliation through `GET /calls/{callId}`.
* Aligned the API definition and documentation with Commonalities r4.4, including callback behavior and reusable error response definitions.

### Fixed

* Added the `x-correlator` request header to callback notifications and the corresponding header to successful callback responses.
* Corrected API documentation and examples to align with the OpenAPI definition and Commonalities, including authentication guidance and CloudEvents details.

### Removed

* N/A

**Full Changelog**: https://github.com/camaraproject/ClickToDial/compare/r1.4...r2.3

# r2.2

## Release Notes
Expand Down
Loading