Release Notes

This public release contains the definition and documentation of

• Blockchain Public Address v0.3.0
• Blockchain Public Address Validation v0.1.0

The API definition(s) are based on

• Commonalities v0.6.0
• Identity and Consent Management v0.4.0

Blockchain Public Address v0.3.0

Blockchain Public Address v0.3.0 is the first public release version for v0.3.0 of the Blockchain Public Address API.

• This version contains changes compared to v0.2.0.

• API definition with inline documentation:

  • View it on ReDoc
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Main changes since r1.2

Added

• Binding enforcement procedure, including addition of new errors 422 - BLOCKCHAIN_PUBLIC_ADDRESS.UNSUPPORTED_ENHANCED_VALIDATION, 400 - BLOCKCHAIN_PUBLIC_ADDRESS.INVALID_NONCE, 400 - BLOCKCHAIN_PUBLIC_ADDRESS.INVALID_SIGNATURE and 400 - BLOCKCHAIN_PUBLIC_ADDRESS.BOTH_NONCE_SIGNATURE_REQUIRED in #76, #95 and #97.
• New section # Additional CAMARA error responses in info.description field in #99.

Changed

• New pattern for x-correlator and model aligment with Commonalities in #99.
• Update User Stories adding a new user story for Binding Enforcement and making some wording alignment in #100.
• Update Gherkin feature files, adding a new test for testing invalid x-correlator value in all API endpoints, adding a specific test to check binding enforcement in bindBlockchainPublicAddress endpoint and making some wording alignments with Commonalities in #101 and #108.
• Error schema model alignment with Commonalities in #108.

Fixed

• N/A

Removed

• 401 - AUTHENTICATION_REQUIRED error in #99.

New Contributors

• N/A

Blockchain Public Address Validation v0.1.0

Blockchain Public Address Validation v0.1.0 is the first public release version for v0.1.0 of the Blockchain Public Address Validation API.

• This version defines a new API:

  • Initial version covering the following functionality and related endpoints:
    • New endpoint createBlockchainPublicAddressValidationNonce, to generate a nonce (one-time challenge) in order to be able to perform binding enforcement in binding process defined in Blockchain Public Address API.

• API definition with inline documentation:

  • View it on ReDoc
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Added

• Baseline API specification definition in #76.
• New section # Additional CAMARA error responses in info.description field in #102.
• New pattern for x-correlator and model aligment with Commonalities in #102.
• Generate User Stories in #103.
• Generate Gherkin feature file, aligned with Commonalities in #104 and #108.

Changed

• N/A

Fixed

• N/A

Removed

• N/A

New Contributors

• N/A

Full Changelog: r1.2...r2.2

Release Notes

This pre-release contains the definition and documentation of

• Blockchain Public Address v0.3.0-rc.1
• Blockchain Public Address Validation v0.1.0-rc.1

The API definition(s) are based on

• Commonalities v0.6.0-rc.1
• Identity and Consent Management v0.4.0-rc.1

Blockchain Public Address v0.3.0-rc.1

Blockchain Public Address v0.3.0-rc.1 is the first release-candidate version for v0.3.0 of the Blockchain Public Address API.

• This version contains changes compared to v0.2.0, and it is not backward compatible:

  • Removal of 401 - AUTHENTICATION_REQUIRED
  • New pattern for x-correlator
  • Addition of a new section # Additional CAMARA error responses in info.description field
  • Addition of 422 - BLOCKCHAIN_PUBLIC_ADDRESS.UNSUPPORTED_ENHANCED_VALIDATION
  • Addition of 400 - BLOCKCHAIN_PUBLIC_ADDRESS.INVALID_NONCE
  • Addition of 400 - BLOCKCHAIN_PUBLIC_ADDRESS.INVALID_SIGNATURE
  • Addition of 400 - BLOCKCHAIN_PUBLIC_ADDRESS.BOTH_NONCE_SIGNATURE_REQUIRED

• API definition with inline documentation:

  • View it on ReDoc
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Main changes since r1.2

Added

• Binding enforcement procedure, including addition of new errors 422 - BLOCKCHAIN_PUBLIC_ADDRESS.UNSUPPORTED_ENHANCED_VALIDATION, 400 - BLOCKCHAIN_PUBLIC_ADDRESS.INVALID_NONCE, 400 - BLOCKCHAIN_PUBLIC_ADDRESS.INVALID_SIGNATURE and 400 - BLOCKCHAIN_PUBLIC_ADDRESS.BOTH_NONCE_SIGNATURE_REQUIRED in #76, #95 and #97.
• New section # Additional CAMARA error responses in info.description field in #99.

Changed

• New pattern for x-correlator and model aligment with Commonalities in #99.
• Update User Stories adding a new user story for Binding Enforcement and making some wording alignment in #100.
• Update Gherkin feature files, adding a new test for testing invalid x-correlator value in all API endpoints, adding a specific test to check binding enforcement in bindBlockchainPublicAddress endpoint and making some wording alignments with Commonalities in #101.

Fixed

• N/A

Removed

• 401 - AUTHENTICATION_REQUIRED error in #99.

New Contributors

• N/A

Blockchain Public Address Validation v0.1.0-rc.1

Blockchain Public Address Validation v0.1.0-rc.1 is the first release-candidate version for v0.1.0 of the Blockchain Public Address Validation API.

• This version defines a new API:

  • Initial version covering the following functionality and related endpoints:
    • New endpoint createBlockchainPublicAddressValidationNonce, to generate a nonce (one-time challenge) in order to be able to perform binding enforcement in binding process defined in Blockchain Public Address API.

• API definition with inline documentation:

  • View it on ReDoc
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Added

• Baseline API specification definition in #76.
• New section # Additional CAMARA error responses in info.description field in #102.
• New pattern for x-correlator and model aligment with Commonalities in #102.
• Generate User Stories in #103.
• Generate Gherkin feature file, aligned with Commonalities in #104.

Changed

• N/A

Fixed

• N/A

Removed

• N/A

New Contributors

• N/A

Full Changelog: r1.2...r2.1

Release Notes

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

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 and code
  • Removal of 5XX errors

• API definition with inline documentation:

  • View it on ReDoc
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Main changes since r1.1 - rc

Added

• N/A

Changed

• Adapt API specification version and servers.url for public release in #74.
• Adapt Testing version for public release in #74.

Fixed

• N/A

Removed

• N/A

New Contributors

• N/A

Full Changelog: v0.1.0...r1.2

Release Notes

This pre-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

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
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Added

• Added new blockChainNetworkId Aleph Zero Network in #60.
• Added API Readiness Checklist in #68.
• Added initial testing plan in #70.

Changed

• API aligment with Commonalities (Fall24 aligment) in #58.
• Refactor retrieveBlockchainPublicAddress endpoint to use an HTTP POST request (avoid phoneNumber as query param) in #60.
• Updated User Story file name in #67.
• Updated # Authorization and authentication section from ICM guideline in #69.
• Error model aligment with commonalities (Spring25 aligment). Normalization values (i.e. enums) for status and code. In #69.

Fixed

• Phone number description to be aligned with Commonalities in #69.

Removed

• Removed 5XX errors in #69.

New Contributors

• N/A

Full Changelog: v0.1.0...r1.1

Changelog BlockchainPublicAddress

Table of Contents

• v0.1.0

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.

0.1.0

Initial baseline contribution

• API definition

Please note

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

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

• N/A

Full Changelog: https://github.com/camaraproject/BlockchainPublicAddress/commits/v0.1.0