Add ListOptions for listing user migrations (#2417)

Fixes: #2416.
google · Aug 22, 2022 · dd22b73 · dd22b73
1 parent 01c8feb
commit dd22b73
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/example/migrations/main.go b/example/migrations/main.go
@@ -24,7 +24,7 @@ func fetchAllUserMigrations() ([]*github.UserMigration, error) {
 	tc := oauth2.NewClient(ctx, ts)
 	client := github.NewClient(tc)
 
-	migrations, _, err := client.Migrations.ListUserMigrations(ctx)
+	migrations, _, err := client.Migrations.ListUserMigrations(ctx, &github.ListOptions{Page: 1})
 	return migrations, err
 }
 

diff --git a/github/migrations_user.go b/github/migrations_user.go
@@ -97,8 +97,12 @@ func (s *MigrationService) StartUserMigration(ctx context.Context, repos []strin
 // ListUserMigrations lists the most recent migrations.
 //
 // GitHub API docs: https://docs.github.com/en/rest/migrations/users#list-user-migrations
-func (s *MigrationService) ListUserMigrations(ctx context.Context) ([]*UserMigration, *Response, error) {
+func (s *MigrationService) ListUserMigrations(ctx context.Context, opts *ListOptions) ([]*UserMigration, *Response, error) {
 	u := "user/migrations"
+	u, err := addOptions(u, opts)
+	if err != nil {
+		return nil, nil, err
+	}
 
 	req, err := s.client.NewRequest("GET", u, nil)
 	if err != nil {

diff --git a/github/migrations_user_test.go b/github/migrations_user_test.go
@@ -66,7 +66,7 @@ func TestMigrationService_ListUserMigrations(t *testing.T) {
 	})
 
 	ctx := context.Background()
-	got, _, err := client.Migrations.ListUserMigrations(ctx)
+	got, _, err := client.Migrations.ListUserMigrations(ctx, &ListOptions{Page: 1, PerPage: 2})
 	if err != nil {
 		t.Errorf("ListUserMigrations returned error %v", err)
 	}
@@ -78,7 +78,7 @@ func TestMigrationService_ListUserMigrations(t *testing.T) {
 
 	const methodName = "ListUserMigrations"
 	testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
-		got, resp, err := client.Migrations.ListUserMigrations(ctx)
+		got, resp, err := client.Migrations.ListUserMigrations(ctx, &ListOptions{Page: 1, PerPage: 2})
 		if got != nil {
 			t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
 		}