Skip to content
Closed
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
48 changes: 43 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

## Table of Contents

- **[r3.3](#r33)**
- **[r3.2](#r32)**
- **[r3.1](#r31)**
- **[r2.2](#r22)**
Expand All @@ -20,6 +21,42 @@ 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

# r3.3

## Release Notes

This release contains the definition and documentation of call-forwarding-signal v0.4.0

The API definition(s) are based on
* Commonalities v0.6.0
* Identity and Consent Management v0.4.0

## call-forwarding-signal v0.4.0

This is a release candidate for the CAMARA Meta Release Fall25 release of the Call Forwarding Signal API, version v0.4.0. It contains mainly alignments with the Commonalities v0.6.0.

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

In the following there is the list of the modifications with respect to the previous release.

### Added

### Changed
* x-correlator new format: https://github.com/camaraproject/CallForwardingSignal/pull/180, https://github.com/camaraproject/CallForwardingSignal/pull/186
* Undocumented Errors note in info.description: https://github.com/camaraproject/CallForwardingSignal/pull/180

### Fixed
* fixed some typo: https://github.com/camaraproject/CallForwardingSignal/pull/190
* Enum Value Mismatch Between API and Tests: https://github.com/camaraproject/CallForwardingSignal/pull/190

### Removed
* Removed error 401: https://github.com/camaraproject/CallForwardingSignal/pull/180

**Full Changelog**: https://github.com/camaraproject/CallForwardingSignal/compare/r2.2...r3.3

# r3.2

## Release Notes
Expand All @@ -45,15 +82,14 @@ In the following there is the list of the modifications with respect to the prev
### Added

### Changed
* x-correlator new format: https://github.com/camaraproject/CallForwardingSignal/pull/180, https://github.com/camaraproject/CallForwardingSignal/pull/186
* Undocumented Errors note in info.description: https://github.com/camaraproject/CallForwardingSignal/pull/180

### Fixed

* fixed some typo: https://github.com/camaraproject/CallForwardingSignal/pull/190
* Enum Value Mismatch Between API and Tests: https://github.com/camaraproject/CallForwardingSignal/pull/190

### Removed
* Removed error 401: https://github.com/camaraproject/CallForwardingSignal/pull/180

**Full Changelog**: https://github.com/camaraproject/CallForwardingSignal/compare/r2.2...r3.2
**Full Changelog**: https://github.com/camaraproject/CallForwardingSignal/compare/r3.1...r3.2

# r3.1

Expand Down Expand Up @@ -273,3 +309,5 @@ The version number for the YAML file is v0.2.0-rc.1

**Full Changelog**: https://github.com/camaraproject/CallForwardingSignal/commits/r1.1



10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,11 @@ Incubating API Repository to evolve and maintain the definitions and documentati

* 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**: Pre-release [r3.2](https://github.com/camaraproject/CallForwardingSignal/releases/tag/r3.2) with call-forwarding-signal v0.4.0-rc.1 is available.

* The latest public release is [r2.2](https://github.com/camaraproject/CallForwardingSignal/releases/tag/r2.2) with call-forwarding-signal v0.3.0.
* The latest public release is [r3.3](https://github.com/camaraproject/CallForwardingSignal/releases/tag/r3.3) with call-forwarding-signal v0.4.0.
- API definition **with inline documentation**:
- OpenAPI [YAML spec file](https://github.com/camaraproject/CallForwardingSignal/blob/r2.2/code/API_definitions/call-forwarding-signal.yaml)
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/r2.2/code/API_definitions/call-forwarding-signal.yaml&nocors)
- [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/r2.2/code/API_definitions/call-forwarding-signal.yaml)
- OpenAPI [YAML spec file](https://github.com/camaraproject/CallForwardingSignal/blob/r3.3/code/API_definitions/call-forwarding-signal.yaml)
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/r3.3/code/API_definitions/call-forwarding-signal.yaml&nocors)
- [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/r3.3/code/API_definitions/call-forwarding-signal.yaml)
## Contributing
* Meetings are held virtually
* Schedule: Monday 15h-16 CET, usually every two weeks. For the next meetings information, have a look on the [API Wiki Page](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14549020/CallForwardingSignal).
Expand Down
4 changes: 2 additions & 2 deletions code/API_definitions/call-forwarding-signal.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ info:
# FAQ's
(FAQs will be added in a later version of the documentation)

version: wip
version: 0.4.0
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
Expand All @@ -163,7 +163,7 @@ externalDocs:
# Servers #
############################################################################
servers:
- url: "{apiRoot}/call-forwarding-signal/vwip"
- url: "{apiRoot}/call-forwarding-signal/v0.4"
variables:
apiRoot:
default: http://localhost:9091
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Feature: CAMARA Call Forwarding Signal API, vwip - Operation retrieveCallForwarding
Feature: CAMARA Call Forwarding Signal API, v0.4.0 - Operation retrieveCallForwarding
# Input to be provided by the implementation to the tester
#
# Implementation indications:
Expand All @@ -8,7 +8,7 @@ Feature: CAMARA Call Forwarding Signal API, vwip - Operation retrieveCallForwar
# * A device object identified by a phone number for which the call forwarding service status could not be retrieved
#
Background: Common call-forwarding-signal setup
Given the path "/call-forwarding-signal/vwip/call-forwardings"
Given the path "/call-forwarding-signal/v0.4/call-forwardings"
And the header "Content-Type" is set to "application/json"
And the header "Authorization" is set to a valid access token
And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Feature: CAMARA Call Forwarding Signal API, vwip - Operation retrieveUnconditionalCallForwarding
Feature: CAMARA Call Forwarding Signal API, v0.4.0 - Operation retrieveUnconditionalCallForwarding
# Input to be provided by the implementation to the tester
#
# Implementation indications:
Expand All @@ -8,7 +8,7 @@ Feature: CAMARA Call Forwarding Signal API, vwip - Operation retrieveUnconditio
# * A device object identified by a phone number for which unconditional call forwarding service (CFS) status could not be retrieved
#
Background: Common call-forwarding-signal setup
Given the path "/call-forwarding-signal/vwip/unconditional-call-forwardings"
Given the path "/call-forwarding-signal/v0.4/unconditional-call-forwardings"
And the header "Content-Type" is set to "application/json"
And the header "Authorization" is set to a valid access token
And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,22 +1,24 @@

# API Readiness Checklist

Checklist for API call-forwarding-signal v0.4.0-rc.1 in r3.2
Checklist for API call-forwarding-signal v0.4.0 in r3.3


| Nr | API release assets | alpha | release-candidate | initial<br>public | stable<br> public | Status | Reference information |
|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----|
| 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/call-forwarding-signal.yaml) |
| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r3.2](https://github.com/camaraproject/Commonalities/releases/tag/r3.2) |
| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.2](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.2) |
| 4 | API versioning convention applied | M | M | M | M | Y | v0.4.0-rc.1 |
| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.3) |
| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.3) |
| 4 | API versioning convention applied | M | M | M | M | Y | v0.4.0 |
| 5 | API documentation | M | M | M | M | Y | inline in YAML |
| 6 | User stories | O | O | O | M | Y | [link](/documentation/API_documentation/CFS_UserStory_UseCase-1.md) |
| 7 | Basic API test cases & documentation | O | M | M | M | Y | [call-forwarding-signal-every-forwarding](/code/Test_definitions/call-forwarding-signal-every-forwarding.feature), [call-forwarding-signal-unconditional](/code/Test_definitions/call-forwarding-signal-unconditional.feature) |
| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [call-forwarding-signal-every-forwarding](/code/Test_definitions/call-forwarding-signal-every-forwarding.feature), [call-forwarding-signal-unconditional](/code/Test_definitions/call-forwarding-signal-unconditional.feature) |
| 9 | Test result statement | O | O | O | M | N | |
| 10 | API release numbering convention applied | M | M | M | M | Y | r3.2 |
| 10 | API release numbering convention applied | M | M | M | M | Y | r3.3 |
| 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/x/uoDVB) |