Add support for `assignment` on teams and users assigned to organization roles

[stevehipwell]

When listing teams or users assigned to an organization role the assigned assignment field isn't getting set and the team parent and user inherited_from are also not getting set. I assume that this is because these endpoints are being mapped back to Team and User structs instead of being a custom type.

[gmlewis]

I'm assuming you are talking about these endpoints:

• go-github/github/orgs_organization_roles.go

  Lines 243 to 268 in c6856bc

  	// ListTeamsAssignedToOrgRole returns all teams assigned to a specific organization role.
  	// In order to list teams assigned to an organization role, the authenticated user must be an organization owner.
  	//
  	// GitHub API docs: https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role
  	//
  	//meta:operation GET /orgs/{org}/organization-roles/{role_id}/teams
  	func (s *OrganizationsService) ListTeamsAssignedToOrgRole(ctx context.Context, org string, roleID int64, opts *ListOptions) ([]*Team, *Response, error) {
  	u := fmt.Sprintf("orgs/%v/organization-roles/%v/teams", org, roleID)
  	u, err := addOptions(u, opts)
  	if err != nil {
  	return nil, nil, err
  	}
  	req, err := s.client.NewRequest("GET", u, nil)
  	if err != nil {
  	return nil, nil, err
  	}
  	var teams []*Team
  	resp, err := s.client.Do(ctx, req, &teams)
  	if err != nil {
  	return nil, resp, err
  	}
  	return teams, resp, nil
  	}

• go-github/github/orgs_organization_roles.go

  Lines 270 to 295 in c6856bc

  	// ListUsersAssignedToOrgRole returns all users assigned to a specific organization role.
  	// In order to list users assigned to an organization role, the authenticated user must be an organization owner.
  	//
  	// GitHub API docs: https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role
  	//
  	//meta:operation GET /orgs/{org}/organization-roles/{role_id}/users
  	func (s *OrganizationsService) ListUsersAssignedToOrgRole(ctx context.Context, org string, roleID int64, opts *ListOptions) ([]*User, *Response, error) {
  	u := fmt.Sprintf("orgs/%v/organization-roles/%v/users", org, roleID)
  	u, err := addOptions(u, opts)
  	if err != nil {
  	return nil, nil, err
  	}
  	req, err := s.client.NewRequest("GET", u, nil)
  	if err != nil {
  	return nil, nil, err
  	}
  	var users []*User
  	resp, err := s.client.Do(ctx, req, &users)
  	if err != nil {
  	return nil, resp, err
  	}
  	return users, resp, nil
  	}

which correspond with these official docs:

• https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role
• https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role

and I'm not seeing any mention of a field called assigned.

Therefore, could you please be a bit more specific about which exact endpoints you are talking about and where in the documentation it documents the returned field called assigned?

[stevehipwell]

@gmlewis thanks for the quick response, those are the endpoints. Sorry I typoed the issue (but not the title), it's assignment. The schema for both of the endpoints you linked above have it defined but it's not present in the examples.

I may be incorrect about the team parent not being correctly set here as the logic to use it is dependent on assignment.

[gmlewis]

Excellent, thank you for the clarification, @stevehipwell ! I see it now in the schema definitions.

Would you like to submit a PR to add a new Assignment field to both User and Team, or would you like me to do this?

It should most likely look like this:

Assignment *string `json:"assignment,omitempty"`

[stevehipwell]

@gmlewis would you just append it to Team and User rather than create a new type? I'm not completely up to speed on this package as I've come from the GitHub TF provider. I'm very happy to pick up the implementation of this though.

[gmlewis]

Yes, I would add the new field to the end of the User and Team structs in their corresponding Go files, with a comment as to why this field is being added.

Something like // Assignment is populated by the ListUsersAssignedToOrgRole method. Its possible values are: "direct", "indirect", "mixed". I would also add a blank line before this (at the very end of the struct) to separate it out from the "normal" usage.

Awesome, it is yours. Thank you, @stevehipwell !