buildingSMART / buildingSMART/BCF-API
Update README to explain `top` in pagination response
Open
- Dominant language
- No language data
- Stars
- 237
- Forks
- 67
- PR merge metrics
- No merged PRs in 30d
Description
https://github.com/buildingSMART/BCF-API/blob/19ac4f410728994bb67fb1552c974b4ec36d6f90/swagger.yaml#L1758
The `top` property describes how many items are at most returned per request / per page. If a server responds with a lower `top` value than what the client originally asked for, then that means the server has imposed a lower limit than what was requested.
If no page size is requested, the server will still populate the `top` property with it's default limit.
Maybe this part should be included in the Foundation API?
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.