Skip to content

Create a resource for an API consumer to retrieve their registration information#78

Open
alpaycetin74 wants to merge 8 commits intomainfrom
alpaycetin74-patch-1
Open

Create a resource for an API consumer to retrieve their registration information#78
alpaycetin74 wants to merge 8 commits intomainfrom
alpaycetin74-patch-1

Conversation

@alpaycetin74
Copy link
Contributor

@alpaycetin74 alpaycetin74 commented Mar 11, 2026

What type of PR is this?

Add one of the following kinds:

  • enhancement/feature

What this PR does / why we need it:

Create a new API resource for an API consumer to retrieve a list of their existing registrations.
This may be useful in case a consumer loses track of the registration ids they have received when they had created registrations with the POST request.

Which issue(s) this PR fixes:

Fixes #70

Special notes for reviewers:

Changelog input

 release-note

Additional documentation

@alpaycetin74 alpaycetin74 marked this pull request as draft March 11, 2026 08:29
@github-actions
Copy link

github-actions bot commented Mar 11, 2026

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ ACTION actionlint 2 0 0.01s
✅ API spectral 2 0 3.37s
✅ GHERKIN gherkin-lint 5 0 1.76s
✅ REPOSITORY git_diff yes no 0.01s
✅ REPOSITORY secretlint yes no 0.77s
✅ YAML yamllint 2 0 0.55s

See detailed report in MegaLinter reports

MegaLinter is graciously provided by OX Security

@hdamker
Copy link
Contributor

hdamker commented Mar 15, 2026

Short comment on terminology: the issue says "customer", here "client" is used, but if the API Consumer is meant, than "API Consumer" would be the right term according to https://github.com/camaraproject/Commonalities/blob/main/documentation/Glossary.md

@alpaycetin74 alpaycetin74 changed the title Create a resource for a client to retrieve their registration information Create a resource for an API consumer to retrieve their registration information Mar 16, 2026
@alpaycetin74 alpaycetin74 marked this pull request as ready for review March 16, 2026 07:26
@GillesInnov35
Copy link
Contributor

thanks @alpaycetin74 , I see that Commonalities recommend for pagination https://github.com/camaraproject/Commonalities/blob/main/documentation/CAMARA-API-Design-Guide.md#41-pagination

The HTTP codes that the server will use as a response are:
200: the response includes the complete list of resources
206: the response does not include the complete list of resources
400: request outside the range of the resource list

@alpaycetin74
Copy link
Contributor Author

thanks @alpaycetin74 , I see that Commonalities recommend for pagination https://github.com/camaraproject/Commonalities/blob/main/documentation/CAMARA-API-Design-Guide.md#41-pagination

The HTTP codes that the server will use as a response are: 200: the response includes the complete list of resources 206: the response does not include the complete list of resources 400: request outside the range of the resource list

Thanks @GillesInnov35 I'll add 206 code and a specific example for 400 error.

add 206 response to GET /registrations for paginated responses.
Remove pagination headers from 200 response.
@alpaycetin74
Copy link
Contributor Author

hello @GillesInnov35 , I added http 206 response code.
I also found out there is an ongoing discussion in commonalities for pagination: camaraproject/Commonalities#592

I'll keep an eye on that and adapt if commonality guidelines change. Thank you.

Copy link
Contributor

@GillesInnov35 GillesInnov35 left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @alpaycetin74

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

How can a customer retrieve a list of their registration identifiers

3 participants