Skip to content

fix!: Change return type of GetDefaultCodeSecurityConfigurations #3747

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 2, 2025
Merged

fix!: Change return type of GetDefaultCodeSecurityConfigurations #3747

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fdb19ea
fix return type of GetDefaultCodeSecurityConfigurations
ericmort Oct 1, 2025
3208fce
Merge branch 'master' into fix/3744-change-get-default-security-retur…
ericmort Oct 2, 2025
d4efcfe
fix default_for_new_repos not allowed value in test
ericmort Oct 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions github/orgs_codesecurity_configurations.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,15 +106,15 @@ func (s *OrganizationsService) CreateCodeSecurityConfiguration(ctx context.Conte
// GitHub API docs: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations
//
//meta:operation GET /orgs/{org}/code-security/configurations/defaults
func (s *OrganizationsService) GetDefaultCodeSecurityConfigurations(ctx context.Context, org string) ([]*CodeSecurityConfiguration, *Response, error) {
func (s *OrganizationsService) GetDefaultCodeSecurityConfigurations(ctx context.Context, org string) ([]*CodeSecurityConfigurationWithDefaultForNewRepos, *Response, error) {
u := fmt.Sprintf("orgs/%v/code-security/configurations/defaults", org)

req, err := s.client.NewRequest("GET", u, nil)
if err != nil {
return nil, nil, err
}

var configurations []*CodeSecurityConfiguration
var configurations []*CodeSecurityConfigurationWithDefaultForNewRepos
resp, err := s.client.Do(ctx, req, &configurations)
if err != nil {
return nil, resp, err
Expand Down
27 changes: 17 additions & 10 deletions github/orgs_codesecurity_configurations_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,25 +159,32 @@ func TestOrganizationsService_GetDefaultCodeSecurityConfigurations(t *testing.T)
testMethod(t, r, "GET")
fmt.Fprint(w, `[
{
"id":1,
"name":"config1",
"code_scanning_default_setup": "enabled"
"default_for_new_repos": "public",
"configuration": {
"id":1,
"name":"config1",
"code_scanning_default_setup": "enabled"
}
},
{
"id":2,
"name":"config2",
"private_vulnerability_reporting": "enabled"
}]`)
"default_for_new_repos": "private",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

private is not an allowed value here. See https://docs.github.com/en/rest/code-security/configurations?apiVersion=2022-11-28#get-default-code-security-configurations

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good catch :) fixed in latest commit

"configuration": {
"id":2,
"name":"config2",
"private_vulnerability_reporting": "enabled"
}
}
]`)
})

configurations, _, err := client.Organizations.GetDefaultCodeSecurityConfigurations(ctx, "o")
if err != nil {
t.Errorf("Organizations.GetDefaultCodeSecurityConfigurations returned error: %v", err)
}

want := []*CodeSecurityConfiguration{
{ID: Ptr(int64(1)), Name: Ptr("config1"), CodeScanningDefaultSetup: Ptr("enabled")},
{ID: Ptr(int64(2)), Name: Ptr("config2"), PrivateVulnerabilityReporting: Ptr("enabled")},
want := []*CodeSecurityConfigurationWithDefaultForNewRepos{
{DefaultForNewRepos: Ptr("public"), Configuration: &CodeSecurityConfiguration{ID: Ptr(int64(1)), Name: Ptr("config1"), CodeScanningDefaultSetup: Ptr("enabled")}},
{DefaultForNewRepos: Ptr("private"), Configuration: &CodeSecurityConfiguration{ID: Ptr(int64(2)), Name: Ptr("config2"), PrivateVulnerabilityReporting: Ptr("enabled")}},
}
if !cmp.Equal(configurations, want) {
t.Errorf("Organizations.GetDefaultCodeSecurityConfigurations returned %+v, want %+v", configurations, want)
Expand Down