fix!: Divide PackageGetAllVersions into two separate methods ListPackageVersions and ListUserPackageVersions

github/users_packages.go

@@ -127,22 +127,21 @@ func (s *UsersService) RestorePackage(ctx context.Context, user, packageType, pa
 	return s.client.Do(ctx, req, nil)
 }
 
-// PackageGetAllVersions gets all versions of a package for a user. Passing the empty string for "user" will
-// get versions for the authenticated user.
-//
-// GitHub API docs: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user
+// ListPackageVersionsOptions specifies the optional parameters to the UsersService.ListPackageVersions.
+type ListPackageVersionsOptions struct {
+	// State of package either "active" or "deleted".
+	State string `url:"state,omitempty"`
+
+	ListOptions
+}
+
+// ListPackageVersions gets all versions of a package for the authenticated user.
 //
 // GitHub API docs: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user
 //
 //meta:operation GET /user/packages/{package_type}/{package_name}/versions
-//meta:operation GET /users/{username}/packages/{package_type}/{package_name}/versions
-func (s *UsersService) PackageGetAllVersions(ctx context.Context, user, packageType, packageName string, opts *PackageListOptions) ([]*PackageVersion, *Response, error) {
-	var u string
-	if user != "" {
-		u = fmt.Sprintf("users/%v/packages/%v/%v/versions", user, packageType, packageName)
-	} else {
-		u = fmt.Sprintf("user/packages/%v/%v/versions", packageType, packageName)
-	}
+func (s *UsersService) ListPackageVersions(ctx context.Context, packageType, packageName string, opts *ListPackageVersionsOptions) ([]*PackageVersion, *Response, error) {
+	u := fmt.Sprintf("user/packages/%v/%v/versions", packageType, packageName)
 	u, err := addOptions(u, opts)
 	if err != nil {
 		return nil, nil, err
@@ -162,6 +161,28 @@ func (s *UsersService) PackageGetAllVersions(ctx context.Context, user, packageT
 	return versions, resp, nil
 }
 
+// ListUserPackageVersions returns package versions for a public package owned by a specified user.
+//
+// GitHub API docs: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user
+//
+//meta:operation GET /users/{username}/packages/{package_type}/{package_name}/versions
+func (s *UsersService) ListUserPackageVersions(ctx context.Context, user, packageType, packageName string) ([]*PackageVersion, *Response, error) {
+	u := fmt.Sprintf("users/%v/packages/%v/%v/versions", user, packageType, packageName)
+
+	req, err := s.client.NewRequest("GET", u, nil)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	var versions []*PackageVersion
+	resp, err := s.client.Do(ctx, req, &versions)
+	if err != nil {
+		return nil, resp, err
+	}
+
+	return versions, resp, nil
+}
+
 // PackageGetVersion gets a specific version of a package for a user. Passing the empty string for "user" will
 // get the version for the authenticated user.
 //

github/users_packages_test.go

@@ -339,7 +339,7 @@ func TestUsersService_specifiedUser_RestorePackage(t *testing.T) {
 	})
 }
 
-func TestUsersService_Authenticated_ListPackagesVersions(t *testing.T) {
+func TestUsersService_ListPackageVersions(t *testing.T) {
 	t.Parallel()
 	client, mux, _ := setup(t)
 
@@ -368,12 +368,12 @@ func TestUsersService_Authenticated_ListPackagesVersions(t *testing.T) {
 	})
 
 	ctx := t.Context()
-	opts := &PackageListOptions{
-		Ptr("internal"), Ptr("container"), Ptr("deleted"), ListOptions{Page: 1, PerPage: 2},
+	opts := &ListPackageVersionsOptions{
+		ListOptions: ListOptions{Page: 1, PerPage: 2},
 	}
-	packages, _, err := client.Users.PackageGetAllVersions(ctx, "", "container", "hello_docker", opts)
+	packages, _, err := client.Users.ListPackageVersions(ctx, "container", "hello_docker", opts)
 	if err != nil {
-		t.Errorf("Users.Authenticated_PackageGetAllVersions returned error: %v", err)
+		t.Errorf("Users.ListPackageVersions returned error: %v", err)
 	}
 
 	want := []*PackageVersion{{
@@ -387,25 +387,25 @@ func TestUsersService_Authenticated_ListPackagesVersions(t *testing.T) {
 		Metadata:       json.RawMessage(m),
 	}}
 	if !cmp.Equal(packages, want) {
-		t.Errorf("Users.PackageGetAllVersions returned %+v, want %+v", packages, want)
+		t.Errorf("Users.ListPackageVersions returned %+v, want %+v", packages, want)
 	}
 
-	const methodName = "PackageGetAllVersions"
+	const methodName = "ListPackageVersions"
 	testBadOptions(t, methodName, func() (err error) {
-		_, _, err = client.Users.PackageGetAllVersions(ctx, "\n", "", "", &PackageListOptions{})
+		_, _, err = client.Users.ListPackageVersions(ctx, "\n", "\n", &ListPackageVersionsOptions{})
 		return err
 	})
 
 	testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
-		got, resp, err := client.Users.PackageGetAllVersions(ctx, "", "", "", &PackageListOptions{})
+		got, resp, err := client.Users.ListPackageVersions(ctx, "", "", &ListPackageVersionsOptions{})
 		if got != nil {
 			t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
 		}
 		return resp, err
 	})
 }
 
-func TestUsersService_specifiedUser_ListPackagesVersions(t *testing.T) {
+func TestUsersService_ListUserPackageVersions(t *testing.T) {
 	t.Parallel()
 	client, mux, _ := setup(t)
 
@@ -434,12 +434,9 @@ func TestUsersService_specifiedUser_ListPackagesVersions(t *testing.T) {
 	})
 
 	ctx := t.Context()
-	opts := &PackageListOptions{
-		Ptr("internal"), Ptr("container"), Ptr("deleted"), ListOptions{Page: 1, PerPage: 2},
-	}
-	packages, _, err := client.Users.PackageGetAllVersions(ctx, "u", "container", "hello_docker", opts)
+	packages, _, err := client.Users.ListUserPackageVersions(ctx, "u", "container", "hello_docker")
 	if err != nil {
-		t.Errorf("Users.specifiedUser_PackageGetAllVersions returned error: %v", err)
+		t.Errorf("Users.ListUserPackageVersions returned error: %v", err)
 	}
 
 	want := []*PackageVersion{{
@@ -453,17 +450,17 @@ func TestUsersService_specifiedUser_ListPackagesVersions(t *testing.T) {
 		Metadata:       json.RawMessage(m),
 	}}
 	if !cmp.Equal(packages, want) {
-		t.Errorf("Users.specifiedUser_PackageGetAllVersions returned %+v, want %+v", packages, want)
+		t.Errorf("Users.ListUserPackageVersions returned %+v, want %+v", packages, want)
 	}
 
-	const methodName = "PackageGetAllVersions"
+	const methodName = "ListUserPackageVersions"
 	testBadOptions(t, methodName, func() (err error) {
-		_, _, err = client.Users.PackageGetAllVersions(ctx, "\n", "", "", &PackageListOptions{})
+		_, _, err = client.Users.ListUserPackageVersions(ctx, "\n", "\n", "\n")
 		return err
 	})
 
 	testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
-		got, resp, err := client.Users.PackageGetAllVersions(ctx, "", "", "", &PackageListOptions{})
+		got, resp, err := client.Users.ListUserPackageVersions(ctx, "", "", "")
 		if got != nil {
 			t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
 		}