Release r1.1 (Release Candidate)

CHANGELOG.md

@@ -2,12 +2,70 @@
 
 ## Table of Contents
 
+- [r2.1 - rc](#r11---rc)
 - [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.**
 
+The below sections record the changes for each API version in each release as follows:
+
+* for each first alpha or release-candidate API version, all changes since the release of the previous public API version
+* for subsequent alpha or release-candidate API versions, the delta with respect to the previous pre-release
+* for a public API version, the consolidated changes since the release of the previous public API version
+
+## r1.1 - rc
+
+## Release Notes
+
+This release contains the definition and documentation of
+* Blockchain Public Address v0.2.0-rc.1
+
+The API definition(s) are based on
+* Commonalities v0.5.0-alpha.1
+* Identity and Consent Management v0.3.0-alpha.1
+
+## Blockchain Public Address v0.2.0-rc.1
+
+**Blockchain Public Address v0.2.0-rc.1 is the first release-candidate version for v0.2.0 of the Blockchain Public Address API.**
+- **This version contains significant changes compared to v0.1.0, and it is not backward compatible:**
+  - Refactor `retrieveBlockchainPublicAddress` endpoint to use an HTTP POST request
+  - Error model aligment with commonalities, which implies use of normalization values (i.e. enums) for `status` and `code`
+  - Removal of `5XX` errors
+
+
+- API definition **with inline documentation**:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/BlockchainPublicAddress/r1.1/code/API_definitions/blockchain-public-address.yaml&nocors)
+  - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/BlockchainPublicAddress/r1.1/code/API_definitions/blockchain-public-address.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/BlockchainPublicAddress/blob/r1.1/code/API_definitions/blockchain-public-address.yaml)
+
+### Added
+* Added new `blockChainNetworkId` Aleph Zero Network in https://github.com/camaraproject/BlockchainPublicAddress/pull/60.
+* Added API Readiness Checklist in https://github.com/camaraproject/BlockchainPublicAddress/pull/68.
+* Added initial testing plan in https://github.com/camaraproject/BlockchainPublicAddress/pull/70.
+
+### Changed
+* API aligment with Commonalities (Fall24 aligment) in https://github.com/camaraproject/BlockchainPublicAddress/pull/58.
+* Refactor `retrieveBlockchainPublicAddress` endpoint to use an HTTP POST request (avoid phoneNumber as query param) in https://github.com/camaraproject/BlockchainPublicAddress/pull/60.
+* Updated User Story file name in https://github.com/camaraproject/BlockchainPublicAddress/pull/67.
+* Updated `# Authorization and authentication` section from ICM guideline in https://github.com/camaraproject/BlockchainPublicAddress/pull/69.
+* Error model aligment with commonalities (Spring25 aligment). Normalization values (i.e. enums) for `status` and `code`. In https://github.com/camaraproject/BlockchainPublicAddress/pull/69.
+
+### Fixed
+* Phone number description to be aligned with Commonalities in https://github.com/camaraproject/BlockchainPublicAddress/pull/69.
+
+### Removed
+* Removed `5XX` errors in https://github.com/camaraproject/BlockchainPublicAddress/pull/69.
+
+## New Contributors
+* N/A
+
+
+**Full Changelog**: https://github.com/camaraproject/CarrierBillingCheckOut/compare/v0.1.0...r1.1
+
 ## 0.1.0
 
+## Release Notes
+
 **Initial baseline contribution**
 - API [definition](https://github.com/camaraproject/BlockchainPublicAddress/tree/release-0.1.0/code/API_definitions)
 
@@ -17,22 +75,18 @@
 - there are ongoing discussions so API evolution is expected.
 
 ### Added
-
 * Initial version with three endpoints:
   * New endpoint `retrieveBlockchainPublicAddress`
   * New endpoint `bindBlockchainPublicAddress`
   * New endpoint `deleteBlockchainPublicAddress`
 
 ### Changed
-
 * N/A
 
 ### Fixed
-
 * N/A
 
 ### Removed
-
 * N/A
 
 ## New Contributors

README.md

@@ -16,13 +16,22 @@ Repository to describe, develop, document and test the Blockchain Public Address
 * Started: June 2023
 
 ## Release Information
-* 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 first initial release and version of Blockchain Public Address API is 0.1.0 and is available within the [release-0.1.0 branch](https://github.com/camaraproject/BlockchainPublicAddress/tree/release-0.1.0)** There are expected changes in upcoming releases. It is addressed for early implementations, but not a stable version yet.
+<!-- Use/uncomment one or multiple the following options -->
+<!-- Pre-releases of this sub project are available in https://github.com/camaraproject/§repo_name§/releases -->
+<!-- The latest public release is available here: https://github.com/camaraproject/§repo_name§/releases/latest -->
+<!-- For changes see [CHANGELOG.md](https://github.com/camaraproject/§repo_name§/blob/main/CHANGELOG.md) -->
+* 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 Release [r1.1 - rc](https://github.com/camaraproject/BlockchainPublicAddress/blob/main/CHANGELOG.md#r1.1---rc) for the Blockchain Public Address APIs Family is available.**
+<br>This is a release candidate. Until the public release there are bug fixes to be expected. The release candidate is suitable for implementors, but it is not recommended to use the API with customers in productive environments.
+
+* The release **r1.1 - rc** is available in [r1.1](https://github.com/camaraproject/BlockchainPublicAddress/tree/r2.1), and includes the following APIs:
 * API definition of Blockchain Public Address API is 0.1.0 (with inline documentation):
-  - OpenAPI [YAML spec file](https://github.com/camaraproject/BlockchainPublicAddress/blob/release-0.1.0/code/API_definitions/blockchain_public_address.yaml)
-  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/BlockchainPublicAddress/release-0.1.0/code/API_definitions/blockchain_public_address.yaml&nocors)
-  - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/BlockchainPublicAddress/release-0.1.0/code/API_definitions/blockchain_public_address.yaml)
-* All releases and pre-releases are available here https://github.com/camaraproject/BlockchainPublicAddress/releases
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/BlockchainPublicAddress/r1.1/code/API_definitions/blockchain-public-address.yaml&nocors)
+  - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/BlockchainPublicAddress/r1.1/code/API_definitions/blockchain-public-address.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/BlockchainPublicAddress/blob/r1.1/code/API_definitions/blockchain-public-address.yaml)
+
+* Other releases of this sub project are available in [BlockchainPublicAddress Releases](https://github.com/camaraproject/BlockchainPublicAddress/releases)
 * For changes see [CHANGELOG.md](https://github.com/camaraproject/BlockchainPublicAddress/blob/main/CHANGELOG.md)
 
 ## Contributing