fix!: Add field PerPage to OrganizationsListOptions (#3986)

BREAKING CHANGE: `OrganizationsListOptions` now contains only `PerPage` instead of `ListOptions`.

Author: alexandear

.golangci.yml

@@ -362,6 +362,7 @@ linters:
             - NotificationListOptions.Participating # TODO: Activities
             - NotificationListOptions.Since # TODO: Activities
             - OrganizationsListOptions.Since # TODO: Organizations
+            - OrganizationsListOptions.PerPage # TODO: Organizations
             - ProjectV2ItemFieldValue.DataType # TODO: Projects
             - ProjectV2ItemFieldValue.Name # TODO: Projects
             - PullRequestListCommentsOptions.Direction # TODO: PullRequests

github/github-iterators.go

@@ -153,13 +153,11 @@ func (p Plan) String() string {
 // OrganizationsListOptions specifies the optional parameters to the
 // OrganizationsService.ListAll method.
 type OrganizationsListOptions struct {
-	// Since filters Organizations by ID.
+	// An organization ID. Only return organizations with an ID greater than this ID.
 	Since int64 `url:"since,omitempty"`
 
-	// Note: Pagination is powered exclusively by the Since parameter,
-	// ListOptions.Page has no effect.
-	// ListOptions.PerPage controls an undocumented GitHub API parameter.
-	ListOptions
+	// The number of results per page (max 100).
+	PerPage int `url:"per_page,omitempty"`
 }
 
 // ListAll lists all organizations, in the order that they were created on GitHub.

github/github-iterators_test.go

@@ -71,14 +71,13 @@ func TestOrganizationsService_ListAll(t *testing.T) {
 	t.Parallel()
 	client, mux, _ := setup(t)
 
-	since := int64(1342004)
 	mux.HandleFunc("/organizations", func(w http.ResponseWriter, r *http.Request) {
 		testMethod(t, r, "GET")
-		testFormValues(t, r, values{"since": "1342004"})
+		testFormValues(t, r, values{"since": "1342004", "per_page": "30"})
 		fmt.Fprint(w, `[{"id":4314092}]`)
 	})
 
-	opt := &OrganizationsListOptions{Since: since}
+	opt := &OrganizationsListOptions{Since: int64(1342004), PerPage: 30}
 	ctx := t.Context()
 	orgs, _, err := client.Organizations.ListAll(ctx, opt)
 	if err != nil {