From 5c5d0de030a6bd5f4907e466f217fe79f1d806cf Mon Sep 17 00:00:00 2001 From: Kenichi Yamamoto Date: Wed, 11 Dec 2024 09:46:53 +0900 Subject: [PATCH 01/12] Adding CHANGELOG.md --- CHANGELOG.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..9865e3b --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,25 @@ +# Number Recycling + +## Table of Contents + +- [v0.1.0](#v010) + +**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.** + +# v0.1.0 + +**This is the first alpha version of the KYC APIs.** + +- API [definition](https://github.com/camaraproject/NumberRecycling/tree/main/code/API_definitions) + +* Note: API documentation is embedded in the YAML files. + +## Please note: + +- This is an alpha version, it should be considered as a draft. + +## What's changed + +* New API `Number Recycling`, v0.1.0: + - The API can be used to check whether the subscriber of the phone number has changed. A common scenario is when Application service provider (ASP) wants to check whether there has been a change in the user associated with the phone number after the specified date. This allows the ASP to ensure that a phone number is correctly linked to an user and prevent the mis-delivery of SMS messages. + From 4e1668e483fd1123e00669b95353f8238dd94a14 Mon Sep 17 00:00:00 2001 From: Kenichi Yamamoto Date: Wed, 11 Dec 2024 10:01:23 +0900 Subject: [PATCH 02/12] Update version of YAML --- code/API_definitions/number-recycling.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/code/API_definitions/number-recycling.yaml b/code/API_definitions/number-recycling.yaml index b0bbd16..3e40267 100644 --- a/code/API_definitions/number-recycling.yaml +++ b/code/API_definitions/number-recycling.yaml @@ -64,7 +64,7 @@ info: - If the subject can be identified from the access token and the optional `phoneNumber` field is also included in the request, then the server will return an error with the `422 UNNECESSARY_IDENTIFIER` error code. This will be the case even if the same phone number is identified by these two methods, as the server is unable to make this comparison. - version: wip + version: 0.1.0 x-camara-commonalities: 0.4.0 license: name: Apache 2.0 @@ -73,7 +73,7 @@ externalDocs: description: Product documentation at Camara url: https://github.com/camaraproject/NumberRecycling servers: - - url: '{apiRoot}/number-recycling/vwip' + - url: '{apiRoot}/number-recycling/0.1.0-alpha.1' variables: apiRoot: default: http://localhost:9091 From c0c7ddcb7f06bdd4c7b0b218e96dbdc8a19d2af3 Mon Sep 17 00:00:00 2001 From: Kenichi Yamamoto Date: Tue, 17 Dec 2024 19:22:11 +0900 Subject: [PATCH 03/12] Update code/API_definitions/number-recycling.yaml Co-authored-by: Eric Murray --- code/API_definitions/number-recycling.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/API_definitions/number-recycling.yaml b/code/API_definitions/number-recycling.yaml index 3e40267..4c54a55 100644 --- a/code/API_definitions/number-recycling.yaml +++ b/code/API_definitions/number-recycling.yaml @@ -73,7 +73,7 @@ externalDocs: description: Product documentation at Camara url: https://github.com/camaraproject/NumberRecycling servers: - - url: '{apiRoot}/number-recycling/0.1.0-alpha.1' + - url: '{apiRoot}/number-recycling/0.1alpha1' variables: apiRoot: default: http://localhost:9091 From 0b5348909312cb884fc148a17f884d693ada0a64 Mon Sep 17 00:00:00 2001 From: Kenichi Yamamoto Date: Tue, 17 Dec 2024 19:27:54 +0900 Subject: [PATCH 04/12] Update CHANGELOG.md Co-authored-by: Eric Murray --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9865e3b..741b61c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,7 @@ ## Table of Contents -- [v0.1.0](#v010) +- [r1.1](#r11) **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.** From b03b41b2a7a33005fc203c9d6b27d8472b474e7e Mon Sep 17 00:00:00 2001 From: Kenichi Yamamoto Date: Tue, 17 Dec 2024 19:28:41 +0900 Subject: [PATCH 05/12] Update CHANGELOG.md Co-authored-by: Eric Murray --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 741b61c..51c243a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,7 +6,7 @@ **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.** -# v0.1.0 +# r1.1 **This is the first alpha version of the KYC APIs.** From 644624aa4174fc9235eec36e1b06a5523994af7e Mon Sep 17 00:00:00 2001 From: Kenichi Yamamoto Date: Tue, 17 Dec 2024 19:29:18 +0900 Subject: [PATCH 06/12] Update CHANGELOG.md Co-authored-by: Eric Murray --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 51c243a..843bd48 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,7 +10,7 @@ **This is the first alpha version of the KYC APIs.** -- API [definition](https://github.com/camaraproject/NumberRecycling/tree/main/code/API_definitions) +- [number-recycling v0.1.0-alpha.1](https://github.com/camaraproject/NumberRecycling/blob/r1.1/code/API_definitions/number-recycling.yaml) * Note: API documentation is embedded in the YAML files. From 439a3a26243041c602bdc2e821105215105ac92d Mon Sep 17 00:00:00 2001 From: Kenichi Yamamoto Date: Tue, 17 Dec 2024 19:31:13 +0900 Subject: [PATCH 07/12] Update CHANGELOG.md Co-authored-by: Eric Murray --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 843bd48..f2476dc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,6 +20,6 @@ ## What's changed -* New API `Number Recycling`, v0.1.0: +* New API `Number Recycling`, v0.1.0-alpha.1: - The API can be used to check whether the subscriber of the phone number has changed. A common scenario is when Application service provider (ASP) wants to check whether there has been a change in the user associated with the phone number after the specified date. This allows the ASP to ensure that a phone number is correctly linked to an user and prevent the mis-delivery of SMS messages. From 338712ac678b288a1fd35644afb7106af4b93220 Mon Sep 17 00:00:00 2001 From: Kenichi Yamamoto Date: Tue, 17 Dec 2024 19:32:34 +0900 Subject: [PATCH 08/12] Update code/API_definitions/number-recycling.yaml Co-authored-by: Eric Murray --- code/API_definitions/number-recycling.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/API_definitions/number-recycling.yaml b/code/API_definitions/number-recycling.yaml index 4c54a55..e3dec11 100644 --- a/code/API_definitions/number-recycling.yaml +++ b/code/API_definitions/number-recycling.yaml @@ -64,7 +64,7 @@ info: - If the subject can be identified from the access token and the optional `phoneNumber` field is also included in the request, then the server will return an error with the `422 UNNECESSARY_IDENTIFIER` error code. This will be the case even if the same phone number is identified by these two methods, as the server is unable to make this comparison. - version: 0.1.0 + version: 0.1.0-alpha.1 x-camara-commonalities: 0.4.0 license: name: Apache 2.0 From e4532e09b2da9876ec3468bba67ca030f4b26741 Mon Sep 17 00:00:00 2001 From: Eric Murray Date: Mon, 23 Dec 2024 17:34:25 +0000 Subject: [PATCH 09/12] Update code/API_definitions/number-recycling.yaml --- code/API_definitions/number-recycling.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/API_definitions/number-recycling.yaml b/code/API_definitions/number-recycling.yaml index e3dec11..6a69aed 100644 --- a/code/API_definitions/number-recycling.yaml +++ b/code/API_definitions/number-recycling.yaml @@ -73,7 +73,7 @@ externalDocs: description: Product documentation at Camara url: https://github.com/camaraproject/NumberRecycling servers: - - url: '{apiRoot}/number-recycling/0.1alpha1' + - url: '{apiRoot}/number-recycling/v0.1alpha1' variables: apiRoot: default: http://localhost:9091 From ec6f70c77fe164962dd827eae609eeda877ee80d Mon Sep 17 00:00:00 2001 From: Kenichi Yamamoto Date: Thu, 2 Jan 2025 23:24:25 +0900 Subject: [PATCH 10/12] Update links in the YAML --- code/API_definitions/number-recycling.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/code/API_definitions/number-recycling.yaml b/code/API_definitions/number-recycling.yaml index 8f7f40f..c76afba 100644 --- a/code/API_definitions/number-recycling.yaml +++ b/code/API_definitions/number-recycling.yaml @@ -19,7 +19,7 @@ info: * ASP A decides to send the SMS message to User A. * By following these steps, ASP A ensures that a phone number is linked to User A. - Number_Recycling_scenario_1 + Number_Recycling_scenario_1 Note: * When API receives a request with specified date on which a user signed a contract with MNO, the API respond sets to 'false'(e.g., 2023-10-09 in the Scenario 1 of the figure above). @@ -37,7 +37,7 @@ info: * ASP A decides to stop sending the SMS message to User A and contacts User A by mail. * By following these steps, ASP A ensures that a phone number is not linked to User A and prevents the mis-delivery of the SMS message. - Number_Recycling_scenario_2 + Number_Recycling_scenario_2 Note: * When the API receives a request with specified date during which there is no contract with MNO for the phone number, the API respond sets to 'true'(e.g., the period between 2024-02-25 and 2024-09-20 in the Scenario 2 of the figure above). From 0e897310d8c7447d6dc1e4e01f8891503e384740 Mon Sep 17 00:00:00 2001 From: Kenichi Yamamoto Date: Mon, 6 Jan 2025 21:09:05 +0900 Subject: [PATCH 11/12] Update README.md for r1.1 --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 09b9b94..a4744f5 100644 --- a/README.md +++ b/README.md @@ -7,19 +7,23 @@ # NumberRecycling -Repository to describe, develop, document, and test the NumberRecycling API within the +Repository to describe, develop, document, and test the NumberRecycling API within the KnowYourCustomer (KYC) API family. ## Scope * Service API “NumberRecycling” (see [APIBacklog.md](https://github.com/camaraproject/APIBacklog/blob/main/documentation/APIbacklog.md)) * The API provides the customer with the ability to: - * To know whether a phone number is linked to a subscriber, the Number Recycling API can be used to check whether the subscriber of the phone number has changed + * Check whether the subscriber of the phone number has changed. A common scenario is when Application service provider (ASP) wants to check whether there has been a change in the user associated with the phone number after the specified date. This allows the ASP to ensure that a phone number is correctly linked to an user and prevent the mis-delivery of SMS messages. * Describe, develop, document, and test the API * Started: August 2024 ## Release Information -The repository has no (pre)releases yet, work in progress is within the main branch. +* Note: Please be aware that the project will have 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 pre-release of CAMARA Number Recycling is [r1.1](https://github.com/camaraproject/NumberRecycling/tree/r1.1)**. The Release Tag is [r1.1](https://github.com/camaraproject/NumberRecycling/releases/tag/r1.1). + - Contains the following API definitions **with inline documentation**: + - [YAML spec file](https://github.com/camaraproject/NumberRecycling/blob/r1.1/code/API_definitions/number-recycling.yaml) | [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberRecycling/r1.1/code/API_definitions/number-recycling.yaml&nocors) | [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/NumberRecycling/r1.1/code/API_definitions/number-recycling.yaml&nocors) ## Contributing * Meetings of KnowYourCustomer Sub Project are held virtually From 2195be3a4bf76ce20df148238f8674f20ee1ebe7 Mon Sep 17 00:00:00 2001 From: Kenichi Yamamoto Date: Tue, 7 Jan 2025 21:35:26 +0900 Subject: [PATCH 12/12] Update README.md Co-authored-by: Herbert Damker --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a4744f5..dd89ac5 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ # NumberRecycling -Repository to describe, develop, document, and test the NumberRecycling API within the KnowYourCustomer (KYC) API family. +API Repository to describe, develop, document, and test the NumberRecycling API within the KnowYourCustomer (KYC) API Sub Project. ## Scope