Skip to content

Missing "endpoints" and "permissions" documentation for REST API endpoints for teams #33635

Closed
@tonglil

Description

@tonglil

Code of Conduct

What article on docs.github.com is affected?

For the endpoints and permissions specified in REST API endpoints for teams (https://docs.github.com/en/rest/teams/teams?apiVersion=2022-11-28#add-or-update-team-repository-permissions), they are not documented on the following pages:

For example, if you search for the (i guess older?) endpoints that contain {team_slug} and some others:

/orgs/{org}/teams/{team_slug}
/orgs/{org}/teams/{team_slug}/projects
/orgs/{org}/teams/{team_slug}/projects/{project_id}
/orgs/{org}/teams/{team_slug}/repos
/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}
/orgs/{org}/teams/{team_slug}/teams
/user/teams

They do not appear on those pages.

What changes are you suggesting?

Document them, because some of them work with Fine-grained personal access tokens and some don't, and some work with GitHub App installation access tokens and some don't.

It's really confusing because crucially the ability to create a repo and assign a team with admin permission to it is only seemingly available through PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo} with personal access tokens (classic and fine-grained), but not available to a GitHub App installed in an organization, which seems like a big gap and an issue for organizations that restrict access with PATs and want to automate actions on GitHub through GitHub Apps.

Furthermore, creating a new repo with the team_id only grants that team read access, which is not useful (see: github/rest-api-description#3689).

Overall it seems like this aspect of the documentation has been neglected.

Additional information

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content teamfix-internallyTriggers a workflow to copy the issue internally and close the current issuerestContent related to rest - overview.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions