diff --git a/CHANGELOG/CHANGELOG-r2.md b/CHANGELOG/CHANGELOG-r2.md new file mode 100644 index 0000000..c3ad64f --- /dev/null +++ b/CHANGELOG/CHANGELOG-r2.md @@ -0,0 +1,84 @@ +# Changelog ClickToDial + + +## Table of Contents +- [r2.1](#r21) + + +**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 + +# r2.1 + +## Release Notes + +This release candidate contains the definition and documentation of +* click-to-dial 0.2.0-rc.1 + +The API definition(s) are based on +* Commonalities 0.8.0 +* Identity and Consent Management 0.5.0 + + +> **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. + +
+Candidate changes (auto-generated from merged PRs) + +## 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 + +
+ + +## click-to-dial 0.2.0-rc.1 + +**click-to-dial 0.2.0-rc.1 is a release-candidate 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.1/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.1/code/API_definitions/click-to-dial.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/ClickToDial/blob/r2.1/code/API_definitions/click-to-dial.yaml) + +### Breaking changes + +* N/A + +### Added + +* Added detailed ClickToDial call lifecycle documentation, clarifying the provider-managed aggregate call session state and the `initiating`, `callingCaller`, `callingCallee`, `connected`, `disconnected`, and `failed` status values. +* Added detailed user stories and acceptance criteria for creating ClickToDial calls with status notifications, terminating active calls, and retrieving recordings after completed recorded calls. +* Added enhanced Gherkin test scenarios for rainy-day and edge-case behavior across `createCall`, `getCall`, `terminateCall`, and `getRecording`, including malformed and unknown `callId`, authentication and authorization failures, invalid caller/callee inputs, recording availability, and callback event validation. + +### Changed + +* Clarified callback delivery behavior for status notifications, including structured CloudEvents delivery, `CallStatusChangedEvent` usage, sink credential handling, retry behavior, and state reconciliation using `GET /calls/{callId}`. +* Clarified recording availability conditions for `GET /calls/{callId}/recording`, including when a recording can be retrieved and when `404 NOT_FOUND` is returned. +* Improved OpenAPI descriptions for call status, callback events, call creation, and recording retrieval without changing API behavior. + +### Fixed + +* Fixed stale documentation and test references from `EventCTDStatusChanged` to the current `CallStatusChangedEvent` schema. +* Fixed Gherkin test expectations to align callback event `caller` and `callee` values with the phone number payload defined in the OpenAPI schema. +* Fixed recording retrieval test expectations to avoid requiring optional `generatedAt` in `RecordingResource`. + +### Removed + +* N/A + +**Full Changelog**: https://github.com/camaraproject/ClickToDial/compare/r1.4...r2.1 + diff --git a/README.md b/README.md index 8d8d256..6370a24 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ Sandbox API Repository to describe, develop, document, and test the ClickToDial > [!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**. -* The latest public release is [r1.4](https://github.com/camaraproject/ClickToDial/releases/tag/r1.4) (Spring26), with the following API versions: +* The latest public release is [r1.4](https://github.com/camaraproject/ClickToDial/releases/tag/r1.4), with the following API versions: * **click-to-dial 0.1.0** [[YAML]](https://github.com/camaraproject/ClickToDial/blob/r1.4/code/API_definitions/click-to-dial.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ClickToDial/r1.4/code/API_definitions/click-to-dial.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ClickToDial/r1.4/code/API_definitions/click-to-dial.yaml) @@ -38,6 +38,13 @@ Sandbox API Repository to describe, develop, document, and test the ClickToDial * Other releases of this repository are available in https://github.com/camaraproject/ClickToDial/releases * For changes see [CHANGELOG](https://github.com/camaraproject/ClickToDial/tree/main/CHANGELOG) +### Upcoming Release Preview + +* Pre-release: [r2.1](https://github.com/camaraproject/ClickToDial/releases/tag/r2.1) (release candidate) + * **click-to-dial 0.2.0-rc.1** + [[YAML]](https://github.com/camaraproject/ClickToDial/blob/r2.1/code/API_definitions/click-to-dial.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ClickToDial/r2.1/code/API_definitions/click-to-dial.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ClickToDial/r2.1/code/API_definitions/click-to-dial.yaml) + + _The above section is automatically synchronized by CAMARA project-administration._