Release r1.1

CHANGELOG.md

@@ -0,0 +1,25 @@
+# Number Recycling
+
+## Table of Contents
+
+- [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.**
+
+# r1.1
+
+**This is the first alpha version of the KYC APIs.** 
+
+- [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.
+
+## Please note:
+
+- This is an alpha version, it should be considered as a draft.
+
+## What's changed
+
+* 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.
+

README.md

@@ -7,19 +7,23 @@
 <a href="https://github.com/camaraproject/NumberRecycling/releases/latest" title="Latest Release"><img src="https://img.shields.io/github/release/camaraproject/NumberRecycling?style=plastic"></a>
 
 # NumberRecycling
-Repository to describe, develop, document, and test the NumberRecycling API within the 
+API Repository to describe, develop, document, and test the NumberRecycling API within the KnowYourCustomer (KYC) API Sub Project.
 
 ## 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 

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.
 
-    <img width="4000" alt="Number_Recycling_scenario_1" src="https://raw.githubusercontent.com/camaraproject/NumberRecycling/main/documentation/API_documentation/assets/Number_Recycling_scenario_1.png">
+    <img width="4000" alt="Number_Recycling_scenario_1" src="https://raw.githubusercontent.com/camaraproject/NumberRecycling/r1.1/documentation/API_documentation/assets/Number_Recycling_scenario_1.png">
 
     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.
 
-    <img width="4000" alt="Number_Recycling_scenario_2" src="https://raw.githubusercontent.com/camaraproject/NumberRecycling/main/documentation/API_documentation/assets/Number_Recycling_scenario_2.png">
+    <img width="4000" alt="Number_Recycling_scenario_2" src="https://raw.githubusercontent.com/camaraproject/NumberRecycling/r1.1/documentation/API_documentation/assets/Number_Recycling_scenario_2.png">
 
     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).
@@ -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-alpha.1
   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/v0.1alpha1'
     variables:
       apiRoot:
         default: http://localhost:9091