document limit & offset query parameters for submissions REST API, fixes getodk/central#1099#1749
Open
brontolosone wants to merge 1 commit intogetodk:masterfrom
Conversation
| example: true | ||
| - name: limit | ||
| in: query | ||
| description: The maximum number of entries to return. |
Member
There was a problem hiding this comment.
Suggested change
| description: The maximum number of entries to return. | |
| description: The maximum number of submissions to return. |
No strong feelings, might just be a little clearer this way.
| example: "100" | ||
| - name: offset | ||
| in: query | ||
| description: The zero-indexed number of entries to skip from the result. |
Member
There was a problem hiding this comment.
Suggested change
| description: The zero-indexed number of entries to skip from the result. | |
| description: The number of submissions to skip from the result (starting with the latest submission). |
I could see the term "zero-indexed" being slightly confusing in this context. If you specify offset=0, that means "skip 0 entries", not "skip 1 entry". It feels more like a count than an index, like 0 doesn't refer to "the first one".
Or is "zero-indexed" there to clarify that "we're skipping from the start (from the zero-indexed submission, i.e., the latest submission)"?
I've suggested some alternative text (which may be unclear in its own way 😅) — let me know what you think.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes getodk/central#1099
What has been done to verify that this works as intended?
CI
Why is this the best possible solution? Were any other approaches considered?
N/A
How does this change affect users? Describe intentional changes to behavior and behavior that could have accidentally been affected by code changes. In other words, what are the regression risks?
N/A
Does this change require updates to the API documentation? If so, please update docs/api.yaml as part of this PR.
it IS an update to the API documentation 🤣
Before submitting this PR, please make sure you have:
make testand confirmed all checks still pass OR confirm CircleCI build passes