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
134 changes: 134 additions & 0 deletions CHANGELOG/CHANGELOG-r1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
# Changelog ClickToDial

<!-- TOC:START -->
## Table of Contents
- [r1.2](#r12)
- [r1.1](#r11)
<!-- 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

# r1.2

## Release Notes

This release candidate contains the definition and documentation of
* click-to-dial 0.1.0-rc.1

The API definition(s) are based on
* Commonalities v0.7.0-rc.1
* Identity and Consent Management v0.5.0-rc.1

## click-to-dial 0.1.0-rc.1

**click-to-dial 0.1.0-rc.1 is a pre-release version of the click-to-dial API**

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

### Added

* Introduced the fully RESTful `/calls` resource model:
* `POST /calls`
* `GET /calls/{callId}`
* `DELETE /calls/{callId}`
* `GET /calls/{callId}/recording`
* CloudEvents-based call status change notifications:
* type: `org.camaraproject.click-to-dial.v0.status-changed`
* specversion: "1.0"
* Structured `422 UnprocessableEntity` business validation error codes:
* `INVALID_PHONE_NUMBER`
* `SAME_CALLER_CALLEE`
* `RECORDING_NOT_SUPPORTED`
* `CALLER_NOT_AVAILABLE`
* `CALLEE_NOT_AVAILABLE`

### Changed

* Enum values aligned with CAMARA lowerCamelCase conventions for status and reason.
* Updated sink credential schema to enforce `credentialType = "ACCESSTOKEN"`.
* Updated BDD test definitions to reflect the `/calls` endpoints and versioned base paths.
* Improved alignment of OpenAPI definitions and markdown API documentation examples.

### Fixed

* Corrected CloudEvent examples to match defined schemas and enum values.
* Resolved inconsistencies between error examples and the `ErrorInfo` schema.

### Removed

* Removed deprecated operations from earlier alpha versions:
* `beginCall`
* `releaseCall`
* `downloadRecording`

These have been replaced by the RESTful `/calls` design.

### New Contributors

- N/A

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

# r1.1

## Release Note

This release contains the definition and documentation of

- click-to-dial v0.1.0-alpha.1

The API definition(s) are based on

- Commonalities v0.5.0
- Identity and Consent Management v0.3.0

## click-to-dial v0.1.0-alpha.1

click-to-dial v0.1.0-alpha.1 is the first pre-release version of the click-to-dial API.

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

## Added

- Update for fall2025 by @YadingFang in [#22](https://github.com/camaraproject/ClickToDial/pull/22), [#27](https://github.com/camaraproject/ClickToDial/pull/27), [#29](https://github.com/camaraproject/ClickToDial/pull/29), [#31](https://github.com/camaraproject/ClickToDial/pull/31), [#32](https://github.com/camaraproject/ClickToDial/pull/32)
- Create Click to Dial_API.md by @wuhonglin in [#9](https://github.com/camaraproject/ClickToDial/pull/9)
- Add Click to Dial support material by @HanbaiWang in [#6](https://github.com/camaraproject/ClickToDial/pull/6)
- Create Click to Dial_User_Story by @seekwain in [#11](https://github.com/camaraproject/ClickToDial/pull/11)
- Add API yaml files by @seekwain in [#10](https://github.com/camaraproject/ClickToDial/pull/10)
- Create Click to Dial_API.md by @wuhonglin in [#9](https://github.com/camaraproject/ClickToDial/pull/9)
- Add CTD support material by @HanbaiWang in [#6](https://github.com/camaraproject/ClickToDial/pull/6)

## Changed

- N/A

## Fixed

- N/A

## Removed

- N/A

## New Contributors

- @HanbaiWang made their first contribution in [#4](https://github.com/camaraproject/ClickToDial/pull/4)
- @wuhonglin made their first contribution in [#9](https://github.com/camaraproject/ClickToDial/pull/9)
- @seekwain made their first contribution in [#10](https://github.com/camaraproject/ClickToDial/pull/10)
- @YadingFang make their first contribution in [#22](https://github.com/camaraproject/ClickToDial/pull/22)

**Full Changelog**: [https://github.com/camaraproject/ClickToDial/commits/r1.1/](https://github.com/camaraproject/ClickToDial/commits/r1.1/)

11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,11 @@ Sandbox API Repository to describe, develop, document, and test the ClickToDial
> [!NOTE]
> This repository has only pre-release versions available yet. Pre-releases are for testing and may change before public release.

* **PREVIEW**: The latest pre-release is [r1.1](https://github.com/camaraproject/ClickToDial/releases/tag/r1.1) (alpha), with the following API versions:
* **click-to-dial v0.1.0-alpha.1**
[[YAML]](https://github.com/camaraproject/ClickToDial/blob/r1.1/code/API_definitions/click-to-dial.yaml)
[[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ClickToDial/r1.1/code/API_definitions/click-to-dial.yaml&nocors)
[[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ClickToDial/r1.1/code/API_definitions/click-to-dial.yaml)
* For changes see [CHANGELOG.md](https://github.com/camaraproject/ClickToDial/blob/main/CHANGELOG.md)
* The latest pre-release is [r1.2](https://github.com/camaraproject/ClickToDial/releases/tag/r1.2) (release candidate), with the following API versions:
* **click-to-dial 0.1.0-rc.1**
[[YAML]](https://github.com/camaraproject/ClickToDial/blob/r1.2/code/API_definitions/click-to-dial.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ClickToDial/r1.2/code/API_definitions/click-to-dial.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ClickToDial/r1.2/code/API_definitions/click-to-dial.yaml)

* For changes see [CHANGELOG](https://github.com/camaraproject/ClickToDial/tree/main/CHANGELOG)

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