From 11b13d68974f5ac93e4b96d7e46addd68c7abc48 Mon Sep 17 00:00:00 2001 From: "camara-release-automation[bot]" <261643975+camara-release-automation[bot]@users.noreply.github.com> Date: Mon, 13 Jul 2026 06:24:16 +0000 Subject: [PATCH 1/7] Update README Release Information for r3.1 --- README.md | 34 ++++++++++++++++++++-------------- 1 file changed, 20 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 941a7f1..916334a 100644 --- a/README.md +++ b/README.md @@ -31,22 +31,28 @@ Sandbox API Repository to describe, develop, document, and test the WebRTC Servi > [!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**. -* **NEW**: The latest public release is [r2.2](https://github.com/camaraproject/WebRTC/releases/tag/r2.2) (Fall25), with the following API versions: - * **webrtc-call-handling v0.3.0** - [[YAML]](https://github.com/camaraproject/WebRTC/blob/r2.2/code/API_definitions/webrtc-call-handling.yaml) - [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r2.2/code/API_definitions/webrtc-call-handling.yaml&nocors) - [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r2.2/code/API_definitions/webrtc-call-handling.yaml) - * **webrtc-events v0.2.0** - [[YAML]](https://github.com/camaraproject/WebRTC/blob/r2.2/code/API_definitions/webrtc-events.yaml) - [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r2.2/code/API_definitions/webrtc-events.yaml&nocors) - [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r2.2/code/API_definitions/webrtc-events.yaml) - * **webrtc-registration v0.3.0** - [[YAML]](https://github.com/camaraproject/WebRTC/blob/r2.2/code/API_definitions/webrtc-registration.yaml) - [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r2.2/code/API_definitions/webrtc-registration.yaml&nocors) - [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r2.2/code/API_definitions/webrtc-registration.yaml) +* The latest public release is [r2.2](https://github.com/camaraproject/WebRTC/releases/tag/r2.2), with the following API versions: + * **webrtc-call-handling 0.3.0** + [[YAML]](https://github.com/camaraproject/WebRTC/blob/r2.2/code/API_definitions/webrtc-call-handling.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r2.2/code/API_definitions/webrtc-call-handling.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r2.2/code/API_definitions/webrtc-call-handling.yaml) + * **webrtc-events 0.2.0** + [[YAML]](https://github.com/camaraproject/WebRTC/blob/r2.2/code/API_definitions/webrtc-events.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r2.2/code/API_definitions/webrtc-events.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r2.2/code/API_definitions/webrtc-events.yaml) + * **webrtc-registration 0.3.0** + [[YAML]](https://github.com/camaraproject/WebRTC/blob/r2.2/code/API_definitions/webrtc-registration.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r2.2/code/API_definitions/webrtc-registration.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r2.2/code/API_definitions/webrtc-registration.yaml) + * The latest public release is always available here: https://github.com/camaraproject/WebRTC/releases/latest * Other releases of this repository are available in https://github.com/camaraproject/WebRTC/releases -* For changes see [CHANGELOG.md](https://github.com/camaraproject/WebRTC/blob/main/CHANGELOG.md) +* For changes see [CHANGELOG](https://github.com/camaraproject/WebRTC/tree/main/CHANGELOG) + +### Upcoming Release Preview + +* Pre-release: [r3.1](https://github.com/camaraproject/WebRTC/releases/tag/r3.1) (release candidate) + * **webrtc-call-handling 0.4.0-rc.1** + [[YAML]](https://github.com/camaraproject/WebRTC/blob/r3.1/code/API_definitions/webrtc-call-handling.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r3.1/code/API_definitions/webrtc-call-handling.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r3.1/code/API_definitions/webrtc-call-handling.yaml) + * **webrtc-events-subscriptions 0.3.0-rc.1** + [[YAML]](https://github.com/camaraproject/WebRTC/blob/r3.1/code/API_definitions/webrtc-events-subscriptions.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r3.1/code/API_definitions/webrtc-events-subscriptions.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r3.1/code/API_definitions/webrtc-events-subscriptions.yaml) + * **webrtc-registration 0.4.0-rc.1** + [[YAML]](https://github.com/camaraproject/WebRTC/blob/r3.1/code/API_definitions/webrtc-registration.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r3.1/code/API_definitions/webrtc-registration.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r3.1/code/API_definitions/webrtc-registration.yaml) + _The above section is automatically synchronized by CAMARA project-administration._ From ca31d7b1a3ca8f9f9c4a58b36188974d15a16064 Mon Sep 17 00:00:00 2001 From: "camara-release-automation[bot]" <261643975+camara-release-automation[bot]@users.noreply.github.com> Date: Mon, 13 Jul 2026 06:24:18 +0000 Subject: [PATCH 2/7] Add CHANGELOG draft for r3.1 --- CHANGELOG/CHANGELOG-r3.md | 178 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 178 insertions(+) create mode 100644 CHANGELOG/CHANGELOG-r3.md diff --git a/CHANGELOG/CHANGELOG-r3.md b/CHANGELOG/CHANGELOG-r3.md new file mode 100644 index 0000000..61c5ac1 --- /dev/null +++ b/CHANGELOG/CHANGELOG-r3.md @@ -0,0 +1,178 @@ +# Changelog WebRTC + + +## Table of Contents +- [r3.1](#r31) + + +**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 + +# r3.1 + +## Release Notes + +This release candidate contains the definition and documentation of +* webrtc-call-handling 0.4.0-rc.1 +* webrtc-events-subscriptions 0.3.0-rc.1 +* webrtc-registration 0.4.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 +* fix: removing reason and sequenceNumber fields from MediaSessionInformation by @teikuran in https://github.com/camaraproject/WebRTC/pull/119 +* Remove unused properties by @teikuran in https://github.com/camaraproject/WebRTC/pull/124 +* Decoupling WebRTC-Events subscriptions from specific media session or registration by @rhtszk in https://github.com/camaraproject/WebRTC/pull/126 +* [bulk] Sync Release Information section (2025-12-12-001) by @hdamker-bot in https://github.com/camaraproject/WebRTC/pull/130 +* Add Emergency Calling support (callType + PIDF-LO location) by @deepakjaiswal1 in https://github.com/camaraproject/WebRTC/pull/120 +* Adding UML diagrams in API provider perspective by @teikuran in https://github.com/camaraproject/WebRTC/pull/122 +* Additional user story documents by @rhtszk in https://github.com/camaraproject/WebRTC/pull/125 +* Update CODEOWNERS stroncoso by @stroncoso in https://github.com/camaraproject/WebRTC/pull/133 +* task: Review MAINTAINERS.MD - Fixes #141 by @stroncoso in https://github.com/camaraproject/WebRTC/pull/143 +* Adding UML diagrams in API provider perspective Part2 by @teikuran in https://github.com/camaraproject/WebRTC/pull/139 +* [bulk] Add release-plan.yaml (2026-02-23-001) by @hdamker-bot in https://github.com/camaraproject/WebRTC/pull/140 +* Reset API and test version information to wip (merge before other PRs) by @hdamker in https://github.com/camaraproject/WebRTC/pull/153 +* [bulk] Enable release automation and validation (2026-04-13-001) by @camara-release-automation[bot] in https://github.com/camaraproject/WebRTC/pull/154 +* [bulk] Update release-automation + validation callers by @camara-release-automation[bot] in https://github.com/camaraproject/WebRTC/pull/157 +* Add PUT /subscriptions/{subscriptionId} to update sink credentials and duration by @deepakjaiswal1 in https://github.com/camaraproject/WebRTC/pull/152 +* Fix issue #76: update WebRTC subscription examples and developer guidance by @deepakjaiswal1 in https://github.com/camaraproject/WebRTC/pull/151 +* Adding UML diagrams in API provider perspective Part3 by @teikuran in https://github.com/camaraproject/WebRTC/pull/150 +* fix: some further clarification and potential improvements to the WebRTC Events by @teikuran in https://github.com/camaraproject/WebRTC/pull/156 +* fix: set target_api_status to rc to match pre-release-rc release type by @hdamker in https://github.com/camaraproject/WebRTC/pull/161 +* [bulk] Update release-automation + validation callers by @camara-release-automation[bot] in https://github.com/camaraproject/WebRTC/pull/163 +* fix: Clarification on registration expiration by @teikuran in https://github.com/camaraproject/WebRTC/pull/166 +* Provide location for call creation process by @stroncoso in https://github.com/camaraproject/WebRTC/pull/142 +* fix(test-definitions): align feature file names and tags with operationIds by @stroncoso in https://github.com/camaraproject/WebRTC/pull/168 +* Comonalities/ICM update to 4.2 by @stroncoso in https://github.com/camaraproject/WebRTC/pull/171 +* feat: add GET /sessions and correct POST 201 response by @deepakjaiswal1 in https://github.com/camaraproject/WebRTC/pull/169 +* fix: Clarification on registrationExpireTime by @teikuran in https://github.com/camaraproject/WebRTC/pull/165 +* Commonalities v4.2 alignment by @stroncoso in https://github.com/camaraproject/WebRTC/pull/174 +* Sync common files from Commonalities r4.2 by @camara-release-automation[bot] in https://github.com/camaraproject/WebRTC/pull/172 +* enhance: Possibly breaking down MediaSessionInformation into distinct schema by @teikuran in https://github.com/camaraproject/WebRTC/pull/164 +* task: remove deprecated workflows by @stroncoso in https://github.com/camaraproject/WebRTC/pull/175 +* Enhance WebRTC registration API documentation by @teikuran in https://github.com/camaraproject/WebRTC/pull/180 +* enhance: Address schema in webrtc-call-handling by @teikuran in https://github.com/camaraproject/WebRTC/pull/178 +* task: temporary remove of webrtc-events from release to renaming by @stroncoso in https://github.com/camaraproject/WebRTC/pull/186 +* Fix 4.2 commonalities errors by @stroncoso in https://github.com/camaraproject/WebRTC/pull/183 +* feat: define token-type-dependent phoneNumber handling for registration POST /sessions (#158) by @deepakjaiswal1 in https://github.com/camaraproject/WebRTC/pull/187 +* task: Rename events API and bump commonalities release by @stroncoso in https://github.com/camaraproject/WebRTC/pull/185 +* Sync common files from Commonalities r4.3 by @camara-release-automation[bot] in https://github.com/camaraproject/WebRTC/pull/193 + +## New Contributors +* @rhtszk made their first contribution in https://github.com/camaraproject/WebRTC/pull/126 +* @stroncoso made their first contribution in https://github.com/camaraproject/WebRTC/pull/133 +* @camara-release-automation[bot] made their first contribution in https://github.com/camaraproject/WebRTC/pull/154 + +
+ + +## webrtc-call-handling 0.4.0-rc.1 + +**webrtc-call-handling 0.4.0-rc.1 is a release-candidate version of this API.** + +Changes documented below are compared to version 0.3.0. + +- API definition **with inline documentation**: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r3.1/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.1/code/API_definitions/webrtc-call-handling.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/WebRTC/blob/r3.1/code/API_definitions/webrtc-call-handling.yaml) + +### Breaking changes + +* N/A + +### Added + +* N/A + +### Changed + +* N/A + +### Fixed + +* N/A + +### Removed + +* N/A + +## webrtc-events-subscriptions 0.3.0-rc.1 + +**webrtc-events-subscriptions 0.3.0-rc.1 is a release-candidate version of this API.** + +- API definition **with inline documentation**: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r3.1/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.1/code/API_definitions/webrtc-events-subscriptions.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/WebRTC/blob/r3.1/code/API_definitions/webrtc-events-subscriptions.yaml) + +### Breaking changes + +* N/A + +### Added + +* N/A + +### Changed + +* N/A + +### Fixed + +* N/A + +### Removed + +* N/A + +## webrtc-registration 0.4.0-rc.1 + +**webrtc-registration 0.4.0-rc.1 is a release-candidate version of this API.** + +Changes documented below are compared to version 0.3.0. + +- API definition **with inline documentation**: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r3.1/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.1/code/API_definitions/webrtc-registration.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/WebRTC/blob/r3.1/code/API_definitions/webrtc-registration.yaml) + +### Breaking changes + +* N/A + +### Added + +* N/A + +### Changed + +* N/A + +### Fixed + +* N/A + +### Removed + +* N/A + +**Full Changelog**: https://github.com/camaraproject/WebRTC/compare/r2.2...r3.1 + From bc3e49f6f27950f915071831b73362d66d02218c Mon Sep 17 00:00:00 2001 From: Santiago Troncoso Date: Mon, 13 Jul 2026 17:50:41 +0200 Subject: [PATCH 3/7] task(changelog): Updated changelog for r3.1 --- CHANGELOG/CHANGELOG-r3.md | 49 ++++++++++++++++++++++++++++----------- 1 file changed, 35 insertions(+), 14 deletions(-) diff --git a/CHANGELOG/CHANGELOG-r3.md b/CHANGELOG/CHANGELOG-r3.md index 61c5ac1..816e760 100644 --- a/CHANGELOG/CHANGELOG-r3.md +++ b/CHANGELOG/CHANGELOG-r3.md @@ -96,23 +96,28 @@ Changes documented below are compared to version 0.3.0. ### Breaking changes -* N/A +* enhance: possibly breaking down MediaSessionInformation into distinct schema at PR [#164](https://github.com/camaraproject/WebRTC/pull/164) ### Added -* N/A +* feat: add Emergency Calling support (callType + PIDF-LO location) at PR [#120](https://github.com/camaraproject/WebRTC/pull/120) +* feat: use optional originatorLocationDetails as part of the call request at PR [#142](https://github.com/camaraproject/WebRTC/pull/142) +* feat: add anonymous call origination (sip:anonymous@anonymous.invalid) and home local number support to the Address schema at PR [#178](https://github.com/camaraproject/WebRTC/pull/178) ### Changed -* N/A +* enhance: possibly breaking down MediaSessionInformation into distinct schema at PR [#164](https://github.com/camaraproject/WebRTC/pull/164) +* task: sync common files (error responses, headers, security schemes) to Commonalities r4.2 at PR [#172](https://github.com/camaraproject/WebRTC/pull/172) +* task: sync common files (error responses, headers, security schemes) to Commonalities r4.3 at PR [#193](https://github.com/camaraproject/WebRTC/pull/193) ### Fixed -* N/A +* fix: Commonalities v4.2 alignment at PR [#174](https://github.com/camaraproject/WebRTC/pull/174) ### Removed -* N/A +* fix: remove reason and sequenceNumber fields from MediaSessionInformation at PR [#119](https://github.com/camaraproject/WebRTC/pull/119) +* fix: remove clientCorrelator, serverCorrelator, callObjectRef, and offerRequired at PR [#124](https://github.com/camaraproject/WebRTC/pull/124) ## webrtc-events-subscriptions 0.3.0-rc.1 @@ -125,23 +130,33 @@ Changes documented below are compared to version 0.3.0. ### Breaking changes -* N/A +* fix: decouple WebRTC-Events subscriptions from specific media session or registration at PR [#126](https://github.com/camaraproject/WebRTC/pull/126) +* fix: CloudEvent structure review and rename API to webrtc-events-subscriptions at PR [#183](https://github.com/camaraproject/WebRTC/pull/183) +* task: rename events API and bump commonalities release at PR [#185](https://github.com/camaraproject/WebRTC/pull/185) ### Added -* N/A +* feat: add PUT /subscriptions/{subscriptionId} to update sink credentials and duration at PR [#152](https://github.com/camaraproject/WebRTC/pull/152) +* feat: require differentiating originator and receiver location in event payloads at PR [#142](https://github.com/camaraproject/WebRTC/pull/142) +* fix: support multiple event types per subscription at PR [#156](https://github.com/camaraproject/WebRTC/pull/156) ### Changed -* N/A +* fix: decouple WebRTC-Events subscriptions from specific media session or registration at PR [#126](https://github.com/camaraproject/WebRTC/pull/126) +* fix: CloudEvent structure review and rename API to webrtc-events-subscriptions at PR [#183](https://github.com/camaraproject/WebRTC/pull/183) +* task: rename events API and bump commonalities release at PR [#185](https://github.com/camaraproject/WebRTC/pull/185) +* fix: update WebRTC subscription examples and developer guidance at PR [#151](https://github.com/camaraproject/WebRTC/pull/151) +* fix: Commonalities v4.2 alignment at PR [#174](https://github.com/camaraproject/WebRTC/pull/174) +* task: sync common files (error responses, headers, security schemes, CloudEvent template) to Commonalities r4.2 at PR [#172](https://github.com/camaraproject/WebRTC/pull/172) +* task: sync common files (error responses, headers, security schemes, CloudEvent template) to Commonalities r4.3 at PR [#193](https://github.com/camaraproject/WebRTC/pull/193) ### Fixed -* N/A +* fix: correct example field name accessTokenExpireUtc to accessTokenExpiresUtc at PR [#151](https://github.com/camaraproject/WebRTC/pull/151) ### Removed -* N/A +* fix: remove clientCorrelator, serverCorrelator, callObjectRef, and offerRequired at PR [#124](https://github.com/camaraproject/WebRTC/pull/124) ## webrtc-registration 0.4.0-rc.1 @@ -156,19 +171,25 @@ Changes documented below are compared to version 0.3.0. ### Breaking changes -* N/A +* feat: add optional phoneNumber to POST /sessions with strict token-type handling at PR [#187](https://github.com/camaraproject/WebRTC/pull/187) ### Added -* N/A +* feat: add GET /sessions and GET /sessions/{registrationId} at PR [#169](https://github.com/camaraproject/WebRTC/pull/169) +* feat: add optional phoneNumber to POST /sessions with strict token-type handling at PR [#187](https://github.com/camaraproject/WebRTC/pull/187) ### Changed -* N/A +* fix: clarification on the POST /sessions operation at PR [#180](https://github.com/camaraproject/WebRTC/pull/180) +* fix: clarification on registration expiration at PR [#166](https://github.com/camaraproject/WebRTC/pull/166) +* fix: clarification on registrationExpireTime at PR [#165](https://github.com/camaraproject/WebRTC/pull/165) +* task: sync common files (error responses, headers, security schemes) to Commonalities r4.2 at PR [#172](https://github.com/camaraproject/WebRTC/pull/172) +* task: sync common files (error responses, headers, security schemes) to Commonalities r4.3 at PR [#193](https://github.com/camaraproject/WebRTC/pull/193) ### Fixed -* N/A +* fix: correct POST /sessions response code from 200 to 201 and deviceId field format at PR [#169](https://github.com/camaraproject/WebRTC/pull/169) +* fix: Commonalities v4.2 alignment at PR [#174](https://github.com/camaraproject/WebRTC/pull/174) ### Removed From 9bee21125eb4508a025e197364b930812012e4fc Mon Sep 17 00:00:00 2001 From: Santiago Troncoso Date: Tue, 14 Jul 2026 09:00:49 +0200 Subject: [PATCH 4/7] fix: P-032 - remove API readiness checklist --- ...c-call-handling-API-Readiness-Checklist.md | 19 ------------------- ...s-subscriptions-API-Readiness-Checklist.md | 19 ------------------- ...tc-registration-API-Readiness-Checklist.md | 19 ------------------- 3 files changed, 57 deletions(-) delete mode 100644 documentation/API_documentation/webrtc-call-handling-API-Readiness-Checklist.md delete mode 100644 documentation/API_documentation/webrtc-events-subscriptions-API-Readiness-Checklist.md delete mode 100644 documentation/API_documentation/webrtc-registration-API-Readiness-Checklist.md diff --git a/documentation/API_documentation/webrtc-call-handling-API-Readiness-Checklist.md b/documentation/API_documentation/webrtc-call-handling-API-Readiness-Checklist.md deleted file mode 100644 index bf51ad9..0000000 --- a/documentation/API_documentation/webrtc-call-handling-API-Readiness-Checklist.md +++ /dev/null @@ -1,19 +0,0 @@ -# API WebRTC Call Handling - -Checklist for webrtc-call-handling v0.3.0 in r2.2 - -| Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information | -|----|----------------------------------------------|:-----:|:-----:|:-----:|:-----:|:-----:|:-----:| -| 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/webrtc-call-handling.yaml) | -| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | r3.3 | -| 3 | Guidelines from ICM applied | O | M | M | M | Y | r3.3 | -| 4 | API versioning convention applied | M | M | M | M | Y | | -| 5 | API documentation | M | M | M | M | Y | inline in YAML | -| 6 | User stories | O | O | O | M | N | | -| 7 | Basic API test cases & documentation | O | M | M | M | Y | [link](/code/Test_definitions/) | -| 8 | Enhanced API test cases & documentation | O | O | O | M | N | | -| 9 | Test result statement | O | O | O | M | N | | -| 10 | API release numbering convention applied | M | M | M | M | Y | | -| 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) | -| 12 | Previous public release was certified | O | O | O | M | N | | -| 13 | API description (for marketing) | O | O | M | M | Y | [wiki link](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/81101647/WebRTC+API+description) | diff --git a/documentation/API_documentation/webrtc-events-subscriptions-API-Readiness-Checklist.md b/documentation/API_documentation/webrtc-events-subscriptions-API-Readiness-Checklist.md deleted file mode 100644 index da39ded..0000000 --- a/documentation/API_documentation/webrtc-events-subscriptions-API-Readiness-Checklist.md +++ /dev/null @@ -1,19 +0,0 @@ -# API WebRTC events - -Checklist for webrtc-events v0.2.0 in r2.2 - -| Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information | -|----|----------------------------------------------|:-----:|:-----:|:-----:|:-----:|:-----:|:-----:| -| 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/webrtc-events.yaml) | -| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | r3.3 | -| 3 | Guidelines from ICM applied | O | M | M | M | Y | r3.3 | -| 4 | API versioning convention applied | M | M | M | M | Y | | -| 5 | API documentation | M | M | M | M | Y | inline in YAML | -| 6 | User stories | O | O | O | M | N | | -| 7 | Basic API test cases & documentation | O | M | M | M | Y | [link](/code/Test_definitions/) | -| 8 | Enhanced API test cases & documentation | O | O | O | M | N | | -| 9 | Test result statement | O | O | O | M | N | | -| 10 | API release numbering convention applied | M | M | M | M | Y | | -| 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) | -| 12 | Previous public release was certified | O | O | O | M | N | | -| 13 | API description (for marketing) | O | O | M | M | Y | [wiki link](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/81101647/WebRTC+API+description) | diff --git a/documentation/API_documentation/webrtc-registration-API-Readiness-Checklist.md b/documentation/API_documentation/webrtc-registration-API-Readiness-Checklist.md deleted file mode 100644 index 380130e..0000000 --- a/documentation/API_documentation/webrtc-registration-API-Readiness-Checklist.md +++ /dev/null @@ -1,19 +0,0 @@ -# API WebRTC Registration - -Checklist for webrtc-registration v0.3.0 in r2.2 - -| Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information | -|----|----------------------------------------------|:-----:|:-----:|:-----:|:-----:|:-----:|:-----:| -| 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/webrtc-registration.yaml) | -| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | r3.3 | -| 3 | Guidelines from ICM applied | O | M | M | M | Y | r3.3 | -| 4 | API versioning convention applied | M | M | M | M | Y | | -| 5 | API documentation | M | M | M | M | Y | inline in YAML | -| 6 | User stories | O | O | O | M | N | | -| 7 | Basic API test cases & documentation | O | M | M | M | Y | [link](/code/Test_definitions/) | -| 8 | Enhanced API test cases & documentation | O | O | O | M | N | | -| 9 | Test result statement | O | O | O | M | N | | -| 10 | API release numbering convention applied | M | M | M | M | Y | | -| 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) | -| 12 | Previous public release was certified | O | O | O | M | N | | -| 13 | API description (for marketing) | O | O | M | M | Y | [wiki link](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/81101647/WebRTC+API+description) | From c0222b0687ceef1b4c52890ead5d28074788a137 Mon Sep 17 00:00:00 2001 From: Santiago Troncoso Date: Tue, 14 Jul 2026 09:01:15 +0200 Subject: [PATCH 5/7] fix: P-026 - Mandatarory info.description template missing --- .../API_definitions/webrtc-call-handling.yaml | 39 ++++++++----------- .../webrtc-events-subscriptions.yaml | 39 ++++++++----------- code/API_definitions/webrtc-registration.yaml | 38 ++++++++---------- 3 files changed, 50 insertions(+), 66 deletions(-) diff --git a/code/API_definitions/webrtc-call-handling.yaml b/code/API_definitions/webrtc-call-handling.yaml index 3815e0e..599a61a 100644 --- a/code/API_definitions/webrtc-call-handling.yaml +++ b/code/API_definitions/webrtc-call-handling.yaml @@ -167,18 +167,21 @@ info: } ``` + # Additional CAMARA error responses - The list of error codes in this API specification is not exhaustive. - Therefore the API specification may not document some non-mandatory error - statuses as indicated in `CAMARA API Design Guide`. - Please refer to the `CAMARA_common.yaml` of the Commonalities Release - associated to this API version for a complete list of error responses. The - applicable Commonalities Release can be identified in the `API Readiness - Checklist` document associated to this API version. + The list of error codes in this API specification is not exhaustive. Therefore the API specification MAY not document some non-mandatory error statuses as indicated in `CAMARA API Design Guide`. - As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible - error response if it is explicitly documented in the API. + Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified in the `API Readiness Checklist` document associated to this API version. + + As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API. + + + + # Request body strictness + + This API rejects requests with JSON request bodies that contain properties not declared in this specification, at any nesting level. Unknown properties result in a `400 INVALID_ARGUMENT` response. + # Located calls @@ -205,23 +208,15 @@ info: RFC 4119, RFC 5139, RFC 5491) with either a circle or ellipsoid shape. - If `callType` is omitted, it defaults to `REGULAR`. + # Authorization and authentication - The "Camara Security and Interoperability Profile" provides details of how an - API consumer requests an access token. Please refer to Identity and Consent - Management (https://github.com/camaraproject/IdentityAndConsentManagement/) - for the released version of the profile. + The "Camara Security and Interoperability Profile" provides details of how an API consumer requests an access token. Please refer to Identity and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the profile. - The specific authorization flows to be used will be agreed upon during the - onboarding process, happening between the API consumer and the API provider, - taking into account the declared purpose for accessing the API, whilst also - being subject to the prevailing legal framework dictated by local legislation. + The specific authorization flows to be used will be agreed upon during the onboarding process, happening between the API consumer and the API provider, taking into account the declared purpose for accessing the API, whilst also being subject to the prevailing legal framework dictated by local legislation. - In cases where personal data is processed by the API and users can exercise - their rights through mechanisms such as opt-in and/or opt-out, the use of - three-legged access tokens is mandatory. This ensures that the API remains - in compliance with privacy regulations, upholding the principles of - transparency and user-centric privacy-by-design. + In cases where personal data is processed by the API and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design. + license: name: Apache 2.0 diff --git a/code/API_definitions/webrtc-events-subscriptions.yaml b/code/API_definitions/webrtc-events-subscriptions.yaml index 733c49f..d47bb9e 100644 --- a/code/API_definitions/webrtc-events-subscriptions.yaml +++ b/code/API_definitions/webrtc-events-subscriptions.yaml @@ -168,36 +168,31 @@ info: A `org.camaraproject.webrtc-events-subscriptions.v0.registration-ends` event indicates that a previously active registration has ended and is no longer valid. From a developer's point of view, reception of the `registration-ends` event should be treated as a signal to renew the WebRTC registration in order to continue receiving or initiating calls for the registered phone number. + # Authorization and authentication - The "Camara Security and Interoperability Profile" provides details of how an - API consumer requests an access token. Please refer to Identity and Consent - Management (https://github.com/camaraproject/IdentityAndConsentManagement/) - for the released version of the profile. + The "Camara Security and Interoperability Profile" provides details of how an API consumer requests an access token. Please refer to Identity and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the profile. - The specific authorization flows to be used will be agreed upon during the - onboarding process, happening between the API consumer and the API provider, - taking into account the declared purpose for accessing the API, whilst also - being subject to the prevailing legal framework dictated by local legislation. + The specific authorization flows to be used will be agreed upon during the onboarding process, happening between the API consumer and the API provider, taking into account the declared purpose for accessing the API, whilst also being subject to the prevailing legal framework dictated by local legislation. - In cases where personal data is processed by the API and users can exercise - their rights through mechanisms such as opt-in and/or opt-out, the use of - three-legged access tokens is mandatory. This ensures that the API remains - in compliance with privacy regulations, upholding the principles of - transparency and user-centric privacy-by-design. + In cases where personal data is processed by the API and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design. + + # Additional CAMARA error responses - The list of error codes in this API specification is not exhaustive. - Therefore the API specification may not document some non-mandatory error - statuses as indicated in `CAMARA API Design Guide`. - Please refer to the `CAMARA_common.yaml` of the Commonalities Release - associated to this API version for a complete list of error responses. The - applicable Commonalities Release can be identified in the `API Readiness - Checklist` document associated to this API version. + The list of error codes in this API specification is not exhaustive. Therefore the API specification MAY not document some non-mandatory error statuses as indicated in `CAMARA API Design Guide`. - As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible - error response if it is explicitly documented in the API. + Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified in the `API Readiness Checklist` document associated to this API version. + + As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API. + + + + # Request body strictness + + This API rejects requests with JSON request bodies that contain properties not declared in this specification, at any nesting level. Unknown properties result in a `400 INVALID_ARGUMENT` response. + license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html diff --git a/code/API_definitions/webrtc-registration.yaml b/code/API_definitions/webrtc-registration.yaml index 1ae7b11..8c82b70 100644 --- a/code/API_definitions/webrtc-registration.yaml +++ b/code/API_definitions/webrtc-registration.yaml @@ -87,37 +87,31 @@ info: - Ongoing media sessions MAY be terminated when the registration expires. - Event subscriptions created via webrtc-events-subscriptions API are not affected. + # Authorization and authentication - The "Camara Security and Interoperability Profile" provides details of how an - API consumer requests an access token. Please refer to Identity and Consent - Management (https://github.com/camaraproject/IdentityAndConsentManagement/) - for the released version of the profile. + The "Camara Security and Interoperability Profile" provides details of how an API consumer requests an access token. Please refer to Identity and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the profile. - The specific authorization flows to be used will be agreed upon during the - onboarding process, happening between the API consumer and the API provider, - taking into account the declared purpose for accessing the API, whilst also - being subject to the prevailing legal framework dictated by local legislation. + The specific authorization flows to be used will be agreed upon during the onboarding process, happening between the API consumer and the API provider, taking into account the declared purpose for accessing the API, whilst also being subject to the prevailing legal framework dictated by local legislation. - In cases where personal data is processed by the API and users can exercise - their rights through mechanisms such as opt-in and/or opt-out, the use of - three-legged access tokens is mandatory. This ensures that the API remains - in compliance with privacy regulations, upholding the principles of - transparency and user-centric privacy-by-design. + In cases where personal data is processed by the API and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design. + + # Additional CAMARA error responses - The list of error codes in this API specification is not exhaustive. - Therefore the API specification may not document some non-mandatory error - statuses as indicated in `CAMARA API Design Guide`. + The list of error codes in this API specification is not exhaustive. Therefore the API specification MAY not document some non-mandatory error statuses as indicated in `CAMARA API Design Guide`. - Please refer to the `CAMARA_common.yaml` of the Commonalities Release - associated to this API version for a complete list of error responses. The - applicable Commonalities Release can be identified in the `API Readiness - Checklist` document associated to this API version. + Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified in the `API Readiness Checklist` document associated to this API version. - As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible - error response if it is explicitly documented in the API. + As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API. + + + + # Request body strictness + + This API rejects requests with JSON request bodies that contain properties not declared in this specification, at any nesting level. Unknown properties result in a `400 INVALID_ARGUMENT` response. + license: name: Apache 2.0 From 0b99a549a1d1d6f69b75e5be71a09a30331416e6 Mon Sep 17 00:00:00 2001 From: Santiago Troncoso Date: Tue, 14 Jul 2026 09:08:35 +0200 Subject: [PATCH 6/7] Revert "fix: P-026 - Mandatarory info.description template missing" This reverts commit c0222b0687ceef1b4c52890ead5d28074788a137. --- .../API_definitions/webrtc-call-handling.yaml | 39 +++++++++++-------- .../webrtc-events-subscriptions.yaml | 39 +++++++++++-------- code/API_definitions/webrtc-registration.yaml | 38 ++++++++++-------- 3 files changed, 66 insertions(+), 50 deletions(-) diff --git a/code/API_definitions/webrtc-call-handling.yaml b/code/API_definitions/webrtc-call-handling.yaml index 599a61a..3815e0e 100644 --- a/code/API_definitions/webrtc-call-handling.yaml +++ b/code/API_definitions/webrtc-call-handling.yaml @@ -167,21 +167,18 @@ info: } ``` - # Additional CAMARA error responses + The list of error codes in this API specification is not exhaustive. + Therefore the API specification may not document some non-mandatory error + statuses as indicated in `CAMARA API Design Guide`. - The list of error codes in this API specification is not exhaustive. Therefore the API specification MAY not document some non-mandatory error statuses as indicated in `CAMARA API Design Guide`. + Please refer to the `CAMARA_common.yaml` of the Commonalities Release + associated to this API version for a complete list of error responses. The + applicable Commonalities Release can be identified in the `API Readiness + Checklist` document associated to this API version. - Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified in the `API Readiness Checklist` document associated to this API version. - - As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API. - - - - # Request body strictness - - This API rejects requests with JSON request bodies that contain properties not declared in this specification, at any nesting level. Unknown properties result in a `400 INVALID_ARGUMENT` response. - + As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible + error response if it is explicitly documented in the API. # Located calls @@ -208,15 +205,23 @@ info: RFC 4119, RFC 5139, RFC 5491) with either a circle or ellipsoid shape. - If `callType` is omitted, it defaults to `REGULAR`. - # Authorization and authentication - The "Camara Security and Interoperability Profile" provides details of how an API consumer requests an access token. Please refer to Identity and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the profile. + The "Camara Security and Interoperability Profile" provides details of how an + API consumer requests an access token. Please refer to Identity and Consent + Management (https://github.com/camaraproject/IdentityAndConsentManagement/) + for the released version of the profile. - The specific authorization flows to be used will be agreed upon during the onboarding process, happening between the API consumer and the API provider, taking into account the declared purpose for accessing the API, whilst also being subject to the prevailing legal framework dictated by local legislation. + The specific authorization flows to be used will be agreed upon during the + onboarding process, happening between the API consumer and the API provider, + taking into account the declared purpose for accessing the API, whilst also + being subject to the prevailing legal framework dictated by local legislation. - In cases where personal data is processed by the API and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design. - + In cases where personal data is processed by the API and users can exercise + their rights through mechanisms such as opt-in and/or opt-out, the use of + three-legged access tokens is mandatory. This ensures that the API remains + in compliance with privacy regulations, upholding the principles of + transparency and user-centric privacy-by-design. license: name: Apache 2.0 diff --git a/code/API_definitions/webrtc-events-subscriptions.yaml b/code/API_definitions/webrtc-events-subscriptions.yaml index d47bb9e..733c49f 100644 --- a/code/API_definitions/webrtc-events-subscriptions.yaml +++ b/code/API_definitions/webrtc-events-subscriptions.yaml @@ -168,31 +168,36 @@ info: A `org.camaraproject.webrtc-events-subscriptions.v0.registration-ends` event indicates that a previously active registration has ended and is no longer valid. From a developer's point of view, reception of the `registration-ends` event should be treated as a signal to renew the WebRTC registration in order to continue receiving or initiating calls for the registered phone number. - # Authorization and authentication - The "Camara Security and Interoperability Profile" provides details of how an API consumer requests an access token. Please refer to Identity and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the profile. + The "Camara Security and Interoperability Profile" provides details of how an + API consumer requests an access token. Please refer to Identity and Consent + Management (https://github.com/camaraproject/IdentityAndConsentManagement/) + for the released version of the profile. - The specific authorization flows to be used will be agreed upon during the onboarding process, happening between the API consumer and the API provider, taking into account the declared purpose for accessing the API, whilst also being subject to the prevailing legal framework dictated by local legislation. + The specific authorization flows to be used will be agreed upon during the + onboarding process, happening between the API consumer and the API provider, + taking into account the declared purpose for accessing the API, whilst also + being subject to the prevailing legal framework dictated by local legislation. - In cases where personal data is processed by the API and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design. - + In cases where personal data is processed by the API and users can exercise + their rights through mechanisms such as opt-in and/or opt-out, the use of + three-legged access tokens is mandatory. This ensures that the API remains + in compliance with privacy regulations, upholding the principles of + transparency and user-centric privacy-by-design. - # Additional CAMARA error responses + The list of error codes in this API specification is not exhaustive. + Therefore the API specification may not document some non-mandatory error + statuses as indicated in `CAMARA API Design Guide`. - The list of error codes in this API specification is not exhaustive. Therefore the API specification MAY not document some non-mandatory error statuses as indicated in `CAMARA API Design Guide`. + Please refer to the `CAMARA_common.yaml` of the Commonalities Release + associated to this API version for a complete list of error responses. The + applicable Commonalities Release can be identified in the `API Readiness + Checklist` document associated to this API version. - Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified in the `API Readiness Checklist` document associated to this API version. - - As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API. - - - - # Request body strictness - - This API rejects requests with JSON request bodies that contain properties not declared in this specification, at any nesting level. Unknown properties result in a `400 INVALID_ARGUMENT` response. - + As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible + error response if it is explicitly documented in the API. license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html diff --git a/code/API_definitions/webrtc-registration.yaml b/code/API_definitions/webrtc-registration.yaml index 8c82b70..1ae7b11 100644 --- a/code/API_definitions/webrtc-registration.yaml +++ b/code/API_definitions/webrtc-registration.yaml @@ -87,31 +87,37 @@ info: - Ongoing media sessions MAY be terminated when the registration expires. - Event subscriptions created via webrtc-events-subscriptions API are not affected. - # Authorization and authentication - The "Camara Security and Interoperability Profile" provides details of how an API consumer requests an access token. Please refer to Identity and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the profile. + The "Camara Security and Interoperability Profile" provides details of how an + API consumer requests an access token. Please refer to Identity and Consent + Management (https://github.com/camaraproject/IdentityAndConsentManagement/) + for the released version of the profile. - The specific authorization flows to be used will be agreed upon during the onboarding process, happening between the API consumer and the API provider, taking into account the declared purpose for accessing the API, whilst also being subject to the prevailing legal framework dictated by local legislation. + The specific authorization flows to be used will be agreed upon during the + onboarding process, happening between the API consumer and the API provider, + taking into account the declared purpose for accessing the API, whilst also + being subject to the prevailing legal framework dictated by local legislation. - In cases where personal data is processed by the API and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design. - + In cases where personal data is processed by the API and users can exercise + their rights through mechanisms such as opt-in and/or opt-out, the use of + three-legged access tokens is mandatory. This ensures that the API remains + in compliance with privacy regulations, upholding the principles of + transparency and user-centric privacy-by-design. - # Additional CAMARA error responses - The list of error codes in this API specification is not exhaustive. Therefore the API specification MAY not document some non-mandatory error statuses as indicated in `CAMARA API Design Guide`. + The list of error codes in this API specification is not exhaustive. + Therefore the API specification may not document some non-mandatory error + statuses as indicated in `CAMARA API Design Guide`. - Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified in the `API Readiness Checklist` document associated to this API version. + Please refer to the `CAMARA_common.yaml` of the Commonalities Release + associated to this API version for a complete list of error responses. The + applicable Commonalities Release can be identified in the `API Readiness + Checklist` document associated to this API version. - As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API. - - - - # Request body strictness - - This API rejects requests with JSON request bodies that contain properties not declared in this specification, at any nesting level. Unknown properties result in a `400 INVALID_ARGUMENT` response. - + As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible + error response if it is explicitly documented in the API. license: name: Apache 2.0 From e85865c0ced5c6af8bad422e62d63cdbf44bd7a7 Mon Sep 17 00:00:00 2001 From: Santiago Troncoso Date: Tue, 14 Jul 2026 09:08:35 +0200 Subject: [PATCH 7/7] Revert "fix: P-032 - remove API readiness checklist" This reverts commit 9bee21125eb4508a025e197364b930812012e4fc. --- ...c-call-handling-API-Readiness-Checklist.md | 19 +++++++++++++++++++ ...s-subscriptions-API-Readiness-Checklist.md | 19 +++++++++++++++++++ ...tc-registration-API-Readiness-Checklist.md | 19 +++++++++++++++++++ 3 files changed, 57 insertions(+) create mode 100644 documentation/API_documentation/webrtc-call-handling-API-Readiness-Checklist.md create mode 100644 documentation/API_documentation/webrtc-events-subscriptions-API-Readiness-Checklist.md create mode 100644 documentation/API_documentation/webrtc-registration-API-Readiness-Checklist.md diff --git a/documentation/API_documentation/webrtc-call-handling-API-Readiness-Checklist.md b/documentation/API_documentation/webrtc-call-handling-API-Readiness-Checklist.md new file mode 100644 index 0000000..bf51ad9 --- /dev/null +++ b/documentation/API_documentation/webrtc-call-handling-API-Readiness-Checklist.md @@ -0,0 +1,19 @@ +# API WebRTC Call Handling + +Checklist for webrtc-call-handling v0.3.0 in r2.2 + +| Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information | +|----|----------------------------------------------|:-----:|:-----:|:-----:|:-----:|:-----:|:-----:| +| 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/webrtc-call-handling.yaml) | +| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | r3.3 | +| 3 | Guidelines from ICM applied | O | M | M | M | Y | r3.3 | +| 4 | API versioning convention applied | M | M | M | M | Y | | +| 5 | API documentation | M | M | M | M | Y | inline in YAML | +| 6 | User stories | O | O | O | M | N | | +| 7 | Basic API test cases & documentation | O | M | M | M | Y | [link](/code/Test_definitions/) | +| 8 | Enhanced API test cases & documentation | O | O | O | M | N | | +| 9 | Test result statement | O | O | O | M | N | | +| 10 | API release numbering convention applied | M | M | M | M | Y | | +| 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) | +| 12 | Previous public release was certified | O | O | O | M | N | | +| 13 | API description (for marketing) | O | O | M | M | Y | [wiki link](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/81101647/WebRTC+API+description) | diff --git a/documentation/API_documentation/webrtc-events-subscriptions-API-Readiness-Checklist.md b/documentation/API_documentation/webrtc-events-subscriptions-API-Readiness-Checklist.md new file mode 100644 index 0000000..da39ded --- /dev/null +++ b/documentation/API_documentation/webrtc-events-subscriptions-API-Readiness-Checklist.md @@ -0,0 +1,19 @@ +# API WebRTC events + +Checklist for webrtc-events v0.2.0 in r2.2 + +| Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information | +|----|----------------------------------------------|:-----:|:-----:|:-----:|:-----:|:-----:|:-----:| +| 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/webrtc-events.yaml) | +| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | r3.3 | +| 3 | Guidelines from ICM applied | O | M | M | M | Y | r3.3 | +| 4 | API versioning convention applied | M | M | M | M | Y | | +| 5 | API documentation | M | M | M | M | Y | inline in YAML | +| 6 | User stories | O | O | O | M | N | | +| 7 | Basic API test cases & documentation | O | M | M | M | Y | [link](/code/Test_definitions/) | +| 8 | Enhanced API test cases & documentation | O | O | O | M | N | | +| 9 | Test result statement | O | O | O | M | N | | +| 10 | API release numbering convention applied | M | M | M | M | Y | | +| 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) | +| 12 | Previous public release was certified | O | O | O | M | N | | +| 13 | API description (for marketing) | O | O | M | M | Y | [wiki link](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/81101647/WebRTC+API+description) | diff --git a/documentation/API_documentation/webrtc-registration-API-Readiness-Checklist.md b/documentation/API_documentation/webrtc-registration-API-Readiness-Checklist.md new file mode 100644 index 0000000..380130e --- /dev/null +++ b/documentation/API_documentation/webrtc-registration-API-Readiness-Checklist.md @@ -0,0 +1,19 @@ +# API WebRTC Registration + +Checklist for webrtc-registration v0.3.0 in r2.2 + +| Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information | +|----|----------------------------------------------|:-----:|:-----:|:-----:|:-----:|:-----:|:-----:| +| 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/webrtc-registration.yaml) | +| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | r3.3 | +| 3 | Guidelines from ICM applied | O | M | M | M | Y | r3.3 | +| 4 | API versioning convention applied | M | M | M | M | Y | | +| 5 | API documentation | M | M | M | M | Y | inline in YAML | +| 6 | User stories | O | O | O | M | N | | +| 7 | Basic API test cases & documentation | O | M | M | M | Y | [link](/code/Test_definitions/) | +| 8 | Enhanced API test cases & documentation | O | O | O | M | N | | +| 9 | Test result statement | O | O | O | M | N | | +| 10 | API release numbering convention applied | M | M | M | M | Y | | +| 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) | +| 12 | Previous public release was certified | O | O | O | M | N | | +| 13 | API description (for marketing) | O | O | M | M | Y | [wiki link](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/81101647/WebRTC+API+description) |