Confusion over default pagination documentation

[Wizofgoz]

There is some conflicting information in the docs regarding pagination behavior when no page query parameters are sent by the client.

Here, it implies that requests will always be paginated by default by what is defined on the model, or by what is set as the default on the paginator:

But here, there is a section about forcing pagination when no query parameters are set:

The latter is the behavior I observe as being correct but the documentation of the former makes this confusing and I'm not sure what the point of it is.

[lindyhopchris]

Ah yes I can see how that is confusing - thanks for raising.

For the page size section, it's talking about the page size it uses if the client provides page parameter but does not provide a page size for it. For example:

GET /api/v1/posts?page[number]=1

It will return a paginated response, with the page size specified on either the model, or the withDefaultPerPage() method if that has been used.

However if a client calls:

GET /api/v1/posts

i.e. no page parameters, then the response will not be paginated - unless you've set the $defaultPagination property, in which case the client will get a paginated response as per your default pagination settings.

Hope that makes sense? I'll update the docs.

[lindyhopchris]

@Wizofgoz chapter has been updated (but not deployed to the website yet). You can view it here:
https://github.com/laravel-json-api/docs/blob/develop/1.0/schemas/pagination.md#page-size

Does that make it clearer? Both sections have been updated.

[Wizofgoz]

@lindyhopchris yes, that makes a lot of sense. Thank you for the prompt response!