Skip to content

Commit 7fe0355

Browse files
Merge pull request #91 from camaraproject/72-create-release-r12
Prepare release r1.2
2 parents c85ffa2 + 73180a0 commit 7fe0355

File tree

4 files changed

+67
-65
lines changed

4 files changed

+67
-65
lines changed

CHANGELOG.md

+49-36
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,55 @@
33

44
## Table of Contents
55

6-
- **[r1.1-rc](#r11-rc)**
76
- **[r1.2-rc](#r12-rc)**
7+
- **[r1.1-rc](#r11-rc)**
8+
9+
**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.**
10+
11+
The below sections record the changes for each API version in each release as follows:
12+
13+
* for each first alpha or release-candidate API version, all changes since the release of the previous public API version
14+
* for subsequent alpha or release-candidate API versions, the delta with respect to the previous pre-release
15+
* for a public API version, the consolidated changes since the release of the previous public API version
16+
17+
# r1.2-rc
18+
19+
## Release Notes
20+
21+
This release contains the definition and documentation of
22+
* call-forwarding-signal v0.2.0-rc.2
23+
24+
The API definition(s) are based on
25+
* Commonalities v0.4.0-rc.1
26+
* Identity and Consent Management v0.2.0-rc.2
27+
28+
## call-forwarding-signal v0.2.0-rc.2
29+
30+
This is the second release candidate of the version 0.2.0. It contains mainly alignments with the Commonalities 0.4.0 and the Release Management Guidelines.
31+
32+
The pre-release is suitable for implementers, but it is not recommended to use the API with customers in productive environments.
33+
34+
- API definition **with inline documentation**:
35+
- OpenAPI [YAML spec file](https://github.com/camaraproject/CallForwardingSignal/blob/r1.2/code/API_definitions/Call_Forwarding_Signal.yaml)
36+
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/r1.2/code/API_definitions/Call_Forwarding_Signal.yaml&nocors)
37+
- [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/r1.2/code/API_definitions/Call_Forwarding_Signal.yaml)
38+
39+
### Added
40+
41+
### Changed
42+
43+
* Improvement of user stories by @FabrizioMoggio in https://github.com/camaraproject/CallForwardingSignal/pull/86
44+
* Aligned info.description Authorization and Authentication section with ICM 0.2.0 by @FabrizioMoggio in https://github.com/camaraproject/CallForwardingSignal/pull/91
45+
46+
### Fixed
47+
48+
* Removed the version number in the ".feature" files in the "Background" section by @FabrizioMoggiom in https://github.com/camaraproject/CallForwardingSignal/pull/83
49+
* Alignments within object description and fields by @FabrizioMoggio in https://github.com/camaraproject/CallForwardingSignal/pull/68
50+
51+
### Removed
52+
53+
54+
**Full Changelog**: https://github.com/camaraproject/CallForwardingSignal/compare/r1.1...r1.2
855

956
# r1.1-rc
1057

@@ -19,7 +66,7 @@ The version number for the YAML file is v0.2.0-rc.1
1966

2067
## Please note:
2168

22-
- This pre-release concernes a release-candidate API version, there are bug fixes to be expected and incompatible changes in upcoming versions
69+
- This pre-release contains a release-candidate API version, there are bug fixes to be expected and incompatible changes in upcoming versions
2370
- The release is suitable for implementers, but it is not recommended to use the API with customers in productive environments
2471
- Version numbers before v0.2.0-rc.1 were used during the development of this version but not released
2572
- The release scope is defined here: https://github.com/camaraproject/CallForwardingSignal/issues/49
@@ -40,39 +87,5 @@ The version number for the YAML file is v0.2.0-rc.1
4087

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

43-
# r1.2-rc
44-
45-
**This is the second pre-release of the CAMARA CallForwardingSignal API**
46-
47-
The version number for the YAML file is v0.2.0-rc.2
48-
49-
- API definition **with inline documentation**:
50-
- OpenAPI [YAML spec file](https://github.com/camaraproject/CallForwardingSignal/blob/r1.2/code/API_definitions/Call_Forwarding_Signal.yaml)
51-
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/r1.2/code/API_definitions/Call_Forwarding_Signal.yaml&nocors)
52-
- [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/r1.2/code/API_definitions/Call_Forwarding_Signal.yaml)
53-
54-
## Please note:
55-
56-
- This pre-release concernes a release-candidate API version, there are bug fixes to be expected and incompatible changes in upcoming versions
57-
- The release is suitable for implementers, but it is not recommended to use the API with customers in productive environments
58-
- The release scope is defined here: https://github.com/camaraproject/CallForwardingSignal/issues/72
59-
60-
## Changes compared with [r1.1-rc](#r11-rc)
61-
62-
* The contact field (and value) have been be removed from the OAS file: https://github.com/camaraproject/CallForwardingSignal/issues/76
63-
* Update of the API Readiness Checklist: https://github.com/camaraproject/CallForwardingSignal/issues/80
64-
* Rename of the API Readiness Checklist: https://github.com/camaraproject/CallForwardingSignal/issues/79
65-
* Improvement of the user stories: https://github.com/camaraproject/CallForwardingSignal/issues/81
66-
* Removal of the version number in the ".feature" files in the "Background" section: https://github.com/camaraproject/CallForwardingSignal/issues/77
67-
* Commonalities version reported in the OAS file: https://github.com/camaraproject/CallForwardingSignal/issues/66
68-
69-
## New Contributors
70-
* @FabrizioMoggio
71-
* @bigludo7
72-
* @rartych
73-
* @StefanoFalsetto-CKHIOD
74-
* @enlaichu
75-
* @chinaunicomyangfan
7690

77-
**Full Changelog**: https://github.com/camaraproject/CallForwardingSignal/commits/r1.2
7891

code/API_definitions/Call_Forwarding_Signal.yaml

+17-27
Original file line numberDiff line numberDiff line change
@@ -72,31 +72,23 @@ info:
7272
- **call-forwardings**: Which is the status of the call forwarding for a
7373
specific phone number?
7474
# Authorization and authentication
75-
CAMARA guidelines defines a set of authorization flows which can grant API
76-
clients access to the API functionality, as outlined in the document
77-
[CAMARA-API-access-and-user-consent.md](https:\
78-
//github.com/camaraproject/IdentityAndConsentManagement/blob/main/\
79-
documentation/CAMARA-API-access-and-user-consent.md).
75+
The "Camara Security and Interoperability Profile" provides details on how
76+
a client requests an access token. Please refer to Identify and Consent
77+
Management (https://github.com/camaraproject/IdentityAndConsentManagement/)
78+
for the released version of the Profile.\
79+
\
8080
Which specific authorization flows are to be used will be determined during
81-
onboarding process, happening between the API Client and the
82-
Telco Operator exposing the API, taking into account the declared purpose
83-
for accessing the API, while also being subject to the prevailing legal
84-
framework dictated by local legislation.\
85-
Specifically, for the CFS API, the CIBA flow should be adopted. The CIBA
86-
flow is described here:[CIBA Flow](https://github.com/camaraproject/\
87-
IdentityAndConsentManagement/blob/main/documentation/\
88-
CAMARA-Security-Interoperability.md\
89-
#client-initiated-backchannel-authentication-flow). The "login_hint" must be
90-
the user's phone number valorised as the parameter PhoneNumber, if used. If
91-
a mismatch is detected, a 403 error is returned (`INVALID_TOKEN_CONTEXT`).
81+
onboarding process, happening between the API Client and the Telco Operator
82+
exposing the API, taking into account the declared purpose for accessing the
83+
API, while also being subject to the prevailing legal framework dictated by
84+
local legislation.\
9285
\
9386
It is important to remark that in cases where personal user data is
9487
processed by the API, and users can exercise their rights through mechanisms
9588
such as opt-in and/or opt-out, the use of 3-legged access tokens becomes
96-
mandatory.
97-
This measure ensures that the API remains in strict compliance with user
98-
privacy preferences and regulatory obligations,
99-
upholding the principles of transparency and user-centric data control.
89+
mandatory. This measure ensures that the API remains in strict compliance
90+
with user privacy preferences and regulatory obligations, upholding the
91+
principles of transparency and user-centric data control.
10092
# Identifying the phone number from the access token
10193
This specification defines the "phoneNumber" field as optional in API
10294
requests because using a 3-legged access token the phone number can be
@@ -139,26 +131,24 @@ info:
139131
to be checked.
140132
# FAQ's
141133
(FAQs will be added in a later version of the documentation)
142-
# API version - Aligned to SemVer 2.0 according to CAMARA versioning guidelines
143-
version: wip
144-
# Name of the license and a URL to the license description
134+
135+
version: 0.2.0-rc.2
145136
license:
146137
name: Apache 2.0
147138
url: https://www.apache.org/licenses/LICENSE-2.0.html
148-
# CAMARA Commonalities version - x.y.z
149-
x-camara-commonalities: 0.4.0
139+
x-camara-commonalities: 0.4.0-rc.2
150140
externalDocs:
151141
description: Product documentation at CAMARA
152142
url: https://github.com/camaraproject/CallForwardingSignal
153143
############################################################################
154144
# Servers #
155145
############################################################################
156146
servers:
157-
- url: "{apiRoot}/call-forwarding-signal/vwip"
147+
- url: "{apiRoot}/call-forwarding-signal/v0.2rc2"
158148
variables:
159149
apiRoot:
160150
default: http://localhost:9091
161-
description: API root for the Call Forwarding Signal API
151+
description: API root, defined by the service provider, e.g. `api.example.com` or `api.example.com/somepath`
162152
############################################################################
163153
# Tags #
164154
############################################################################

code/API_definitions/README.MD

-1
This file was deleted.

documentation/API_documentation/call-forwarding-signal-API-Readiness-Checklistst.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Checklist for API call-forwarding-signal v0.2.0-rc.2 in r1.2
55

66

77
| Nr | API release assets | alpha | release-candidate | public-release<br>initial | public-release<br> stable | Status | Comments |
8-
|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
8+
|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----|
99
| 1 | API definition | M | M | M | M | Y | /code/API_definitions/Call_Forwarding_Signal.yaml |
1010
| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | |
1111
| 3 | Guidelines from ICM applied | O | M | M | M | Y | |

0 commit comments

Comments
 (0)