fix: pass required params by value, per org/enterprise pagination options, rename get to list

Author: tim-goto

github/enterprise_codesecurity_configurations.go

@@ -11,12 +11,31 @@ import (
 	"net/http"
 )
 
-// GetCodeSecurityConfigurations lists all code security configurations available in an enterprise.
+// ListEnterpriseCodeSecurityConfigurationOptions specifies optional parameters to get security configurations for enterprises.
+//
+// Note: Pagination is powered by before/after cursor-style pagination. After the initial call,
+// inspect the returned *Response. Use resp.After as the opts.After value to request
+// the next page, and resp.Before as the opts.Before value to request the previous
+// page. Set either Before or After for a request; if both are
+// supplied GitHub API will return an error. PerPage controls the number of items
+// per page (max 100 per GitHub API docs).
+type ListEnterpriseCodeSecurityConfigurationOptions struct {
+	// A cursor, as given in the Link header. If specified, the query only searches for security configurations before this cursor.
+	Before *string `url:"before,omitempty"`
+
+	// A cursor, as given in the Link header. If specified, the query only searches for security configurations after this cursor.
+	After *string `url:"after,omitempty"`
+
+	// For paginated result sets, the number of results to include per page.
+	PerPage *int `url:"per_page,omitempty"`
+}
+
+// ListCodeSecurityConfigurations lists all code security configurations available in an enterprise.
 //
 // GitHub API docs: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-enterprise
 //
 //meta:operation GET /enterprises/{enterprise}/code-security/configurations
-func (s *EnterpriseService) GetCodeSecurityConfigurations(ctx context.Context, enterprise string, opts *GetCodeSecurityConfigurationOptions) ([]*CodeSecurityConfiguration, *Response, error) {
+func (s *EnterpriseService) ListCodeSecurityConfigurations(ctx context.Context, enterprise string, opts *ListEnterpriseCodeSecurityConfigurationOptions) ([]*CodeSecurityConfiguration, *Response, error) {
 	u := fmt.Sprintf("enterprises/%v/code-security/configurations", enterprise)
 	u, err := addOptions(u, opts)
 	if err != nil {
@@ -41,7 +60,7 @@ func (s *EnterpriseService) GetCodeSecurityConfigurations(ctx context.Context, e
 // GitHub API docs: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration-for-an-enterprise
 //
 //meta:operation POST /enterprises/{enterprise}/code-security/configurations
-func (s *EnterpriseService) CreateCodeSecurityConfiguration(ctx context.Context, enterprise string, config *CodeSecurityConfiguration) (*CodeSecurityConfiguration, *Response, error) {
+func (s *EnterpriseService) CreateCodeSecurityConfiguration(ctx context.Context, enterprise string, config CodeSecurityConfiguration) (*CodeSecurityConfiguration, *Response, error) {
 	u := fmt.Sprintf("enterprises/%v/code-security/configurations", enterprise)
 
 	req, err := s.client.NewRequest("POST", u, config)
@@ -78,12 +97,12 @@ func (s *EnterpriseService) GetDefaultCodeSecurityConfigurations(ctx context.Con
 	return configurations, resp, nil
 }
 
-// GetCodeSecurityConfiguration gets a code security configuration available in an enterprise.
+// ListCodeSecurityConfiguration gets a code security configuration available in an enterprise.
 //
 // GitHub API docs: https://docs.github.com/rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise
 //
 //meta:operation GET /enterprises/{enterprise}/code-security/configurations/{configuration_id}
-func (s *EnterpriseService) GetCodeSecurityConfiguration(ctx context.Context, enterprise string, id int64) (*CodeSecurityConfiguration, *Response, error) {
+func (s *EnterpriseService) ListCodeSecurityConfiguration(ctx context.Context, enterprise string, id int64) (*CodeSecurityConfiguration, *Response, error) {
 	u := fmt.Sprintf("enterprises/%v/code-security/configurations/%v", enterprise, id)
 
 	req, err := s.client.NewRequest("GET", u, nil)
@@ -104,7 +123,7 @@ func (s *EnterpriseService) GetCodeSecurityConfiguration(ctx context.Context, en
 // GitHub API docs: https://docs.github.com/rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise
 //
 //meta:operation PATCH /enterprises/{enterprise}/code-security/configurations/{configuration_id}
-func (s *EnterpriseService) UpdateCodeSecurityConfiguration(ctx context.Context, enterprise string, id int64, config *CodeSecurityConfiguration) (*CodeSecurityConfiguration, *Response, error) {
+func (s *EnterpriseService) UpdateCodeSecurityConfiguration(ctx context.Context, enterprise string, id int64, config CodeSecurityConfiguration) (*CodeSecurityConfiguration, *Response, error) {
 	u := fmt.Sprintf("enterprises/%v/code-security/configurations/%v", enterprise, id)
 
 	req, err := s.client.NewRequest("PATCH", u, config)

github/enterprise_codesecurity_configurations_test.go

@@ -14,9 +14,9 @@ import (
 	"github.com/google/go-cmp/cmp"
 )
 
-func TestEnterpriseService_GetCodeSecurityConfigurations(t *testing.T) {
+func TestEnterpriseService_ListCodeSecurityConfigurations(t *testing.T) {
 	t.Parallel()
-	opts := &GetCodeSecurityConfigurationOptions{Before: Ptr("1"), After: Ptr("2"), PerPage: Ptr(30)}
+	opts := &ListEnterpriseCodeSecurityConfigurationOptions{Before: Ptr("1"), After: Ptr("2"), PerPage: Ptr(30)}
 	ctx := t.Context()
 	client, mux, _ := setup(t)
 
@@ -38,33 +38,33 @@ func TestEnterpriseService_GetCodeSecurityConfigurations(t *testing.T) {
 		}]`)
 	})
 
-	configurations, _, err := client.Enterprise.GetCodeSecurityConfigurations(ctx, "e", opts)
+	configurations, _, err := client.Enterprise.ListCodeSecurityConfigurations(ctx, "e", opts)
 	if err != nil {
-		t.Errorf("Enterprise.GetCodeSecurityConfigurations returned error: %v", err)
+		t.Errorf("Enterprise.ListCodeSecurityConfigurations returned error: %v", err)
 	}
 
 	want := []*CodeSecurityConfiguration{
 		{ID: Ptr(int64(1)), Name: "config1", Description: "desc1", CodeScanningDefaultSetup: Ptr("enabled")},
 		{ID: Ptr(int64(2)), Name: "config2", Description: "desc2", PrivateVulnerabilityReporting: Ptr("enabled")},
 	}
 	if !cmp.Equal(configurations, want) {
-		t.Errorf("Enterprise.GetCodeSecurityConfigurations returned %+v, want %+v", configurations, want)
+		t.Errorf("Enterprise.ListCodeSecurityConfigurations returned %+v, want %+v", configurations, want)
 	}
-	const methodName = "GetCodeSecurityConfigurations"
+	const methodName = "ListCodeSecurityConfigurations"
 	testBadOptions(t, methodName, func() (err error) {
-		_, _, err = client.Enterprise.GetCodeSecurityConfigurations(ctx, "\n", opts)
+		_, _, err = client.Enterprise.ListCodeSecurityConfigurations(ctx, "\n", opts)
 		return err
 	})
 	testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
-		got, resp, err := client.Enterprise.GetCodeSecurityConfigurations(ctx, "e", opts)
+		got, resp, err := client.Enterprise.ListCodeSecurityConfigurations(ctx, "e", opts)
 		if got != nil {
 			t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
 		}
 		return resp, err
 	})
 }
 
-func TestEnterpriseService_GetCodeSecurityConfiguration(t *testing.T) {
+func TestEnterpriseService_ListCodeSecurityConfiguration(t *testing.T) {
 	t.Parallel()
 	client, mux, _ := setup(t)
 	ctx := t.Context()
@@ -79,24 +79,24 @@ func TestEnterpriseService_GetCodeSecurityConfiguration(t *testing.T) {
 		}`)
 	})
 
-	configuration, _, err := client.Enterprise.GetCodeSecurityConfiguration(ctx, "e", 1)
+	configuration, _, err := client.Enterprise.ListCodeSecurityConfiguration(ctx, "e", 1)
 	if err != nil {
-		t.Errorf("Enterprise.GetCodeSecurityConfiguration returned error: %v", err)
+		t.Errorf("Enterprise.ListCodeSecurityConfiguration returned error: %v", err)
 	}
 
 	want := &CodeSecurityConfiguration{ID: Ptr(int64(1)), Name: "config1", Description: "desc1", CodeScanningDefaultSetup: Ptr("enabled")}
 	if !cmp.Equal(configuration, want) {
-		t.Errorf("Enterprise.GetCodeSecurityConfiguration returned %+v, want %+v", configuration, want)
+		t.Errorf("Enterprise.ListCodeSecurityConfiguration returned %+v, want %+v", configuration, want)
 	}
 
-	const methodName = "GetCodeSecurityConfiguration"
+	const methodName = "ListCodeSecurityConfiguration"
 	testBadOptions(t, methodName, func() (err error) {
-		_, _, err = client.Enterprise.GetCodeSecurityConfiguration(ctx, "\n", -1)
+		_, _, err = client.Enterprise.ListCodeSecurityConfiguration(ctx, "\n", -1)
 		return err
 	})
 
 	testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
-		got, resp, err := client.Enterprise.GetCodeSecurityConfiguration(ctx, "e", 1)
+		got, resp, err := client.Enterprise.ListCodeSecurityConfiguration(ctx, "e", 1)
 		if got != nil {
 			t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
 		}
@@ -109,15 +109,15 @@ func TestEnterpriseService_CreateCodeSecurityConfiguration(t *testing.T) {
 	client, mux, _ := setup(t)
 	ctx := t.Context()
 
-	input := &CodeSecurityConfiguration{
+	input := CodeSecurityConfiguration{
 		Name:                     "config1",
 		Description:              "desc1",
 		CodeScanningDefaultSetup: Ptr("enabled"),
 	}
 
 	mux.HandleFunc("/enterprises/e/code-security/configurations", func(w http.ResponseWriter, r *http.Request) {
-		v := new(CodeSecurityConfiguration)
-		assertNilError(t, json.NewDecoder(r.Body).Decode(v))
+		var v CodeSecurityConfiguration
+		assertNilError(t, json.NewDecoder(r.Body).Decode(&v))
 
 		if !cmp.Equal(v, input) {
 			t.Errorf("Enterprise.CreateCodeSecurityConfiguration request body = %+v, want %+v", v, input)
@@ -218,15 +218,15 @@ func TestEnterpriseService_UpdateCodeSecurityConfiguration(t *testing.T) {
 	ctx := t.Context()
 	client, mux, _ := setup(t)
 
-	input := &CodeSecurityConfiguration{
+	input := CodeSecurityConfiguration{
 		Name:                     "config1",
 		Description:              "desc1",
 		CodeScanningDefaultSetup: Ptr("enabled"),
 	}
 
 	mux.HandleFunc("/enterprises/e/code-security/configurations/1", func(w http.ResponseWriter, r *http.Request) {
-		v := new(CodeSecurityConfiguration)
-		assertNilError(t, json.NewDecoder(r.Body).Decode(v))
+		var v CodeSecurityConfiguration
+		assertNilError(t, json.NewDecoder(r.Body).Decode(&v))
 
 		if !cmp.Equal(v, input) {
 			t.Errorf("Enterprise.UpdateCodeSecurityConfiguration request body = %+v, want %+v", v, input)