Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GET /credentials endpoint should return result object instead of an array #436

Open
PatStLouis opened this issue Dec 10, 2024 · 1 comment
Assignees
Labels
ready for PR Issue ready to be resolved via a Pull Request

Comments

@PatStLouis
Copy link
Collaborator

PatStLouis commented Dec 10, 2024

The GET /credentials endpoint is currently set to return an array of credentials. I would suggest to instead return an object with a results property containing an array of credentials to enable pagination.

@msporny
Copy link
Contributor

msporny commented Dec 17, 2024

The group talked about this on the 2024-12-17 telecon:

@PatStLouis noted that the return value should be an object instead of an array. For all endpoints we return an object, which return results and can provide other metadata with the result, pagination support, etc. The results keyword was suggested as the top-level object property name.

This is ready for PR, there were no objections to the path forward.

@msporny msporny added the ready for PR Issue ready to be resolved via a Pull Request label Dec 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready for PR Issue ready to be resolved via a Pull Request
Projects
None yet
Development

No branches or pull requests

2 participants