Release r1.1

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.
+

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