Update README to explain `top` in pagination response
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- openapi
- Domain
- api, documentation
Research direction
Start with the linked swagger.yaml section around line 1758 and locate the README pagination documentation. Confirm where the top property is explained, including server-imposed limits and the default when no page size is requested. Done means the README clearly documents this behavior and its possible applicability to the Foundation API.
Written by the indexing model from the issue text.
Description
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?
- Dominant language
- No language data
- Stars
- 239
- Forks
- 67
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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.
More from buildingSMART/BCF-API
-
Difficulty 2/5 1-3 hours Newbie friendliness 48/100
buildingSMART/BCF-API#395 ·
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
buildingSMART/BCF-API#394 ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
buildingSMART/BCF-API#392 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 45/100
buildingSMART/BCF-API#390 ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
buildingSMART/BCF-API#389 · 2 comments ·
All issues in buildingSMART/BCF-API
Similar issues
-
[Feature]:Openenhancement
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
thephpleague/commonmark#1159 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
EchoTools/nevr-runtime#117 · 2 comments ·
Maintainers usually reply within 1 day
-
Proxy drops log notifications from backends that don't send FastMCP's msg/extra dictPossibly taken @asasemahmed claimed this today. Openbug server
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
llvm/offload-test-suite#1554 ·
Maintainers usually reply within 1 day