Skip to content

Pagination Customization Docs Confusing #291

@jamesarosen

Description

@jamesarosen

The current pagination docs are a bit confusing. They suggest

JsonApiClient::Paginating::Paginator.page_param = "page[number]"
JsonApiClient::Paginating::Paginator.per_page_param = "page[size]"

But JsonApiClient::Query::Builder#pagination_params wraps those in a page: {…}, resulting in URLs like

?page[page[number]]=2&page[page[size]]=20

Without overriding #pagination_params, there's no way to get rid of the page[…] wrapping. Moving the wrapping to page_param and per_page_param probably requires a major version bump. In the meantime, a little more documentation would help.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions