Allow create custom repository/organization roles without permissions g…

…oogle#3226 Signed-off-by: Andríyun <[email protected]>
DanskeCommodities · Aug 13, 2024 · f0a9d4d · f0a9d4d
1 parent f5d2850
commit f0a9d4d
Show file tree

Hide file tree

Showing 4 changed files with 179 additions and 74 deletions.
diff --git a/github/github-accessors.go b/github/github-accessors.go
diff --git a/github/github-accessors_test.go b/github/github-accessors_test.go
diff --git a/github/orgs_custom_roles.go b/github/orgs_custom_roles.go
@@ -49,15 +49,30 @@ type CustomRepoRoles struct {
 	UpdatedAt   *Timestamp    `json:"updated_at,omitempty"`
 }
 
-// CreateOrUpdateOrgRoleOptions represents options required to create or update a custom organization role.
-type CreateOrUpdateOrgRoleOptions struct {
+// CreateOrgRoleOptions represents options required to create a custom organization role.
+type CreateOrgRoleOptions struct {
+	Name        *string  `json:"name"`
+	Description *string  `json:"description"`
+	Permissions []string `json:"permissions"`
+}
+
+// UpdateOrgRoleOptions represents options used to update a custom organization role.
+type UpdateOrgRoleOptions struct {
 	Name        *string  `json:"name,omitempty"`
 	Description *string  `json:"description,omitempty"`
 	Permissions []string `json:"permissions,omitempty"`
 }
 
-// CreateOrUpdateCustomRepoRoleOptions represents options required to create or update a custom repository role.
-type CreateOrUpdateCustomRepoRoleOptions struct {
+// CreateCustomRepoRoleOptions represents options required to create a custom repository role.
+type CreateCustomRepoRoleOptions struct {
+	Name        *string  `json:"name"`
+	Description *string  `json:"description"`
+	BaseRole    *string  `json:"base_role"`
+	Permissions []string `json:"permissions"`
+}
+
+// UpdateCustomRepoRoleOptions represents options used to update a custom repository role.
+type UpdateCustomRepoRoleOptions struct {
 	Name        *string  `json:"name,omitempty"`
 	Description *string  `json:"description,omitempty"`
 	BaseRole    *string  `json:"base_role,omitempty"`
@@ -93,7 +108,7 @@ func (s *OrganizationsService) ListRoles(ctx context.Context, org string) (*Orga
 // GitHub API docs: https://docs.github.com/rest/orgs/organization-roles#create-a-custom-organization-role
 //
 //meta:operation POST /orgs/{org}/organization-roles
-func (s *OrganizationsService) CreateCustomOrgRole(ctx context.Context, org string, opts *CreateOrUpdateOrgRoleOptions) (*CustomOrgRoles, *Response, error) {
+func (s *OrganizationsService) CreateCustomOrgRole(ctx context.Context, org string, opts *CreateOrgRoleOptions) (*CustomOrgRoles, *Response, error) {
 	u := fmt.Sprintf("orgs/%v/organization-roles", org)
 
 	req, err := s.client.NewRequest("POST", u, opts)
@@ -116,7 +131,7 @@ func (s *OrganizationsService) CreateCustomOrgRole(ctx context.Context, org stri
 // GitHub API docs: https://docs.github.com/rest/orgs/organization-roles#update-a-custom-organization-role
 //
 //meta:operation PATCH /orgs/{org}/organization-roles/{role_id}
-func (s *OrganizationsService) UpdateCustomOrgRole(ctx context.Context, org string, roleID int64, opts *CreateOrUpdateOrgRoleOptions) (*CustomOrgRoles, *Response, error) {
+func (s *OrganizationsService) UpdateCustomOrgRole(ctx context.Context, org string, roleID int64, opts *UpdateOrgRoleOptions) (*CustomOrgRoles, *Response, error) {
 	u := fmt.Sprintf("orgs/%v/organization-roles/%v", org, roleID)
 
 	req, err := s.client.NewRequest("PATCH", u, opts)
@@ -185,7 +200,7 @@ func (s *OrganizationsService) ListCustomRepoRoles(ctx context.Context, org stri
 // GitHub API docs: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#create-a-custom-repository-role
 //
 //meta:operation POST /orgs/{org}/custom-repository-roles
-func (s *OrganizationsService) CreateCustomRepoRole(ctx context.Context, org string, opts *CreateOrUpdateCustomRepoRoleOptions) (*CustomRepoRoles, *Response, error) {
+func (s *OrganizationsService) CreateCustomRepoRole(ctx context.Context, org string, opts *CreateCustomRepoRoleOptions) (*CustomRepoRoles, *Response, error) {
 	u := fmt.Sprintf("orgs/%v/custom-repository-roles", org)
 
 	req, err := s.client.NewRequest("POST", u, opts)
@@ -208,7 +223,7 @@ func (s *OrganizationsService) CreateCustomRepoRole(ctx context.Context, org str
 // GitHub API docs: https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-roles#update-a-custom-repository-role
 //
 //meta:operation PATCH /orgs/{org}/custom-repository-roles/{role_id}
-func (s *OrganizationsService) UpdateCustomRepoRole(ctx context.Context, org string, roleID int64, opts *CreateOrUpdateCustomRepoRoleOptions) (*CustomRepoRoles, *Response, error) {
+func (s *OrganizationsService) UpdateCustomRepoRole(ctx context.Context, org string, roleID int64, opts *UpdateCustomRepoRoleOptions) (*CustomRepoRoles, *Response, error) {
 	u := fmt.Sprintf("orgs/%v/custom-repository-roles/%v", org, roleID)
 
 	req, err := s.client.NewRequest("PATCH", u, opts)

diff --git a/github/orgs_custom_roles_test.go b/github/orgs_custom_roles_test.go
@@ -109,7 +109,7 @@ func TestOrganizationsService_CreateCustomOrgRole(t *testing.T) {
 
 	ctx := context.Background()
 
-	opts := &CreateOrUpdateOrgRoleOptions{
+	opts := &CreateOrgRoleOptions{
 		Name:        String("Reader"),
 		Description: String("A role for reading custom org roles"),
 		Permissions: []string{"read_organization_custom_org_role"},
@@ -151,7 +151,7 @@ func TestOrganizationsService_UpdateCustomOrgRole(t *testing.T) {
 
 	ctx := context.Background()
 
-	opts := &CreateOrUpdateOrgRoleOptions{
+	opts := &UpdateOrgRoleOptions{
 		Name:        String("Updated Name"),
 		Description: String("Updated Description"),
 	}
@@ -304,7 +304,7 @@ func TestOrganizationsService_CreateCustomRepoRole(t *testing.T) {
 
 	ctx := context.Background()
 
-	opts := &CreateOrUpdateCustomRepoRoleOptions{
+	opts := &CreateCustomRepoRoleOptions{
 		Name:        String("Labeler"),
 		Description: String("A role for issue and PR labelers"),
 		BaseRole:    String("read"),
@@ -347,7 +347,7 @@ func TestOrganizationsService_UpdateCustomRepoRole(t *testing.T) {
 
 	ctx := context.Background()
 
-	opts := &CreateOrUpdateCustomRepoRoleOptions{
+	opts := &UpdateCustomRepoRoleOptions{
 		Name:        String("Updated Name"),
 		Description: String("Updated Description"),
 	}