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 an alpha release, the delta with respect to the previous release
- for the first release-candidate, all changes since the last public release
- for subsequent release-candidate(s), only the delta to the previous release-candidate
- for a public release, the consolidated changes since the previous public release
This release contains the definition and documentation of
- Blockchain Public Address v0.2.0
The API definition(s) are based on
- Commonalities v0.5.0
- Identity and Consent Management v0.3.0
Blockchain Public Address v0.2.0 is the first public release 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
andcode
- Removal of
5XX
errors
- Refactor
-
API definition with inline documentation:
Main changes since r1.1 - rc
- N/A
- Adapt API specification version and servers.url for public release in camaraproject#74.
- Adapt Testing version for public release in camaraproject#74.
- N/A
- N/A
- N/A
Full Changelog: https://github.com/camaraproject/BlockchainPublicAddress/compare/v0.1.0...r1.2
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-rc.1
- Identity and Consent Management v0.3.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
andcode
- Removal of
5XX
errors
- Refactor
-
API definition with inline documentation:
- Added new
blockChainNetworkId
Aleph Zero Network in camaraproject#60. - Added API Readiness Checklist in camaraproject#68.
- Added initial testing plan in camaraproject#70.
- API aligment with Commonalities (Fall24 aligment) in camaraproject#58.
- Refactor
retrieveBlockchainPublicAddress
endpoint to use an HTTP POST request (avoid phoneNumber as query param) in camaraproject#60. - Updated User Story file name in camaraproject#67.
- Updated
# Authorization and authentication
section from ICM guideline in camaraproject#69. - Error model aligment with commonalities (Spring25 aligment). Normalization values (i.e. enums) for
status
andcode
. In camaraproject#69.
- Phone number description to be aligned with Commonalities in camaraproject#69.
- Removed
5XX
errors in camaraproject#69.
- N/A
Full Changelog: https://github.com/camaraproject/BlockchainPublicAddress/compare/v0.1.0...r1.1
Initial baseline contribution
- API definition
- this "release" is tagged to have an initial baseline API contribution to move forward. It is released for early implementations.
- there are ongoing discussions so API evolution is expected.
- Initial version with three endpoints:
- New endpoint
retrieveBlockchainPublicAddress
- New endpoint
bindBlockchainPublicAddress
- New endpoint
deleteBlockchainPublicAddress
- New endpoint
- N/A
- N/A
- N/A
- N/A
Full Changelog: https://github.com/camaraproject/BlockchainPublicAddress/commits/v0.1.0