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

✨Add paging to a result set #459

Open
joriente opened this issue Dec 6, 2024 · 0 comments
Open

✨Add paging to a result set #459

joriente opened this issue Dec 6, 2024 · 0 comments
Labels
Type: Feature A suggested idea for this project

Comments

@joriente
Copy link

joriente commented Dec 6, 2024

Cc:

Hi Developer,
It is very practical to provide a large set of results as paged results. I believe that the page metadata should be returned in the response header.

Pain

Most UI's have paged results rather than all the results returned at once.

Suggested Solution

Return all the heroes as pages rather than the entire set.

Acceptance Criteria

Acceptance Criteria defines the requirements that must be met for the story to be completed. This is WHAT must be done.

See https://www.ssw.com.au/rules/acceptance-criteria.

  1. User request a page of data via api

Tasks

Tasks help developers to track small bits of work needed to meet the ACs. This is HOW the work will be done.

  1. Create an extension method the return paged data and metadata.
  2. Create a class that contains a single page of data and the metadata.
  3. Create a new query the returns a paged list of heroes and metadata.
  4. Add API method to return paged data in the response and the meta data in the X-Pagination response header.

More Information

Screenshots

Image

Thanks!

@joriente joriente added the Type: Feature A suggested idea for this project label Dec 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Feature A suggested idea for this project
Projects
Development

No branches or pull requests

1 participant