Skip to content

API Spec Alignment with Commonalities and ICM - Release 1.1#69

Merged
PedroDiez merged 3 commits intocamaraproject:mainfrom
PedroDiez:api_spec_alignment_for_r1.1
Feb 14, 2025
Merged

API Spec Alignment with Commonalities and ICM - Release 1.1#69
PedroDiez merged 3 commits intocamaraproject:mainfrom
PedroDiez:api_spec_alignment_for_r1.1

Conversation

@PedroDiez
Copy link
Collaborator

What type of PR is this?

  • enhancement/feature

What this PR does / why we need it:

API Spec alignement with Current Commonalities and ICM (Spring 25)

Which issue(s) this PR fixes:

Fixes #63

Special notes for reviewers:

  • Updated info.description with ICM "Authentication and Authorization" text section
  • Align Errors with Commonalities Model
  • Removed 5XX errors, following Commonalities Guidelines
  • Updating version and servers.url for RC
  • Align phoneNumber description and adding the pattern

Changelog input

 API Spec alignement with Current Commonalities and ICM for RC1

Additional documentation

This section can be blank.

docs

@PedroDiez PedroDiez self-assigned this Jan 15, 2025
@PedroDiez PedroDiez requested a review from rartych January 15, 2025 12:06
@PedroDiez PedroDiez added the enhancement New feature or request label Jan 15, 2025
Copy link
Contributor

@tanjadegroot tanjadegroot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good.
please ensure to check all updates in the changelog of Commonalities and of ICM for applicable items.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

General comment: for a developer who does not know what a BlockchainPublicAddress can be used for, maybe add an additional paragraph on what this API is about.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have added clarifications to the term BlockChain Public Address

@PedroDiez
Copy link
Collaborator Author

Please @grgpapadopoulos, @tanjadegroot take a look.
Have addressed the comments

Copy link
Contributor

@tanjadegroot tanjadegroot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good !
/LGTM

# Authorization and authentication

The "Camara Security and Interoperability Profile" provides details on how a client requests an access token. Please refer to Identify and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the Profile.
The "Camara Security and Interoperability Profile" provides details of how an API consumer requests an access token. Please refer to Identity and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the profile.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Identity and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/)
-->
Identity and Consent Management

so that it show as a nicer link.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reviewing this to get latest text

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@PedroDiez PedroDiez merged commit 01de53c into camaraproject:main Feb 14, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Blockchain Public Address API - Aligment with Commonalities and ICM MetaRelease Spring 25 Guidelines

3 participants