Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
108 changes: 108 additions & 0 deletions CHANGELOG/CHANGELOG-r1.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

<!-- TOC:START -->
## Table of Contents
- **[r1.4](#r14)**
- [r1.3](#r13)
- [r1.2](#r12)
- [r1.1](#r11)
Expand All @@ -16,6 +17,113 @@ 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

# r1.4

## Release Notes

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

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

<!-- BEGIN:AUTOGENERATED:CANDIDATE_CHANGES -->
> **Working area — candidate changes (auto-removed on merge)**
> Copy relevant entries into the Added/Changed/Fixed/Removed sections below.
> 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
* Add API rpository wiki page link to README.md by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/39
* Codeowner update by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/41
* Embed click-to-dial_API.md into the API definition by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/42
* Remove the API name in the endpoints by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/43
* Modification for CloudEvent model by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/46
* chore: migrate swagger editor links to CAMARA swagger-ui by @hdamker-bot in https://github.com/camaraproject/ClickToDial/pull/48
* admin: add line 13 (API description for marketing) to API readiness checklists by @hdamker-bot in https://github.com/camaraproject/ClickToDial/pull/49
* Technical compliance fixes by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/55
* Reset ClickToDial main branch to wip (Fixes #54) by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/57
* Fix Authorization header value in test plans (fixes #50) by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/58
* refactor(api): migrate ClickToDial to a CAMARA-compliant RESTful call resource model by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/59
* Align Events, Credential Model, Tests and Documentation with CAMARA Guidelines by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/60
* admin: migrate to centralized linting workflows by @hdamker-bot in https://github.com/camaraproject/ClickToDial/pull/53
* docs(api): align /calls with OpenAPI by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/63
* Add callback definition for call status change events by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/64
* Update click-to-dial feature files with resource URLs and x-correlator by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/66
* Align ClouEvent schema, security schemes and clean up intro/error codes by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/67
* Update README terminology and supported features by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/68
* Align API definitions with Commonalities 0.7.0-rc.1 by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/69
* [bulk] Sync Release Information section (2026-02-19-001) by @hdamker-bot in https://github.com/camaraproject/ClickToDial/pull/70
* [bulk] Add release-plan.yaml (2026-02-23-001) by @hdamker-bot in https://github.com/camaraproject/ClickToDial/pull/71
* Update release track and dependencies in release-plan.yaml by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/74
* chore: reset test resource URLs to vwip on main (fixes #75) by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/77
* [bulk] Enable release automation process (2026-03-09-001) by @camara-release-automation[bot] in https://github.com/camaraproject/ClickToDial/pull/80
* test: add Gherkin test definition for getCall operation (fixes #78) by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/81
* Release Automation: Post-release sync (r1.2) by @camara-release-automation[bot] in https://github.com/camaraproject/ClickToDial/pull/84
* Remove obsolete root CHANGELOG.md by @hdamker in https://github.com/camaraproject/ClickToDial/pull/85
* [bulk] Enable release automation and validation (2026-04-10-001) by @camara-release-automation[bot] in https://github.com/camaraproject/ClickToDial/pull/88
* [bulk] Update release-automation + validation callers by @camara-release-automation[bot] in https://github.com/camaraproject/ClickToDial/pull/89
* Update ClickToDial Spring26 M4 release plan baseline by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/92
* Align ClickToDial with Spring26 M4 Commonalities and ICM by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/91
* Change ClickToDial r1.3 release plan back to rc by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/95
* Clean up ClickToDial OAS validation warnings by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/96
* Release Automation: Post-release sync (r1.3) by @camara-release-automation[bot] in https://github.com/camaraproject/ClickToDial/pull/98
* [bulk] Update release-automation + validation callers by @camara-release-automation[bot] in https://github.com/camaraproject/ClickToDial/pull/99
* Prepare ClickToDial Spring26 public release plan by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/103
* Align ClickToDial with Commonalities r4.3 by @YadingFang in https://github.com/camaraproject/ClickToDial/pull/102

## New Contributors
* @hdamker-bot made their first contribution in https://github.com/camaraproject/ClickToDial/pull/48

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

## click-to-dial 0.1.0

**click-to-dial 0.1.0 is the initial public version of the ClickToDial API.**

- API definition **with inline documentation**:
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ClickToDial/r1.4/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/r1.4/code/API_definitions/click-to-dial.yaml)
- OpenAPI [YAML spec file](https://github.com/camaraproject/ClickToDial/blob/r1.4/code/API_definitions/click-to-dial.yaml)

### Added

* Added the initial public ClickToDial API definition with operations to create a call, retrieve call details, terminate a call, and retrieve call recordings when available.
* Added callback support for ClickToDial call status change notifications using the CAMARA CloudEvents-based event model.
* Added support for notification sink credentials aligned with the CAMARA event subscription model.
* Added Gherkin test definitions for the main ClickToDial operations, including create call, get call, terminate call, and get recording.
* Added API documentation and external API description content for public visibility.

### Changed

* Aligned the ClickToDial API definition with Commonalities r4.3 / `0.8.0`.
* Aligned the ClickToDial API definition with Identity and Consent Management r4.2 / `0.5.0`.
* Updated the API to use a CAMARA-compliant RESTful call resource model under `/calls`.
* Updated CAMARA error response schemas and common reusable components to follow the applicable Commonalities model.
* Updated callback notification security and callback response documentation.
* Updated the ClickToDial event model to use the Commonalities CloudEvents envelope while retaining the ClickToDial-specific event type and payload.
* Replaced the ClickToDial-specific `CALL_ALREADY_ACTIVE` 409 error code with the Commonalities-aligned `ALREADY_EXISTS` code.
* Updated schema naming and validation constraints to comply with CAMARA validation rules.
* Updated request-body documentation and schema constraints to align with Commonalities r4.3 request body strictness requirements.

### Fixed

* Fixed CAMARA validation findings so the API definition validates with zero errors and zero warnings.
* Fixed authorization header usage in test definitions.
* Fixed x-correlator handling and resource URLs in test definitions.
* Fixed callback secured-operation response documentation by adding required error responses.

### Removed

* Removed obsolete local wrapper schemas now referenced directly from Commonalities artifacts.

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

# r1.3

## Release Notes
Expand Down
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,14 @@ Sandbox API Repository to describe, develop, document, and test the ClickToDial
## Release Information

> [!NOTE]
> This repository has only pre-release versions available yet. Pre-releases are for testing and may change before public release.
> 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 pre-release is [r1.3](https://github.com/camaraproject/ClickToDial/releases/tag/r1.3) (release candidate), with the following API versions:
* **click-to-dial 0.1.0-rc.2**
[[YAML]](https://github.com/camaraproject/ClickToDial/blob/r1.3/code/API_definitions/click-to-dial.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ClickToDial/r1.3/code/API_definitions/click-to-dial.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ClickToDial/r1.3/code/API_definitions/click-to-dial.yaml)
* The latest public release is [r1.4](https://github.com/camaraproject/ClickToDial/releases/tag/r1.4) (Spring26), 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)

* The latest public release is always available here: https://github.com/camaraproject/ClickToDial/releases/latest
* 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)

_The above section is automatically synchronized by CAMARA project-administration._
Expand Down
Loading