JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

Pagination of included resources?

Open
#1,103 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Priority: High Target: 0.10 Type: Enhancement
Dominant language
Ruby
Stars
2.3k
Forks
546
PR merge metrics
No merged PRs in 30d

Description

In trying to debug some performance issues I discovered that whenever include is used to include child resources that ALL of the children are included in the response. Is there a way to paginate those, or just to include the first X children? (I suspect that my search-fu is weak this morning because I'm having trouble finding any issues that talk about this, but I'd be surprised if I'm the first person to have this problem.)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how include expands child resources and how included resources are represented in the response. Define the intended pagination or child-limit behavior, including its request syntax and completion criteria, before identifying the relevant implementation and tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
rails, ruby
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.