feat!: Add pagination to Repository/Organization Rules Get methods #3236
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
gmlewis
added
NeedsReview
gmlewis
changed the title
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #3236 +/- ##
==========================================
- Coverage 97.72% 92.89% -4.83%
==========================================
Files 153 171 +18
Lines 13390 11642 -1748
==========================================
- Hits 13085 10815 -2270
- Misses 215 730 +515
- Partials 90 97 +7 ☔ View full report in Codecov by Sentry. |
gmlewis
approved these changes
Aug 15, 2024
There was a problem hiding this comment.
Thank you, @lyoung-confluent !
LGTM.
Awaiting second LGTM+Approval from any other contributor to this repo before merging.
gmlewis
requested changes
Aug 15, 2024
| @@ -38,7 +39,7 @@ func TestOrganizationsService_GetAllOrganizationRulesets(t *testing.T) { | |||
| }) | |||
|
|
|||
| ctx := context.Background() | |||
| rulesets, _, err := client.Organizations.GetAllOrganizationRulesets(ctx, "o") | |||
| rulesets, _, err := client.Organizations.GetAllOrganizationRulesets(ctx, "o", &ListOptions{Page: 2, PerPage: 2}) | |||
There was a problem hiding this comment.
After line 63 below, please add:
testBadOptions(t, methodName, func() (err error) {
_, _, err = client.Organizations.GetAllOrganizationRulesets(ctx, "\n", &ListOptions{})
return err
})
| @@ -301,7 +302,7 @@ func TestRepositoriesService_GetRulesForBranch(t *testing.T) { | |||
| }) | |||
|
|
|||
| ctx := context.Background() | |||
| rules, _, err := client.Repositories.GetRulesForBranch(ctx, "o", "repo", "branch") | |||
| rules, _, err := client.Repositories.GetRulesForBranch(ctx, "o", "repo", "branch", &ListOptions{Page: 2, PerPage: 2}) | |||
There was a problem hiding this comment.
After line 329 below, please add:
testBadOptions(t, methodName, func() (err error) {
_, _, err = client.Repositories.GetRulesForBranch(ctx, "\n", "\n", "\n", &ListOptions{})
return err
})
| @@ -350,7 +352,7 @@ func TestRepositoriesService_GetRulesForBranchEmptyUpdateRule(t *testing.T) { | |||
| }) | |||
|
|
|||
| ctx := context.Background() | |||
| rules, _, err := client.Repositories.GetRulesForBranch(ctx, "o", "repo", "branch") | |||
| rules, _, err := client.Repositories.GetRulesForBranch(ctx, "o", "repo", "branch", &ListOptions{Page: 2, PerPage: 2}) | |||
There was a problem hiding this comment.
After line 369 below, please add:
testBadOptions(t, methodName, func() (err error) {
_, _, err = client.Repositories.GetRulesForBranch(ctx, "\n", "\n", "\n", &ListOptions{})
return err
})
| @@ -400,7 +403,7 @@ func TestRepositoriesService_GetAllRulesets(t *testing.T) { | |||
| }) | |||
|
|
|||
| ctx := context.Background() | |||
| ruleSet, _, err := client.Repositories.GetAllRulesets(ctx, "o", "repo", false) | |||
| ruleSet, _, err := client.Repositories.GetAllRulesets(ctx, "o", "repo", false, &ListOptions{Page: 2, PerPage: 2}) | |||
There was a problem hiding this comment.
After line 431 below, please add:
testBadOptions(t, methodName, func() (err error) {
_, _, err = client.Repositories.GetRulesets(ctx, "\n", "\n", false, &ListOptions{})
return err
})
|
This PR will be closed and marked as abandoned if there is no reply by next week. |
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.
BREAKING CHANGE:
OrganizationsService.GetAllOrganizationRulesets,RepositoriesService.GetRulesForBranch, andRepositoriesService.GetAllRulesetsnow haveopts *ListOptions.The Organization and Repository Rules APIs support pagination (
pageandper_page):This PR adds the standard
ListOptionsparameter to each method so pagination can be used when listing rules.