-
Notifications
You must be signed in to change notification settings - Fork 2.2k
feat: Add support for Enterprise Team APIs #3861
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.
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
Open
Not-Dhananjay-Mishra
wants to merge
2
commits into
google:master
Choose a base branch
from
Not-Dhananjay-Mishra:issue-3860-part1
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+463
−0
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| // Copyright 2025 The go-github AUTHORS. All rights reserved. | ||
| // | ||
| // Use of this source code is governed by a BSD-style | ||
| // license that can be found in the LICENSE file. | ||
|
|
||
| package github | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| ) | ||
|
|
||
| // EnterpriseTeam represent a team in a GitHub Enterprise. | ||
| type EnterpriseTeam struct { | ||
| ID int64 `json:"id"` | ||
| URL string `json:"url"` | ||
| MemberURL string `json:"member_url"` | ||
| Name string `json:"name"` | ||
| HTMLURL string `json:"html_url"` | ||
| Slug string `json:"slug"` | ||
| CreatedAt Timestamp `json:"created_at"` | ||
| UpdatedAt Timestamp `json:"updated_at"` | ||
| GroupID int64 `json:"group_id"` | ||
| OrganizationSelectionType *string `json:"organization_selection_type,omitempty"` | ||
| } | ||
|
|
||
| // EnterpriseTeamCreateOrUpdateRequest is used to create or update an enterprise team. | ||
| type EnterpriseTeamCreateOrUpdateRequest struct { | ||
| // The name of the team. | ||
| Name string `json:"name"` | ||
| // A description of the team. | ||
| Description *string `json:"description,omitempty"` | ||
| // Specifies which organizations in the enterprise should have access to this team. | ||
| // Possible values are "disabled" , "all" and "selected". If not specified, the default is "disabled". | ||
| OrganizationSelectionType *string `json:"organization_selection_type,omitempty"` | ||
| // The ID of the IdP group to assign team membership with. | ||
| GroupID *int64 `json:"group_id,omitempty"` | ||
| } | ||
|
|
||
| // ListTeams lists all teams in an enterprise. | ||
| // | ||
| // GitHub API docs: https://docs.github.com/rest/enterprise-teams/enterprise-teams#list-enterprise-teams | ||
| // | ||
| //meta:operation GET /enterprises/{enterprise}/teams | ||
| func (s *EnterpriseService) ListTeams(ctx context.Context, enterprise string, opt *ListOptions) ([]*EnterpriseTeam, *Response, error) { | ||
| u := fmt.Sprintf("enterprises/%v/teams", enterprise) | ||
| u, err := addOptions(u, opt) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
|
|
||
| req, err := s.client.NewRequest("GET", u, nil) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
|
|
||
| var teams []*EnterpriseTeam | ||
| resp, err := s.client.Do(ctx, req, &teams) | ||
| if err != nil { | ||
| return nil, resp, err | ||
| } | ||
|
|
||
| return teams, resp, nil | ||
| } | ||
|
|
||
| // CreateTeam creates a new team in an enterprise. | ||
| // | ||
| // GitHub API docs: https://docs.github.com/rest/enterprise-teams/enterprise-teams#create-an-enterprise-team | ||
| // | ||
| //meta:operation POST /enterprises/{enterprise}/teams | ||
| func (s *EnterpriseService) CreateTeam(ctx context.Context, enterprise string, team EnterpriseTeamCreateOrUpdateRequest) (*EnterpriseTeam, *Response, error) { | ||
| u := fmt.Sprintf("enterprises/%v/teams", enterprise) | ||
|
|
||
| req, err := s.client.NewRequest("POST", u, team) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
|
|
||
| var createdTeam *EnterpriseTeam | ||
| resp, err := s.client.Do(ctx, req, &createdTeam) | ||
| if err != nil { | ||
| return nil, resp, err | ||
| } | ||
|
|
||
| return createdTeam, resp, nil | ||
| } | ||
|
|
||
| // GetTeam retrieves a team in an enterprise. | ||
| // | ||
| // GitHub API docs: https://docs.github.com/rest/enterprise-teams/enterprise-teams#get-an-enterprise-team | ||
| // | ||
| //meta:operation GET /enterprises/{enterprise}/teams/{team_slug} | ||
| func (s *EnterpriseService) GetTeam(ctx context.Context, enterprise, teamSlug string) (*EnterpriseTeam, *Response, error) { | ||
| u := fmt.Sprintf("enterprises/%v/teams/%v", enterprise, teamSlug) | ||
|
|
||
| req, err := s.client.NewRequest("GET", u, nil) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
|
|
||
| var team *EnterpriseTeam | ||
| resp, err := s.client.Do(ctx, req, &team) | ||
| if err != nil { | ||
| return nil, resp, err | ||
| } | ||
|
|
||
| return team, resp, nil | ||
| } | ||
|
|
||
| // UpdateTeam updates a team in an enterprise. | ||
| // | ||
| // GitHub API docs: https://docs.github.com/rest/enterprise-teams/enterprise-teams#update-an-enterprise-team | ||
| // | ||
| //meta:operation PATCH /enterprises/{enterprise}/teams/{team_slug} | ||
| func (s *EnterpriseService) UpdateTeam(ctx context.Context, enterprise, teamSlug string, team EnterpriseTeamCreateOrUpdateRequest) (*EnterpriseTeam, *Response, error) { | ||
| u := fmt.Sprintf("enterprises/%v/teams/%v", enterprise, teamSlug) | ||
|
|
||
| req, err := s.client.NewRequest("PATCH", u, team) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
|
|
||
| var updatedTeam *EnterpriseTeam | ||
| resp, err := s.client.Do(ctx, req, &updatedTeam) | ||
| if err != nil { | ||
| return nil, resp, err | ||
| } | ||
|
|
||
| return updatedTeam, resp, nil | ||
| } | ||
|
|
||
| // DeleteTeam deletes a team in an enterprise. | ||
| // | ||
| // GitHub API docs: https://docs.github.com/rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team | ||
| // | ||
| //meta:operation DELETE /enterprises/{enterprise}/teams/{team_slug} | ||
| func (s *EnterpriseService) DeleteTeam(ctx context.Context, enterprise, teamSlug string) (*Response, error) { | ||
| u := fmt.Sprintf("enterprises/%v/teams/%v", enterprise, teamSlug) | ||
|
|
||
| req, err := s.client.NewRequest("DELETE", u, nil) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| resp, err := s.client.Do(ctx, req, nil) | ||
| if err != nil { | ||
| return resp, err | ||
| } | ||
|
|
||
| return resp, nil | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,236 @@ | ||
| // Copyright 2025 The go-github AUTHORS. All rights reserved. | ||
| // | ||
| // Use of this source code is governed by a BSD-style | ||
| // license that can be found in the LICENSE file. | ||
|
|
||
| package github | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "net/http" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/google/go-cmp/cmp" | ||
| ) | ||
|
|
||
| func TestEnterpriseService_ListTeams(t *testing.T) { | ||
| t.Parallel() | ||
| client, mux, _ := setup(t) | ||
|
|
||
| mux.HandleFunc("/enterprises/e/teams", func(w http.ResponseWriter, r *http.Request) { | ||
| testMethod(t, r, "GET") | ||
| fmt.Fprint(w, `[{ | ||
| "id": 1, | ||
| "url": "https://example.com/team1", | ||
| "member_url": "https://example.com/members", | ||
| "name": "Team One", | ||
| "html_url": "https://example.com/html", | ||
| "slug": "team-one", | ||
| "created_at": "2020-01-01T00:00:00Z", | ||
| "updated_at": "2020-01-02T00:00:00Z", | ||
| "group_id": 99 | ||
| }]`) | ||
| }) | ||
|
|
||
| ctx := t.Context() | ||
| opts := &ListOptions{Page: 1, PerPage: 10} | ||
| got, _, err := client.Enterprise.ListTeams(ctx, "e", opts) | ||
| if err != nil { | ||
| t.Fatalf("Enterprise.ListTeams returned error: %v", err) | ||
| } | ||
|
|
||
| want := []*EnterpriseTeam{ | ||
| { | ||
| ID: 1, | ||
| URL: "https://example.com/team1", | ||
| MemberURL: "https://example.com/members", | ||
| Name: "Team One", | ||
| HTMLURL: "https://example.com/html", | ||
| Slug: "team-one", | ||
| GroupID: 99, | ||
| CreatedAt: Timestamp{Time: time.Date(2020, time.January, 1, 0, 0, 0, 0, time.UTC)}, | ||
| UpdatedAt: Timestamp{Time: time.Date(2020, time.January, 2, 0, 0, 0, 0, time.UTC)}, | ||
| }, | ||
| } | ||
|
|
||
| if !cmp.Equal(got, want) { | ||
| t.Errorf("Enterprise.ListTeams = %+v, want %+v", got, want) | ||
| } | ||
|
|
||
| const methodName = "ListTeams" | ||
| testBadOptions(t, methodName, func() error { | ||
| _, _, err := client.Enterprise.ListTeams(ctx, "\n", opts) | ||
| return err | ||
| }) | ||
|
|
||
| testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) { | ||
| got, resp, err := client.Enterprise.ListTeams(ctx, "e", opts) | ||
| if got != nil { | ||
| t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got) | ||
| } | ||
| return resp, err | ||
| }) | ||
| } | ||
|
|
||
| func TestEnterpriseService_CreateTeam(t *testing.T) { | ||
| t.Parallel() | ||
| client, mux, _ := setup(t) | ||
|
|
||
| input := EnterpriseTeamCreateOrUpdateRequest{ | ||
| Name: "New Team", | ||
| } | ||
|
|
||
| mux.HandleFunc("/enterprises/e/teams", func(w http.ResponseWriter, r *http.Request) { | ||
| testMethod(t, r, "POST") | ||
| testBody(t, r, `{"name":"New Team"}`+"\n") | ||
| fmt.Fprint(w, `{ | ||
| "id": 10, | ||
| "name": "New Team", | ||
| "slug": "new-team", | ||
| "url": "https://example.com/team" | ||
| }`) | ||
| }) | ||
|
|
||
| ctx := t.Context() | ||
| got, _, err := client.Enterprise.CreateTeam(ctx, "e", input) | ||
| if err != nil { | ||
| t.Fatalf("Enterprise.CreateTeam returned error: %v", err) | ||
| } | ||
|
|
||
| want := &EnterpriseTeam{ | ||
| ID: 10, | ||
| Name: "New Team", | ||
| Slug: "new-team", | ||
| URL: "https://example.com/team", | ||
| } | ||
|
|
||
| if !cmp.Equal(got, want) { | ||
| t.Errorf("Enterprise.CreateTeam = %+v, want %+v", got, want) | ||
| } | ||
|
|
||
| const methodName = "CreateTeam" | ||
| testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) { | ||
| got, resp, err := client.Enterprise.CreateTeam(ctx, "e", input) | ||
| if got != nil { | ||
| t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got) | ||
| } | ||
| return resp, err | ||
| }) | ||
| } | ||
|
|
||
| func TestEnterpriseService_GetTeam(t *testing.T) { | ||
| t.Parallel() | ||
| client, mux, _ := setup(t) | ||
|
|
||
| mux.HandleFunc("/enterprises/e/teams/t1", func(w http.ResponseWriter, r *http.Request) { | ||
| testMethod(t, r, "GET") | ||
| fmt.Fprint(w, `{ | ||
| "id": 2, | ||
| "name": "Team One", | ||
| "slug": "t1" | ||
| }`) | ||
| }) | ||
|
|
||
| ctx := t.Context() | ||
| got, _, err := client.Enterprise.GetTeam(ctx, "e", "t1") | ||
| if err != nil { | ||
| t.Fatalf("Enterprise.GetTeam returned error: %v", err) | ||
| } | ||
|
|
||
| want := &EnterpriseTeam{ | ||
| ID: 2, | ||
| Name: "Team One", | ||
| Slug: "t1", | ||
| } | ||
|
|
||
| if !cmp.Equal(got, want) { | ||
| t.Errorf("Enterprise.GetTeam = %+v, want %+v", got, want) | ||
| } | ||
|
|
||
| const methodName = "GetTeam" | ||
| testBadOptions(t, methodName, func() error { | ||
| _, _, err := client.Enterprise.GetTeam(ctx, "\n", "t1") | ||
| return err | ||
| }) | ||
| testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) { | ||
| got, resp, err := client.Enterprise.GetTeam(ctx, "e", "t1") | ||
| if got != nil { | ||
| t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got) | ||
| } | ||
| return resp, err | ||
| }) | ||
| } | ||
|
|
||
| func TestEnterpriseService_UpdateTeam(t *testing.T) { | ||
| t.Parallel() | ||
| client, mux, _ := setup(t) | ||
|
|
||
| input := EnterpriseTeamCreateOrUpdateRequest{ | ||
| Name: "Updated Team", | ||
| } | ||
|
|
||
| mux.HandleFunc("/enterprises/e/teams/t1", func(w http.ResponseWriter, r *http.Request) { | ||
| testMethod(t, r, "PATCH") | ||
| testBody(t, r, `{"name":"Updated Team"}`+"\n") | ||
| fmt.Fprint(w, `{ | ||
| "id": 3, | ||
| "name": "Updated Team", | ||
| "slug": "t1" | ||
| }`) | ||
| }) | ||
|
|
||
| ctx := t.Context() | ||
| got, _, err := client.Enterprise.UpdateTeam(ctx, "e", "t1", input) | ||
| if err != nil { | ||
| t.Fatalf("Enterprise.UpdateTeam returned error: %v", err) | ||
| } | ||
|
|
||
| want := &EnterpriseTeam{ | ||
| ID: 3, | ||
| Name: "Updated Team", | ||
| Slug: "t1", | ||
| } | ||
|
|
||
| if !cmp.Equal(got, want) { | ||
| t.Errorf("Enterprise.UpdateTeam = %+v, want %+v", got, want) | ||
| } | ||
|
|
||
| const methodName = "UpdateTeam" | ||
| testBadOptions(t, methodName, func() error { | ||
| _, _, err := client.Enterprise.UpdateTeam(ctx, "\n", "t1", input) | ||
| return err | ||
| }) | ||
| testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) { | ||
| got, resp, err := client.Enterprise.UpdateTeam(ctx, "e", "t1", input) | ||
| if got != nil { | ||
| t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got) | ||
| } | ||
| return resp, err | ||
| }) | ||
| } | ||
|
|
||
| func TestEnterpriseService_DeleteTeam(t *testing.T) { | ||
| t.Parallel() | ||
| client, mux, _ := setup(t) | ||
|
|
||
| mux.HandleFunc("/enterprises/e/teams/t1", func(w http.ResponseWriter, r *http.Request) { | ||
| testMethod(t, r, "DELETE") | ||
| w.WriteHeader(http.StatusNoContent) | ||
| }) | ||
|
|
||
| ctx := t.Context() | ||
| _, err := client.Enterprise.DeleteTeam(ctx, "e", "t1") | ||
| if err != nil { | ||
| t.Fatalf("Enterprise.DeleteTeam returned error: %v", err) | ||
| } | ||
|
|
||
| const methodName = "DeleteTeam" | ||
| testBadOptions(t, methodName, func() error { | ||
| _, err := client.Enterprise.DeleteTeam(ctx, "\n", "t1") | ||
| return err | ||
| }) | ||
| testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) { | ||
| return client.Enterprise.DeleteTeam(ctx, "e", "t1") | ||
| }) | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This request struct has one field,
sync_to_organizations, which isn’t added yet.Its description says “Retired” Should I add it or leave it out?
Similarly, the EnterpriseTeam has two fields,
sync_to_organizationsandgroup_name, which are marked as Retired.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, let's please not add a field that the GitHub official docs say is "Retired".