Skip to content

Document the default number of records returned for resources on the pagination section #2432

Open
@devconcept

Description

@devconcept

Issue

Currently the pagination section of the docs states the following

"Any request that can return multiple resources will be paginated and contain a pagination object and list of resources. Requests for multiple resources can use page, per_page, and order_by in addition to filters specific to the endpoint."

It says "will be paginated" and "can return multiple" but doesn't say exactly how much records are returned. We figured out that it was 50 records. This should be specified in the docs

Context

The issue applies to all resources as far as I know

Steps to Reproduce

Check the current documentation

https://v3-apidocs.cloudfoundry.org/version/3.99.0/index.html#pagination

Expected result

It should be specific about how many records are returned so any change in behavior is clear and can be handled by the developers.

Current result

We need to perform experiments just to know how many records will be returned.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions