feat(sdk): make offset and count parameters optional and None by default #45
Conversation
This file contains 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
catcombo
force-pushed
the
feature/make-pagination-optional
branch
from
772abfb to
77978a3
Compare
catcombo
force-pushed
the
feature/make-pagination-optional
branch
from
77978a3 to
14c45a0
Compare
zyv
suggested changes
Mar 15, 2024
There was a problem hiding this comment.
I agree with your conclusion, but I would not make this change unless we actually implement following the pagination.
I have looked at the code, and I can't see any code pertaining to that in our SDK. If you now make this change, then the behaviour will silently change of all consumers, and instead of getting full responses, they will start suddenly getting 1000 results, unless they change their code. This will break a lot of stuff, including our reporting.
|
Ok, then lets close this PR. |
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.
This makes
offsetandcountparameters optional andNoneby default. It will affect existing code that does not setcountvalue and relies on the default value, which has been changed from-1toNone. Now, in case of a very large sample, YouTrack API will return 1000 entries by default. But if you want to fetch all entries, setcount=-1or paginate results until you get an empty page. I didn't find any confirmation in the docs that-1is a valid value, so it's better to use pagination.