Add information about default pagination to REST API documentation.

[codydirks]

Actions before raising this issue

• I searched the existing issues and did not find anything similar.
• I read/searched the docs

Is your feature request related to a problem? Please describe.

The current API docs don't make it clear that some GET requests (i.e. /api/tasks, and probably others) will paginate results with a default page size of 10, rather than returning all results in a single request as a user might naively expect.

Describe the solution you'd like

Updated documentation to reflect the default pagination behavior, for any API endpoint that returns an array of results.

Alternatively, but probably a more involved change, would be to add a parameter that allows a user to override the default pagination and return all results if they so desire.

Describe alternatives you've considered

No response

Additional context

No response

[demoncoder-crypto]

I would love to work on this. Could you please assign me.

[zhiltsov-max]

Hi, we have a topic covering this in low level SDK API docs, as well as a utility function to request all pages. In the server API docs (e.g. here or in Swagger) we have parameter lists with available query parameters (including page and page_size), and endpoints with paginated output can typically be determined by the response schema description having count, prev, next, and page results array. Almost all endpoints that potentially can return an unlimited number of items return a paginated response. Returning all results in a single response is only available in development deployments.

[codydirks]

Would it at least be possible to denote the default value of page_size in those docs? Denoting a default value that is used if none is supplied is fairly standard practice in this sort of documentation.

[zhiltsov-max]

Yeah, looks like a good idea.