cloudfoundry / cloudfoundry/cloud_controller_ng
Document the default number of records returned for resources on the pagination section
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 207
- Forks
- 373
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 56
Description
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open docs/v3/source/includes/concepts/_pagination.md.erb at the pagination text linked in the issue. Update the documentation to state that the default response contains 50 records, then verify the pagination section clearly describes this behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100