generated from camaraproject/Template_API_Repository
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #101 from camaraproject/bigludo7/r1.3
Public Release for Fall24 meta-release
- Loading branch information
Showing
6 changed files
with
53 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,23 +15,21 @@ Repository to describe, develop, document and test the Call Forwarding Signal AP | |
| * The Application Server invokes the Call Forwarding Signal API to determine if a specific phone number has an active "call forwarding" setup. "Call forwarding" is a network service that redirects incoming calls to another phone number (configured in the service). The Call Forwarding Signal API can be used by a bank to verify if a “call forwarding” option is active on the customer’s phone number to avoid frauds. A call from the bank to the customers can indeed be forwarded to a different number because of a fraud attempt. | ||
| * The API is useful to avoid frauds. Banks offer the option for users to receive telephone calls to solve problems, e.g. in case of issues with the bank App, issues with Smartphones, the bank website or any tool providing access to the online bank account management system.<br>How does the fraudster operate?<br>• Through social engineering, the fraudster gathers information about bank customers who are engaged in such a situation, needing the bank to contact them.<br>• Once they identify the service provider and phone number of a customer, they manage to successfully activate, on the customer profile, the 'call forwarding' to a phone number they control.<br>• After successfully setting up 'call forwarding,' the fraudster then contacts the bank, claiming an inability to access online banking services and requesting a call from a bank representative. <br>• When the bank calls the registered contact number of the user, the active 'call forwarding' diverts the call directly to the fraudster, thus completing their scheme.<br> The Call Forwarding Signal API can be used by the bank to verify if a "call forwarding" option is active on the customer's phone, avoiding such a fraud. | ||
| * Describe, develop, document and test the APIs (with 1-2 Telcos) | ||
| * Started: February 2024 | ||
| * Location: virtually | ||
| * Started: February 2024 | ||
|
|
||
| ## Meetings | ||
| * Meetings are held virtually | ||
| * Schedule: Tuesday 15h-16 CET, usually every two weeks. For the next meeting date, have a look on the API Wiki Page: https://wiki.camaraproject.org/display/CAM/CallForwardingSignal | ||
| * Meeting link: https://teams.microsoft.com/l/meetup-join/19%3ameeting_ZTc1YzI4YjEtMmNlZC00NGJmLWE3MmMtNjJhYzdhZTU3YmFj%40thread.v2/0?context=%7b%22Tid%22%3a%226815f468-021c-48f2-a6b2-d65c8e979dfb%22%2c%22Oid%22%3a%22bfbe4cda-8a8b-4cda-89e2-7326520e45b3%22%7d | ||
| * Schedule: Tuesday 15h-16 CET, usually every two weeks. For the next meetings information, have a look on the API Wiki Page: https://wiki.camaraproject.org/display/CAM/CallForwardingSignal | ||
|
|
||
| ## Status and released versions | ||
|
|
||
| * 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**. | ||
| * **The latest available version of CAMARA CallForwardingSignal API is v0.2.0-rc.2. This is a release-candidate API version.** There are bug fixes to be expected and incompatible changes in upcoming releases. It is suitable for implementors, but it is not recommended to use the API with customers in productive environments. | ||
| * The Release Tag is [r1.2](https://github.com/camaraproject/CallForwardingSignal/releases/tag/r1.2). | ||
| * **The latest available version of CAMARA CallForwardingSignal API is v0.2.0.** | ||
| * The Release Tag is [r1.3](https://github.com/camaraproject/CallForwardingSignal/releases/tag/r1.3). | ||
| - API definition **with inline documentation**: | ||
| - OpenAPI [YAML spec file](https://github.com/camaraproject/CallForwardingSignal/blob/r1.2/code/API_definitions/Call_Forwarding_Signal.yaml) | ||
| - [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) | ||
| - [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) | ||
| - OpenAPI [YAML spec file](https://github.com/camaraproject/CallForwardingSignal/blob/r1.3/code/API_definitions/call-forwarding-signal.yaml) | ||
| - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/r1.3/code/API_definitions/call-forwarding-signal.yaml&nocors) | ||
| - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/r1.3/code/API_definitions/call-forwarding-signal.yaml) | ||
| ## Contributorship and mailing list | ||
| * To subscribe / unsubscribe to the mailing list of this Sub Project and thus be / resign as Contributor please visit <https://lists.camaraproject.org/g/sp-cfs>. | ||
| * A message to all Contributors of this Sub Project can be sent using <[email protected]>. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
code/Test_definitions/call-forwarding-signal-every-forwarding.feature
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
15 changes: 7 additions & 8 deletions
15
...mentation/API_documentation/call-forwarding-signal-API-Readiness-Checklistst.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,20 @@ | ||
|
|
||
| # API Readiness Checklist | ||
|
|
||
| Checklist for API call-forwarding-signal v0.2.0-rc.2 in r1.2 | ||
| Checklist for API call-forwarding-signal v0.2.0 in r1.3 | ||
|
|
||
|
|
||
| | Nr | API release assets | alpha | release-candidate | public-release<br>initial | public-release<br> stable | Status | Comments | | ||
| |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----| | ||
| | 1 | API definition | M | M | M | M | Y | /code/API_definitions/Call_Forwarding_Signal.yaml | | ||
| | 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 | | | ||
| | 3 | Guidelines from ICM applied | O | M | M | M | Y | | | ||
| | 4 | API versioning convention applied | M | M | M | M | Y | v0.2.0-rc.2 | | ||
| | 4 | API versioning convention applied | M | M | M | M | Y | v0.2.0 | | ||
| | 5 | API documentation | M | M | M | M | Y | inline in YAML | | ||
| | 6 | User stories | O | O | O | M | Y | /documentation/API_documentation/CFS_UserStory_UseCase-1.md | | ||
| | 7 | Basic API test cases & documentation | O | M | M | M | Y | /code/Test_definitions/call-forwarding-signal-every-forwarding.feature, /code/Test_definitions/call-forwarding-signal-unconditional.feature | | ||
| | 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 | N | | | ||
| | 9 | Test result statement | O | O | O | M | N | | | ||
| | 10 | API release numbering convention applied | M | M | M | M | Y | r1.2 | | ||
| | 11 | Change log updated | M | M | M | M | Y | /CHANGELOG.md | | ||
| | 10 | API release numbering convention applied | M | M | M | M | Y | r1.3 | | ||
| | 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) | | ||
| | 12 | Previous public-release was certified | O | O | O | M | N | | | ||
|
|