Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count in the response. For more details about your app's installations, see the \"List installations for the authenticated app\" endpoint.
You must use a JWT to access this endpoint.
", "responses": [ @@ -443,9 +439,7 @@ "slug": "list-installations-for-the-authenticated-app", "category": "apps", "categoryLabel": "Apps", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "You must use a JWT to access this endpoint.
\nThe permissions the installation has are included under the permissions key.
Enables an authenticated GitHub App to find an installation's information using the installation id. The installation's account type (target_type) will be either an organization or a user account, depending which account the repository belongs to.
You must use a JWT to access this endpoint.
", "responses": [ @@ -786,9 +778,7 @@ "slug": "create-an-installation-access-token-for-an-app", "category": "apps", "categoryLabel": "Apps", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of 401 - Unauthorized, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the repository_ids when creating the token. When you omit repository_ids, the response does not contain the repositories key.
You must use a JWT to access this endpoint.
", "responses": [ { @@ -2077,9 +2067,7 @@ "slug": "get-an-app", "category": "apps", "categoryLabel": "Apps", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: The :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).
If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a personal access token or an installation access token to access this endpoint.
", "responses": [ @@ -3237,9 +3225,7 @@ "slug": "get-all-codes-of-conduct", "category": "codes-of-conduct", "categoryLabel": "Codes of conduct", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -3315,9 +3301,7 @@ "slug": "get-a-code-of-conduct", "category": "codes-of-conduct", "categoryLabel": "Codes of conduct", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -3437,9 +3421,7 @@ "categoryLabel": "Apps", "subcategory": "installations", "subcategoryLabel": "Installations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id of the content reference from the content_reference event to create an attachment.
The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.
\nYou must use an installation access token to access this endpoint.
", "bodyParameters": [ { @@ -3541,9 +3523,7 @@ "slug": "get-emojis", "category": "emojis", "categoryLabel": "Emojis", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -6241,9 +6221,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -6308,9 +6286,7 @@ "categoryLabel": "Activity", "subcategory": "feeds", "subcategoryLabel": "Feeds", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "GitHub provides several timeline resources in Atom format. The Feeds API lists all the feeds available to the authenticated user:
\nNote: Private feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
", "responses": [ @@ -8241,9 +8217,7 @@ "slug": "get-all-gitignore-templates", "category": "gitignore", "categoryLabel": "Gitignore", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List all templates available to pass as an option when creating a repository.
", "responses": [ @@ -8307,9 +8281,7 @@ "slug": "get-a-gitignore-template", "category": "gitignore", "categoryLabel": "Gitignore", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "The API also allows fetching the source of a single template.\nUse the raw media type to get the raw contents.
", "responses": [ @@ -8393,9 +8365,7 @@ "categoryLabel": "Apps", "subcategory": "installations", "subcategoryLabel": "Installations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List repositories that an app installation can access.
\nYou must use an installation access token to access this endpoint.
", "responses": [ @@ -8461,9 +8431,7 @@ "categoryLabel": "Apps", "subcategory": "installations", "subcategoryLabel": "Installations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -8744,9 +8712,7 @@ "slug": "get-all-commonly-used-licenses", "category": "licenses", "categoryLabel": "Licenses", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -8810,9 +8776,7 @@ "slug": "get-a-license", "category": "licenses", "categoryLabel": "Licenses", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -8923,9 +8887,7 @@ "slug": "render-a-markdown-document", "category": "markdown", "categoryLabel": "Markdown", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -9026,9 +8988,7 @@ "slug": "render-a-markdown-document-in-raw-mode", "category": "markdown", "categoryLabel": "Markdown", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -9626,9 +9586,7 @@ "slug": "get-github-meta-information", "category": "meta", "categoryLabel": "Meta", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "This endpoint provides a list of GitHub's IP addresses. For more information, see \"About GitHub's IP addresses.\"
", "responses": [ @@ -9723,9 +9681,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -10463,9 +10419,7 @@ "slug": "get-octocat", "category": "meta", "categoryLabel": "Meta", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -10534,9 +10488,7 @@ "slug": "list-organizations", "category": "orgs", "categoryLabel": "Orgs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists all organizations, in the order that they were created on GitHub.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
To see many of the organization response values, you need to be an authenticated organization owner with the admin:org scope. When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.
GitHub Apps with the Organization plan permission can use this endpoint to retrieve information about an organization's GitHub plan. See \"Authenticating with GitHub Apps\" for details. For an example response, see 'Response with GitHub plan information' below.\"
Parameter Deprecation Notice: GitHub will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.
Enables an authenticated organization owner with the admin:org scope to update the organization's profile and member privileges.
Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"\"
You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"GitHub's products.\"
\nLists all self-hosted runner groups configured in an organization and inherited from an enterprise.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see \"GitHub's products.\"
\nCreates a new self-hosted runner group for an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"GitHub's products.\"
\nGets a specific self-hosted runner group for an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"GitHub's products.\"
\nUpdates the name and visibility of a self-hosted runner group in an organization.
You must authenticate using an access token with the admin:org scope to use this endpoint.
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see \"GitHub's products.\"
\nLists the repositories with access to a self-hosted runner group configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"GitHub's products.\"
\nLists self-hosted runners that are in a specific organization group.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Lists all self-hosted runners configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Returns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.
Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\nReturns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.
To remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\nGets a specific self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.
Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.
Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.
Lists all repositories that have been selected when the visibility for repository access to a secret is set to selected. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.
List the users blocked by an organization.
", "responses": [ @@ -14475,9 +14349,7 @@ "categoryLabel": "Orgs", "subcategory": "blocking", "subcategoryLabel": "Blocking", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -14551,9 +14423,7 @@ "categoryLabel": "Orgs", "subcategory": "blocking", "subcategoryLabel": "Blocking", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -14627,9 +14497,7 @@ "categoryLabel": "Orgs", "subcategory": "blocking", "subcategoryLabel": "Blocking", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -14687,9 +14555,7 @@ "slug": "list-saml-sso-authorizations-for-an-organization", "category": "orgs", "categoryLabel": "Orgs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see GitHub's products.
\nAn authenticated organization owner with the read:org scope can list all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see About authentication with SAML single sign-on.
Here's how you can create a hook that posts payloads in JSON format:
", "responses": [ { @@ -15452,9 +15310,7 @@ "categoryLabel": "Orgs", "subcategory": "webhooks", "subcategoryLabel": "Webhooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns a webhook configured in an organization. To get only the webhook config properties, see \"Get a webhook configuration for an organization.\"
Updates a webhook configured in an organization. When you update a webhook, the secret will be overwritten. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use \"Update a webhook configuration for an organization.\"
Returns the webhook configuration for an organization. To get more information about the webhook, including the active state and events, use \"Get an organization webhook .\"
Access tokens must have the admin:org_hook scope, and GitHub Apps must have the organization_hooks:read permission.
Updates the webhook configuration for an organization. To update more information about the webhook, including the active state and events, use \"Update an organization webhook .\"
Access tokens must have the admin:org_hook scope, and GitHub Apps must have the organization_hooks:write permission.
Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with admin:read scope to use this endpoint.
Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.
", "responses": [ @@ -16543,9 +16385,7 @@ "categoryLabel": "Interactions", "subcategory": "orgs", "subcategoryLabel": "Orgs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization.
", "bodyParameters": [ { @@ -16644,9 +16484,7 @@ "categoryLabel": "Interactions", "subcategory": "orgs", "subcategoryLabel": "Orgs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -16726,9 +16564,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub member, the login field in the return hash will be null.
Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -17008,9 +16842,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.
", "responses": [ @@ -17303,9 +17135,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.
", "responses": [ @@ -17385,9 +17215,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -17466,9 +17294,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -17542,9 +17368,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "In order to get a user's membership with an organization, the authenticated user must be an organization member.
", "responses": [ @@ -17661,9 +17485,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Only authenticated organization owners can add a member to the organization or update the member's role.
\npending until they accept the invitation.role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.Rate limits
\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
", "bodyParameters": [ { @@ -17764,9 +17586,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -18579,9 +18399,7 @@ "categoryLabel": "Orgs", "subcategory": "outside-collaborators", "subcategoryLabel": "Outside collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List all users who are outside collaborators of an organization.
", "responses": [ @@ -18651,9 +18469,7 @@ "categoryLabel": "Orgs", "subcategory": "outside-collaborators", "subcategoryLabel": "Outside collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\".
", "responses": [ @@ -18744,9 +18560,7 @@ "categoryLabel": "Orgs", "subcategory": "outside-collaborators", "subcategoryLabel": "Outside collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Removing a user from this list will remove them from all the organization's repositories.
", "responses": [ @@ -18853,9 +18667,7 @@ "slug": "list-organization-projects", "category": "projects", "categoryLabel": "Projects", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the projects in an organization. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Creates an organization project board. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Members of an organization can choose to have their membership publicized or not.
", "responses": [ @@ -19161,9 +18969,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -19452,9 +19258,7 @@ "slug": "list-organization-repositories", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists repositories for the specified organization.
", "responses": [ @@ -19718,9 +19522,7 @@ "slug": "create-an-organization-repository", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.
\nOAuth scope requirements
\nWhen using OAuth, authorizations must include:
\npublic_repo scope or repo scope to create a public repositoryrepo scope to create a private repositoryTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nList IdP groups available in an organization. You can limit your page results using the per_page parameter. GitHub generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see \"Offset and Cursor Pagination explained.\"
The per_page parameter provides pagination for a list of IdP groups the authenticated user can access in an organization. For example, if the user octocat wants to see two groups per page in octo-org via cURL, it would look like this:
Lists all teams in an organization that are visible to the authenticated user.
", "responses": [ @@ -20404,9 +20202,7 @@ "slug": "create-a-team", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "To create a team, the authenticated user must be a member or owner of {org}. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"Setting team creation permissions.\"
When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of maintainers. For more information, see \"About teams\".
Gets a team using the team's slug. GitHub generates the slug from the team name.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
To edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}.
List all discussions on a team's page. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.
Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nNote: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.
Get a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
List all comments on a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nNote: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
Get a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
Edits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with a Status: 200 OK means that you already added the reaction type to this team discussion comment.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub member, the login field in the return hash will be null.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/invitations.
Team members will include the members of child teams.
\nTo list members in a team, the team must be visible to the authenticated user.
", "responses": [ @@ -23034,9 +22790,7 @@ "categoryLabel": "Teams", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create a team.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nAdds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
\nNote: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub.\"
\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
\nNote: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}.
Lists the organization projects for a team.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects.
Checks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects/{project_id}.
Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.
Note: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}.
Lists a team's repositories visible to the authenticated user.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos.
Lists the child teams of the team specified by {team_slug}.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.
Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key.
Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
Gets a project by its id. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Updates a project board's information. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project admin to list collaborators.
Returns the collaborator's permission level for an organization project. Possible values for the permission key: admin, write, read, none. You must be an organization owner or a project admin to review a user's permission level.
Note: Accessing this endpoint does not count against your REST API rate limit.
\nNote: The rate object is deprecated. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.
When you pass the scarlet-witch-preview media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file.
The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.
Note: To edit a repository's topics, use the Replace all repository topics endpoint.
", "bodyParameters": [ { @@ -27554,9 +27240,7 @@ "slug": "delete-a-repository", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Deleting a repository requires admin access. If OAuth is used, the delete_repo scope is required.
If an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a 403 Forbidden response.
Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint. GitHub Apps must have the administration repository permission to use this API.
Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for a repository.\"
You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.
Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the repo scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo scope to use this endpoint.
Returns a token that you can pass to the config script. The token expires after one hour. You must authenticate\nusing an access token with the repo scope to use this endpoint.
Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN\nReturns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.\nYou must authenticate using an access token with the repo scope to use this endpoint.
To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.
\n./config.sh remove --token TOKEN\nGets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the secrets repository permission to use this endpoint.
Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
Gets a specific workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
List all workflow runs for a workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope.
Lists the available assignees for issues in a repository.
", "responses": [ @@ -31285,9 +30897,7 @@ "categoryLabel": "Issues", "subcategory": "assignees", "subcategoryLabel": "Assignees", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -31366,9 +30976,7 @@ "slug": "enable-automated-security-fixes", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -31442,9 +31050,7 @@ "slug": "disable-automated-security-fixes", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -31543,9 +31149,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -31636,9 +31240,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -31735,9 +31337,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "responses": [ @@ -32321,9 +31921,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -32862,9 +32460,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -32948,9 +32544,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "responses": [ @@ -33030,9 +32624,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
", "responses": [ @@ -33112,9 +32704,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -33205,9 +32795,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -33411,9 +32999,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
\nNote: Passing new arrays of users and teams replaces their previous values.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.
Note: You must enable branch protection to require signed commits.
", "responses": [ @@ -33780,9 +33362,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.
", "responses": [ @@ -33874,9 +33454,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -33960,9 +33538,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "responses": [ @@ -34085,9 +33661,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.
", "bodyParameters": [ { @@ -34199,9 +33773,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -34280,9 +33852,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "responses": [ @@ -34399,9 +33969,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "bodyParameters": [ { @@ -34541,9 +34109,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "bodyParameters": [ { @@ -34678,9 +34244,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "bodyParameters": [ { @@ -34783,9 +34347,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists who has access to this protected branch.
\nNote: Users, apps, and teams restrictions are only available for organization-owned repositories.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nGrants the specified apps push access for this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
| Type | Description |
|---|---|
array | The GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
| Type | Description |
|---|---|
array | The GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nRemoves the ability of an app to push to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
| Type | Description |
|---|---|
array | The GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists the teams who have push access to this branch. The list includes child teams.
", "responses": [ @@ -35553,9 +35103,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nGrants the specified teams push access for this branch. You can also give push access to child teams.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | The teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | The teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Teams that should no longer have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists the people who have push access to this branch.
", "responses": [ @@ -36036,9 +35578,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nGrants the specified people push access for this branch.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nRemoves the ability of a user to push to this branch.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames of the people who should no longer have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Creates a new check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to create check runs.
In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
", "responses": [ { @@ -38428,9 +37962,7 @@ "categoryLabel": "Checks", "subcategory": "runs", "subcategoryLabel": "Runs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Updates a check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to edit check runs.
Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"Update repository preferences for check suites\". Your GitHub App must have the checks:write permission to create check suites.
Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually Create a check suite. You must have admin permissions in the repository to set preferences for check suites.
", "responses": [ { @@ -40918,9 +40442,7 @@ "categoryLabel": "Checks", "subcategory": "suites", "subcategoryLabel": "Suites", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
Lists all open code scanning alerts for the default branch (usually main or master). For private repos, you must use an access token with the repo scope. For public repos, you must use an access token with public_repo and repo:security_events scopes. GitHub Apps must have the security_events read permission to use this endpoint.
Gets a single code scanning alert. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events read permission to use this endpoint.
The security alert_number is found at the end of the security alert's URL. For example, the security alert ID for https://github.com/Octo-org/octo-repo/security/code-scanning/88 is 88.
Updates the status of a single code scanning alert. For private repos, you must use an access token with the repo scope. For public repos, you must use an access token with public_repo and repo:security_events scopes.\nGitHub Apps must have the security_events write permission to use this endpoint.
List the details of recent code scanning analyses for a repository. For private repos, you must use an access token with the repo scope. For public repos, you must use an access token with public_repo and repo:security_events scopes. GitHub Apps must have the security_events read permission to use this endpoint.
For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
\nTeam members will include the members of child teams.
", "responses": [ @@ -42029,9 +41535,7 @@ "categoryLabel": "Repos", "subcategory": "collaborators", "subcategoryLabel": "Collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -42152,9 +41656,7 @@ "categoryLabel": "Repos", "subcategory": "collaborators", "subcategoryLabel": "Collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nFor more information the permission levels, see \"Repository permission levels for an organization\".
\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.
\nRate limits
\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
", "bodyParameters": [ { @@ -42275,9 +41777,7 @@ "categoryLabel": "Repos", "subcategory": "collaborators", "subcategoryLabel": "Collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -42355,9 +41855,7 @@ "categoryLabel": "Repos", "subcategory": "collaborators", "subcategoryLabel": "Collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Checks the repository permission of a collaborator. The possible repository permissions are admin, write, read, and none.
Commit Comments use these custom media types. You can read more about the use of media types in the API here.
\nComments are ordered by ascending ID.
", "responses": [ @@ -42548,9 +42044,7 @@ "categoryLabel": "Repos", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -42661,9 +42155,7 @@ "categoryLabel": "Repos", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -42758,9 +42250,7 @@ "categoryLabel": "Repos", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -42889,9 +42379,7 @@ "slug": "list-reactions-for-a-commit-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List the reactions to a commit comment.
", "responses": [ @@ -43022,9 +42510,7 @@ "slug": "create-reaction-for-a-commit-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Create a reaction to a commit comment. A response with a Status: 200 OK means that you already added the reaction type to this commit comment.
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.
", "responses": [ @@ -43523,9 +43003,7 @@ "categoryLabel": "Repos", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Use the :commit_sha to specify the commit that will have its comments listed.
Create a comment for a commit using its :commit_sha.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -43818,9 +43294,7 @@ "categoryLabel": "Repos", "subcategory": "commits", "subcategoryLabel": "Commits", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the List pull requests endpoint.
", "responses": [ @@ -43905,9 +43379,7 @@ "categoryLabel": "Repos", "subcategory": "commits", "subcategoryLabel": "Commits", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.
Note: If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
\nYou can pass the appropriate media type to fetch diff and patch formats. Diffs with binary data will have no patch property.
To return only the SHA-1 hash of the commit reference, you can provide the sha custom media type in the Accept header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.
Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.
\nThe most recent status for each context is returned, up to 100. This field paginates if there are over 100 contexts.
\nAdditionally, a combined state is returned. The state is one of:
error or failurependingsuccessUsers with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.
\nThis resource is also available via a legacy route: GET /repos/:owner/:repo/statuses/:ref.
This method returns the contents of the repository's code of conduct file, if one is detected.
", "responses": [ @@ -44527,9 +43989,7 @@ "categoryLabel": "Repos", "subcategory": "community", "subcategoryLabel": "Community", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "This endpoint will return all community profile metrics, including an\noverall health score, repository description, the presence of documentation, detected\ncode of conduct, detected license, and the presence of ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE,\nREADME, and CONTRIBUTING files.
\ncontent_reports_enabled is only returned for organization-owned repositories.
Both :base and :head must be branch names in :repo. To compare branches across other repositories in the same network as :repo, use the format <USERNAME>:branch.
The response from the API is equivalent to running the git log base..head command; however, commits are returned in chronological order. Pass the appropriate media type to fetch diff and patch formats.
The response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.
Working with large comparisons
\nThe response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the List commits to enumerate all commits in the range.
\nFor comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long\nto generate. You can typically resolve this error by using a smaller commit range.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of all files in the repository.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNote:
\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
Creates a new file or replaces an existing file in a repository.
", "responses": [ { @@ -45518,9 +44972,7 @@ "categoryLabel": "Repos", "subcategory": "contents", "subcategoryLabel": "Contents", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Deletes a file in a repository.
\nYou can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.
The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.
You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.
Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.
\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.
", "responses": [ @@ -45934,9 +45384,7 @@ "categoryLabel": "Repos", "subcategory": "deployments", "subcategoryLabel": "Deployments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Simple filtering of deployments is available via query parameters:
", "responses": [ @@ -46150,9 +45598,7 @@ "categoryLabel": "Repos", "subcategory": "deployments", "subcategoryLabel": "Deployments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Deployments offer a few configurable parameters with certain defaults.
\nThe ref parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them\nbefore we merge a pull request.
The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.
The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.
By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.
The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.
The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.
Users with repo or repo_deployment scopes can create a deployment for a given ref.
You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:
\nmaster in the response exampleIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.
\nThis error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.
This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.
Users with pull access can view deployment statuses for a deployment:
", "responses": [ @@ -46781,9 +46221,7 @@ "categoryLabel": "Repos", "subcategory": "deployments", "subcategoryLabel": "Deployments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Users with push access can create deployment statuses for a given deployment.
GitHub Apps require read & write access to \"Deployments\" and read-only access to \"Repo contents\" (for private repos). OAuth Apps require the repo_deployment scope.
Users with pull access can view a deployment status for a deployment:
", "responses": [ @@ -47092,9 +46528,7 @@ "slug": "create-a-repository-dispatch-event", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -47208,9 +46642,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -47315,9 +46747,7 @@ "categoryLabel": "Repos", "subcategory": "forks", "subcategoryLabel": "Forks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -47412,9 +46842,7 @@ "categoryLabel": "Repos", "subcategory": "forks", "subcategoryLabel": "Forks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Create a fork for the authenticated user.
\nNote: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub Support or GitHub Premium Support.
", "bodyParameters": [ { @@ -47551,9 +46979,7 @@ "categoryLabel": "Git", "subcategory": "blobs", "subcategoryLabel": "Blobs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -47672,9 +47098,7 @@ "categoryLabel": "Git", "subcategory": "blobs", "subcategoryLabel": "Blobs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "The content in the response will always be Base64 encoded.
Note: This API supports blobs up to 100 megabytes in size.
", "responses": [ @@ -47972,9 +47396,7 @@ "categoryLabel": "Git", "subcategory": "commits", "subcategoryLabel": "Commits", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates a new Git commit object.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Gets a Git commit object.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.
When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.
Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nIf you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.
Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.
Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
", "responses": [ @@ -48562,9 +47978,7 @@ "categoryLabel": "Git", "subcategory": "refs", "subcategoryLabel": "Refs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.
", "bodyParameters": [ { @@ -48714,9 +48128,7 @@ "categoryLabel": "Git", "subcategory": "refs", "subcategoryLabel": "Refs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -48821,9 +48233,7 @@ "categoryLabel": "Git", "subcategory": "refs", "subcategoryLabel": "Refs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -49039,9 +48449,7 @@ "categoryLabel": "Git", "subcategory": "tags", "subcategoryLabel": "Tags", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary.
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.
\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"Create a commit\" and \"Update a reference.\"
", "responses": [ { @@ -49743,9 +49147,7 @@ "categoryLabel": "Git", "subcategory": "trees", "subcategoryLabel": "Trees", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns a single tree using the SHA1 value for that tree.
\nIf truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.
Repositories can have multiple webhooks installed. Each webhook should have a unique config. Multiple webhooks can\nshare the same config as long as those webhooks do not have any events that overlap.
Returns a webhook configured in a repository. To get only the webhook config properties, see \"Get a webhook configuration for a repository.\"
Updates a webhook configured in a repository. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use \"Update a webhook configuration for a repository.\"
Returns the webhook configuration for a repository. To get more information about the webhook, including the active state and events, use \"Get a repository webhook.\"
Access tokens must have the read:repo_hook or repo scope, and GitHub Apps must have the repository_hooks:read permission.
Updates the webhook configuration for a repository. To update more information about the webhook, including the active state and events, use \"Update a repository webhook.\"
Access tokens must have the write:repo_hook or repo scope, and GitHub Apps must have the repository_hooks:write permission.
View the progress of an import.
\nImport status
\nThis section includes details about the possible values of the status field of the Import Progress response.
An import that does not have errors will progress through these steps:
\ndetecting - the \"detection\" step of the import is in progress because the request did not include a vcs parameter. The import is identifying the type of source control present at the URL.importing - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include commit_count (the total number of raw commits that will be imported) and percent (0 - 100, the current progress through the import).mapping - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.pushing - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include push_percent, which is the percent value reported by git push when it is \"Writing objects\".complete - the import is complete, and the repository is ready on GitHub.If there are problems, you will see one of these in the status field:
auth_failed - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the Update an import section.error - the import encountered an error. The import progress response will include the failed_step and an error message. Contact GitHub Support or GitHub Premium Support for more information.detection_needs_auth - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the Update an import section.detection_found_nothing - the importer didn't recognize any source control at the URL. To resolve, Cancel the import and retry with the correct URL.detection_found_multiple - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a project_choices field with the possible project choices as values. To update project choice, please see the Update an import section.The project_choices field
\nWhen multiple projects are found at the provided URL, the response hash will include a project_choices field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.
Git LFS related fields
\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.
\nuse_lfs - describes whether the import has been opted in or out of using Git LFS. The value can be opt_in, opt_out, or undecided if no action has been taken.has_large_files - the boolean value describing whether files larger than 100MB were found during the importing step.large_files_size - the total size in gigabytes of files larger than 100MB found in the originating repository.large_files_count - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.Start a source import to a GitHub repository using GitHub Importer.
", "bodyParameters": [ { @@ -51819,9 +51199,7 @@ "categoryLabel": "Migrations", "subcategory": "source-imports", "subcategoryLabel": "Source imports", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.
", "bodyParameters": [ { @@ -51940,9 +51318,7 @@ "categoryLabel": "Migrations", "subcategory": "source-imports", "subcategoryLabel": "Source imports", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -52021,9 +51397,7 @@ "categoryLabel": "Migrations", "subcategory": "source-imports", "subcategoryLabel": "Source imports", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username hubot into something like hubot <hubot@12341234-abab-fefe-8787-fedcba987654>.
This endpoint and the Map a commit author endpoint allow you to provide correct Git author information.
", "responses": [ @@ -52149,9 +51523,7 @@ "categoryLabel": "Migrations", "subcategory": "source-imports", "subcategoryLabel": "Source imports", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository.
", "bodyParameters": [ { @@ -52259,9 +51631,7 @@ "categoryLabel": "Migrations", "subcategory": "source-imports", "subcategoryLabel": "Source imports", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List files larger than 100MB found during the import
", "responses": [ @@ -52361,9 +51731,7 @@ "categoryLabel": "Migrations", "subcategory": "source-imports", "subcategoryLabel": "Source imports", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by Git LFS. You can learn more about our LFS feature and working with large files on our help site.
", "bodyParameters": [ { @@ -52530,9 +51898,7 @@ "categoryLabel": "Interactions", "subcategory": "repos", "subcategoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.
", "responses": [ @@ -52650,9 +52016,7 @@ "categoryLabel": "Interactions", "subcategory": "repos", "subcategoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a 409 Conflict response and will not be able to use this endpoint to change the interaction limit for a single repository.
When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.
", "responses": [ @@ -52965,9 +52325,7 @@ "categoryLabel": "Repos", "subcategory": "invitations", "subcategoryLabel": "Invitations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -53064,9 +52422,7 @@ "categoryLabel": "Repos", "subcategory": "invitations", "subcategoryLabel": "Invitations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -53267,9 +52623,7 @@ "slug": "list-repository-issues", "category": "issues", "categoryLabel": "Issues", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List issues in a repository.
\nNote: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.
Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -53708,9 +53060,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "By default, Issue Comments are ordered by ascending ID.
", "responses": [ @@ -53807,9 +53157,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -53920,9 +53268,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -54017,9 +53363,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -54143,9 +53487,7 @@ "slug": "list-reactions-for-an-issue-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List the reactions to an issue comment.
", "responses": [ @@ -54276,9 +53618,7 @@ "slug": "create-reaction-for-an-issue-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Create a reaction to an issue comment. A response with a Status: 200 OK means that you already added the reaction type to this issue comment.
The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.
Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.
Issue owners and users with push access can edit an issue.
", "bodyParameters": [ { @@ -55156,9 +54486,7 @@ "categoryLabel": "Issues", "subcategory": "assignees", "subcategoryLabel": "Assignees", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.
", "bodyParameters": [ { @@ -55280,9 +54608,7 @@ "categoryLabel": "Issues", "subcategory": "assignees", "subcategoryLabel": "Assignees", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Removes one or more assignees from an issue.
", "bodyParameters": [ { @@ -55412,9 +54738,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Issue Comments are ordered by ascending ID.
", "responses": [ @@ -55531,9 +54855,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -55670,9 +54992,7 @@ "categoryLabel": "Issues", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -55777,9 +55097,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -55896,9 +55214,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -56030,9 +55346,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Removes any previous labels and sets the new labels for an issue.
", "bodyParameters": [ { @@ -56135,9 +55449,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -56230,9 +55542,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a 404 Not Found status if the label does not exist.
List the reactions to an issue.
", "responses": [ @@ -56859,9 +56163,7 @@ "slug": "delete-an-issue-reaction", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -56973,9 +56275,7 @@ "categoryLabel": "Issues", "subcategory": "timeline", "subcategoryLabel": "Timeline", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -57080,9 +56380,7 @@ "categoryLabel": "Repos", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -57198,9 +56496,7 @@ "categoryLabel": "Repos", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "You can create a read-only deploy key.
", "bodyParameters": [ { @@ -57313,9 +56609,7 @@ "categoryLabel": "Repos", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -57400,9 +56694,7 @@ "categoryLabel": "Repos", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -57491,9 +56783,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -57614,9 +56904,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -57733,9 +57021,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -57862,9 +57148,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -57971,9 +57255,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -58040,9 +57322,7 @@ "slug": "list-repository-languages", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.
", "responses": [ @@ -58110,9 +57390,7 @@ "slug": "get-the-license-for-a-repository", "category": "licenses", "categoryLabel": "Licenses", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "This method returns the contents of the repository's license file, if one is detected.
\nSimilar to Get repository content, this method also supports custom media types for retrieving the raw license content or rendered license HTML.
", "responses": [ @@ -58229,9 +57507,7 @@ "categoryLabel": "Repos", "subcategory": "merging", "subcategoryLabel": "Merging", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -58423,9 +57699,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -58561,9 +57835,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -58695,9 +57967,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -58840,9 +58110,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -58964,9 +58232,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -59070,9 +58336,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -59373,9 +58637,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -59546,9 +58808,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Configures a GitHub Pages site. For more information, see \"About GitHub Pages.\"
", "responses": [ { @@ -59772,9 +59032,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -59910,9 +59168,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -60016,9 +59272,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -60088,9 +59342,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.
\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.
", "responses": [ @@ -60160,9 +59412,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -60241,9 +59491,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -60354,9 +59602,7 @@ "slug": "list-repository-projects", "category": "projects", "categoryLabel": "Projects", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the projects in a repository. Returns a 404 Not Found status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Creates a repository project board. Returns a 404 Not Found status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
", "responses": [ @@ -60858,9 +60100,7 @@ "slug": "create-a-pull-request", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
\nYou can create a new pull request.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -61076,9 +60316,7 @@ "categoryLabel": "Pulls", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nProvides details for a review comment.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nEnables you to edit a review comment.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.List the reactions to a pull request review comment.
", "responses": [ @@ -61647,9 +60877,7 @@ "slug": "create-reaction-for-a-pull-request-review-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Create a reaction to a pull request review comment. A response with a Status: 200 OK means that you already added the reaction type to this pull request review comment.
Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nLists details of a pull request by providing its number.
\nWhen you get, create, or edit a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".
The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.
The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:
merge_commit_sha represents the SHA of the merge commit.merge_commit_sha represents the SHA of the squashed commit on the base branch.merge_commit_sha represents the commit that the base branch was updated to.Pass the appropriate media type to fetch diff and patch formats.
", "responses": [ @@ -62017,9 +61241,7 @@ "slug": "update-a-pull-request", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
", "bodyParameters": [ { @@ -62230,9 +61452,7 @@ "categoryLabel": "Pulls", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.
You can still create a review comment using the position parameter. When you use position, the line, side, start_line, and start_side parameters are not required. For more information, see Multi-line comment summary.
Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the List commits endpoint.
", "responses": [ @@ -62878,9 +62094,7 @@ "slug": "list-pull-requests-files", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
", "responses": [ @@ -62967,9 +62181,7 @@ "slug": "check-if-a-pull-request-has-been-merged", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -63103,9 +62315,7 @@ "slug": "merge-a-pull-request", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -63273,9 +62483,7 @@ "categoryLabel": "Pulls", "subcategory": "review-requests", "subcategoryLabel": "Review requests", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -63400,9 +62608,7 @@ "categoryLabel": "Pulls", "subcategory": "review-requests", "subcategoryLabel": "Review requests", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -63561,9 +62767,7 @@ "categoryLabel": "Pulls", "subcategory": "review-requests", "subcategoryLabel": "Review requests", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -63691,9 +62895,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "The list of reviews returns in chronological order.
", "responses": [ @@ -63980,9 +63182,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nPull request reviews created in the PENDING state do not include the submitted_at property in the response.
Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API v3 offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
Update the review summary comment with new text.
", "bodyParameters": [ { @@ -64494,9 +63690,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -64615,9 +63809,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List comments for a specific pull request review.
", "responses": [ @@ -64743,9 +63935,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
", "bodyParameters": [ { @@ -64900,9 +64090,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -65153,9 +64341,7 @@ "categoryLabel": "Repos", "subcategory": "contents", "subcategoryLabel": "Contents", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Gets the preferred README for a repository.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", "responses": [ @@ -65255,9 +64441,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the Repository Tags API.
\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.
", "responses": [ @@ -65411,9 +64595,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Users with push access to the repository can create a release.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -65555,9 +64737,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.
Users with push access to the repository can edit a release asset.
", "bodyParameters": [ { @@ -65804,9 +64982,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -65875,9 +65051,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "View the latest published full release for the repository.
\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the created_at attribute. The created_at attribute is the date of the commit used for the release, and not the date when the release was drafted or published.
Get a published release with the specified tag.
", "responses": [ @@ -66044,9 +65216,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.
Users with push access to the repository can edit a release.
", "bodyParameters": [ { @@ -66341,9 +65509,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -66442,9 +65608,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -66561,9 +65725,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nLists the people that have starred the repository.
\nYou can also find out when stars were created by passing the following custom media type via the Accept header:
Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
", "responses": [ @@ -66802,9 +65960,7 @@ "categoryLabel": "Repos", "subcategory": "statistics", "subcategoryLabel": "Statistics", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns the last year of commit activity grouped by week. The days array is a group of commits per day, starting on Sunday.
Returns the total number of commits authored by the contributor. In addition, the response includes a Weekly Hash (weeks array) with the following information:
w - Start of the week, given as a Unix timestamp.a - Number of additionsd - Number of deletionsc - Number of commitsReturns the total commit counts for the owner and total commit counts in all. all is everyone combined, including the owner in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract owner from all.
The array order is oldest week (index 0) to most recent week.
", "responses": [ @@ -67023,9 +66175,7 @@ "categoryLabel": "Repos", "subcategory": "statistics", "subcategoryLabel": "Statistics", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Each array contains the day number, hour number, and number of commits:
\n0-6: Sunday - Saturday0-23: Hour of dayFor example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.
Users with push access in a repository can create commit statuses for a given SHA.
\nNote: there is a limit of 1000 statuses per sha and context within a repository. Attempts to create more than 1000 statuses will result in a validation error.
Lists the people watching the specified repository.
", "responses": [ @@ -67660,9 +66806,7 @@ "slug": "list-repository-tags", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -67741,9 +66885,7 @@ "categoryLabel": "Repos", "subcategory": "contents", "subcategoryLabel": "Contents", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "302", @@ -67830,9 +66972,7 @@ "slug": "list-repository-teams", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -67907,9 +67047,7 @@ "slug": "get-all-repository-topics", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -68028,9 +67166,7 @@ "slug": "replace-all-repository-topics", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -68143,9 +67279,7 @@ "categoryLabel": "Repos", "subcategory": "traffic", "subcategoryLabel": "Traffic", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.
", "responses": [ @@ -68220,9 +67354,7 @@ "categoryLabel": "Repos", "subcategory": "traffic", "subcategoryLabel": "Traffic", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Get the top 10 popular contents over the last 14 days.
", "responses": [ @@ -68297,9 +67429,7 @@ "categoryLabel": "Repos", "subcategory": "traffic", "subcategoryLabel": "Traffic", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Get the top 10 referrers over the last 14 days.
", "responses": [ @@ -68389,9 +67519,7 @@ "categoryLabel": "Repos", "subcategory": "traffic", "subcategoryLabel": "Traffic", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.
", "responses": [ @@ -68503,9 +67631,7 @@ "slug": "transfer-a-repository", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original owner, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see about repository transfers.
Lists all public repositories in the order that they were created.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.
Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
", "responses": [ @@ -69339,9 +68455,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "scim", "subcategoryLabel": "Scim", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
\nProvision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to.
", "responses": [ { @@ -69477,9 +68591,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "scim", "subcategoryLabel": "Scim", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
", "responses": [ @@ -69643,9 +68755,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "scim", "subcategoryLabel": "Scim", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
\nReplaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the Update an attribute for a SCIM enterprise group endpoint instead.
", "responses": [ { @@ -69836,9 +68946,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "scim", "subcategoryLabel": "Scim", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
\nAllows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.
", "responses": [ { @@ -69935,9 +69043,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "scim", "subcategoryLabel": "Scim", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -70018,9 +69124,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "scim", "subcategoryLabel": "Scim", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
\nRetrieves a paginated list of all provisioned enterprise members, including pending invitations.
\nWhen a user with a SAML-provisioned external identity leaves (or is removed from) an enterprise, the account's metadata is immediately removed. However, the returned list of user accounts might not always match the organization or enterprise member list you see on GitHub. This can happen in certain cases where an external identity associated with an organization will not match an organization member:
\nThe returned list of external identities can include an entry for a null user. These are unlinked SAML identities that are created when a user goes through the following Single Sign-On (SSO) process but does not sign in to their GitHub account after completing SSO:
The user is granted access by the IdP and is not a member of the GitHub enterprise.
\nThe user attempts to access the GitHub enterprise and initiates the SAML SSO process, and is not currently signed in to their GitHub account.
\nAfter successfully authenticating with the SAML SSO IdP, the null external identity entry is created and the user is prompted to sign in to their GitHub account:
null entry remains in place.Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
\nProvision enterprise membership for a user, and send organization invitation emails to the email address.
\nYou can optionally include the groups a user will be invited to join. If you do not provide a list of groups, the user is provisioned for the enterprise, but no organization invitation emails will be sent.
Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
", "responses": [ @@ -70903,9 +70003,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "scim", "subcategoryLabel": "Scim", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
\nReplaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the Update an attribute for a SCIM user endpoint instead.
\nYou must at least provide the required values for the user: userName, name, and emails.
Warning: Setting active: false removes the user from the enterprise, deletes the external identity, and deletes the associated {scim_user_id}.
Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
\nAllows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.
Note: Complicated SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will not work.
Warning: If you set active:false using the replace operation (as shown in the JSON example below), it removes the user from the enterprise, deletes the external identity, and deletes the associated :scim_user_id.
{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\nSearches for query terms inside of a file. This method returns up to 100 results per page.
\nWhen searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:
q=addClass+in:file+language:js+repo:jquery/jquery
This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.
Due to the complexity of searching code, there are a few restrictions on how searches are performed:
\nmaster branch.language:go is not valid, while amazing language:go is.Find commits via various criteria on the default branch (usually master). This method returns up to 100 results per page.
When searching for commits, you can get text match metadata for the message field when you provide the text-match media type. For more details about how to receive highlighted search results, see Text match\nmetadata.
For example, if you want to find commits related to CSS in the octocat/Spoon-Knife repository. Your query would look something like this:
\nq=repo:octocat/Spoon-Knife+css
Find issues by state and keyword. This method returns up to 100 results per page.
\nWhen searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.
For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.
\nq=windows+label:bug+language:python+state:open&sort=created&order=asc
This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.
Note: For user-to-server GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"
Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results per page.
\nWhen searching for labels, you can get text match metadata for the label name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to find labels in the linguist repository that match bug, defect, or enhancement. Your query might look like this:
q=bug+defect+enhancement&repository_id=64778136
The labels that best match the query appear first in the search results.
", "responses": [ @@ -73775,9 +72849,7 @@ "slug": "search-repositories", "category": "search", "categoryLabel": "Search", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Find repositories via various criteria. This method returns up to 100 results per page.
\nWhen searching for repositories, you can get text match metadata for the name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:
\nq=tetris+language:assembly&sort=stars&order=desc
This query searches for repositories with the word tetris in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.
When you include the mercy preview header, you can also search for multiple topics by adding more topic: instances. For example, your query might look like this:
q=topic:ruby+topic:rails
Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results per page. See \"Searching topics\" for a detailed list of qualifiers.
\nWhen searching for topics, you can get text match metadata for the topic's short_description, description, name, or display_name field when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:
\nq=ruby+is:featured
This query searches for topics with the keyword ruby and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.
Find users via various criteria. This method returns up to 100 results per page.
\nWhen searching for users, you can get text match metadata for the issue login, email, and name fields when you pass the text-match media type. For more details about highlighting search results, see Text match metadata. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you're looking for a list of popular users, you might try this query:
\nq=tom+repos:%3E42+followers:%3E1000
This query searches for users with the name tom. The results are restricted to users with more than 42 repositories and over 1,000 followers.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the Get a team by name endpoint.
", "responses": [ @@ -74204,9 +73270,7 @@ "slug": "update-a-team-legacy", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a team endpoint.
\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote: With nested teams, the privacy for parent teams cannot be secret.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.
List all discussions on a team's page. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.
Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -74689,9 +73747,7 @@ "categoryLabel": "Teams", "subcategory": "discussions", "subcategoryLabel": "Discussions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion endpoint.
\nGet a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion endpoint.
\nEdits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion comments endpoint.
\nList all comments on a team discussion. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.
\nCreates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -75223,9 +74271,7 @@ "categoryLabel": "Teams", "subcategory": "discussion-comments", "subcategoryLabel": "Discussion comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion comment endpoint.
\nGet a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.
\nEdits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion comment endpoint.
Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with a Status: 200 OK means that you already added the reaction type to this team discussion comment.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List pending team invitations endpoint.
The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub member, the login field in the return hash will be null.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members endpoint.
Team members will include the members of child teams.
", "responses": [ @@ -76229,9 +75261,7 @@ "categoryLabel": "Teams", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -76308,9 +75338,7 @@ "categoryLabel": "Teams", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "The \"Add team member\" endpoint (described below) is deprecated.
\nWe recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.
\nNote: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub.\"
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership for a user endpoint.
\nTeam members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create a team.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.
\nNote: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub.\"
\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
", "bodyParameters": [ { @@ -76712,9 +75734,7 @@ "categoryLabel": "Teams", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -76807,9 +75827,7 @@ "slug": "list-team-projects-legacy", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team projects endpoint.
Lists the organization projects for a team.
", "responses": [ @@ -76897,9 +75915,7 @@ "slug": "check-team-permissions-for-a-project-legacy", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a project endpoint.
\nChecks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team project permissions endpoint.
\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team repositories endpoint.
", "responses": [ @@ -77305,9 +76315,7 @@ "slug": "check-team-permissions-for-a-repository-legacy", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -77421,9 +76429,7 @@ "slug": "add-or-update-team-repository-permissions-legacy", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -77527,9 +76533,7 @@ "slug": "remove-a-repository-from-a-team-legacy", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -78071,9 +77075,7 @@ "slug": "list-child-teams-legacy", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List child teams endpoint.
Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
Provides publicly available information about someone with a GitHub account.
\nGitHub Apps with the Plan user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See \"Identifying and authorizing users for GitHub Apps\" for details about authentication. For an example response, see 'Response with GitHub plan information' below\"
The email key in the following response is the publicly visible email address from your GitHub profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub. For more information, see Authentication.
The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".
", "responses": [ @@ -84366,9 +83362,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -84537,9 +83531,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -84619,9 +83611,7 @@ "categoryLabel": "Users", "subcategory": "followers", "subcategoryLabel": "Followers", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the people following the specified user.
", "responses": [ @@ -84702,9 +83692,7 @@ "categoryLabel": "Users", "subcategory": "followers", "subcategoryLabel": "Followers", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the people who the specified user follows.
", "responses": [ @@ -84774,9 +83762,7 @@ "categoryLabel": "Users", "subcategory": "followers", "subcategoryLabel": "Followers", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -84955,9 +83941,7 @@ "categoryLabel": "Users", "subcategory": "gpg-keys", "subcategoryLabel": "Gpg keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the GPG keys for a user. This information is accessible by anyone.
", "responses": [ @@ -85192,9 +84176,7 @@ "categoryLabel": "Users", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the verified public SSH keys for a user. This is accessible by anyone.
", "responses": [ @@ -85273,9 +84255,7 @@ "slug": "list-organizations-for-a-user", "category": "orgs", "categoryLabel": "Orgs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List public organization memberships for the specified user.
\nThis method only lists public memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the List organizations for the authenticated user API instead.
", "responses": [ @@ -85468,9 +84448,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -85550,9 +84528,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -85684,9 +84660,7 @@ "slug": "list-repositories-for-a-user", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists public repositories for the specified user.
", "responses": [ @@ -85974,9 +84948,7 @@ "categoryLabel": "Activity", "subcategory": "starring", "subcategoryLabel": "Starring", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists repositories a user has starred.
\nYou can also find out when stars were created by passing the following custom media type via the Accept header:
Lists repositories a user is watching.
", "responses": [ @@ -86103,9 +85073,7 @@ "slug": "get-the-zen-of-github", "category": "meta", "categoryLabel": "Meta", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", diff --git a/lib/rest/static/decorated/ghes-2.18.json b/lib/rest/static/decorated/ghes-2.18.json index 43d319ca038d..8f1ee900a5f5 100644 --- a/lib/rest/static/decorated/ghes-2.18.json +++ b/lib/rest/static/decorated/ghes-2.18.json @@ -31,9 +31,7 @@ "slug": "github-api-root", "category": "meta", "categoryLabel": "Meta", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -3534,9 +3532,7 @@ "slug": "get-the-authenticated-app", "category": "apps", "categoryLabel": "Apps", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count in the response. For more details about your app's installations, see the \"List installations for the authenticated app\" endpoint.
You must use a JWT to access this endpoint.
", "responses": [ @@ -3692,9 +3688,7 @@ "slug": "list-installations-for-the-authenticated-app", "category": "apps", "categoryLabel": "Apps", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "You must use a JWT to access this endpoint.
\nThe permissions the installation has are included under the permissions key.
Enables an authenticated GitHub App to find an installation's information using the installation id. The installation's account type (target_type) will be either an organization or a user account, depending which account the repository belongs to.
You must use a JWT to access this endpoint.
", "responses": [ @@ -4092,9 +4084,7 @@ "slug": "create-an-installation-access-token-for-an-app", "category": "apps", "categoryLabel": "Apps", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of 401 - Unauthorized, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the repository_ids when creating the token. When you omit repository_ids, the response does not contain the repositories key.
You must use a JWT to access this endpoint.
", "responses": [ { @@ -4837,9 +4827,7 @@ "slug": "get-an-app", "category": "apps", "categoryLabel": "Apps", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: The :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).
If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a personal access token or an installation access token to access this endpoint.
", "responses": [ @@ -5997,9 +5985,7 @@ "slug": "get-all-codes-of-conduct", "category": "codes-of-conduct", "categoryLabel": "Codes of conduct", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -6075,9 +6061,7 @@ "slug": "get-a-code-of-conduct", "category": "codes-of-conduct", "categoryLabel": "Codes of conduct", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -6197,9 +6181,7 @@ "categoryLabel": "Apps", "subcategory": "installations", "subcategoryLabel": "Installations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id of the content reference from the content_reference event to create an attachment.
The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.
\nYou must use an installation access token to access this endpoint.
", "bodyParameters": [ { @@ -6301,9 +6283,7 @@ "slug": "get-emojis", "category": "emojis", "categoryLabel": "Emojis", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -6491,9 +6471,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -6558,9 +6536,7 @@ "categoryLabel": "Activity", "subcategory": "feeds", "subcategoryLabel": "Feeds", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "GitHub Enterprise Server provides several timeline resources in Atom format. The Feeds API lists all the feeds available to the authenticated user:
\nNote: Private feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
", "responses": [ @@ -8491,9 +8467,7 @@ "slug": "get-all-gitignore-templates", "category": "gitignore", "categoryLabel": "Gitignore", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List all templates available to pass as an option when creating a repository.
", "responses": [ @@ -8557,9 +8531,7 @@ "slug": "get-a-gitignore-template", "category": "gitignore", "categoryLabel": "Gitignore", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "The API also allows fetching the source of a single template.\nUse the raw media type to get the raw contents.
", "responses": [ @@ -8660,9 +8632,7 @@ "categoryLabel": "Apps", "subcategory": "installations", "subcategoryLabel": "Installations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List repositories that an app installation can access.
\nYou must use an installation access token to access this endpoint.
", "responses": [ @@ -8958,9 +8928,7 @@ "slug": "get-all-commonly-used-licenses", "category": "licenses", "categoryLabel": "Licenses", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -9024,9 +8992,7 @@ "slug": "get-a-license", "category": "licenses", "categoryLabel": "Licenses", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -9137,9 +9103,7 @@ "slug": "render-a-markdown-document", "category": "markdown", "categoryLabel": "Markdown", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -9240,9 +9204,7 @@ "slug": "render-a-markdown-document-in-raw-mode", "category": "markdown", "categoryLabel": "Markdown", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -9295,9 +9257,7 @@ "slug": "get-github-enterprise-server-meta-information", "category": "meta", "categoryLabel": "Meta", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "This endpoint provides a list of GitHub's IP addresses. For more information, see \"About GitHub's IP addresses.\"
", "responses": [ @@ -9392,9 +9352,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -10132,9 +10090,7 @@ "slug": "get-octocat", "category": "meta", "categoryLabel": "Meta", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -10203,9 +10159,7 @@ "slug": "list-organizations", "category": "orgs", "categoryLabel": "Orgs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists all organizations, in the order that they were created on GitHub Enterprise Server.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
To see many of the organization response values, you need to be an authenticated organization owner with the admin:org scope. When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.
GitHub Apps with the Organization plan permission can use this endpoint to retrieve information about an organization's GitHub Enterprise Server plan. See \"Authenticating with GitHub Apps\" for details. For an example response, see 'Response with GitHub Enterprise Server plan information' below.\"
Parameter Deprecation Notice: GitHub Enterprise Server will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.
Enables an authenticated organization owner with the admin:org scope to update the organization's profile and member privileges.
Here's how you can create a hook that posts payloads in JSON format:
", "responses": [ { @@ -11417,9 +11361,7 @@ "categoryLabel": "Orgs", "subcategory": "webhooks", "subcategoryLabel": "Webhooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns a webhook configured in an organization. To get only the webhook config properties, see \"Get a webhook configuration for an organization.\"
Updates a webhook configured in an organization. When you update a webhook, the secret will be overwritten. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use \"Update a webhook configuration for an organization.\"
List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.
", "responses": [ @@ -12397,9 +12331,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -12478,9 +12410,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -12554,9 +12484,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "In order to get a user's membership with an organization, the authenticated user must be an organization member.
", "responses": [ @@ -12673,9 +12601,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Only authenticated organization owners can add a member to the organization or update the member's role.
\npending until they accept the invitation.role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.Rate limits
\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
", "bodyParameters": [ { @@ -12776,9 +12702,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -12883,9 +12807,7 @@ "categoryLabel": "Orgs", "subcategory": "outside-collaborators", "subcategoryLabel": "Outside collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List all users who are outside collaborators of an organization.
", "responses": [ @@ -12955,9 +12877,7 @@ "categoryLabel": "Orgs", "subcategory": "outside-collaborators", "subcategoryLabel": "Outside collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\".
", "responses": [ @@ -13048,9 +12968,7 @@ "categoryLabel": "Orgs", "subcategory": "outside-collaborators", "subcategoryLabel": "Outside collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Removing a user from this list will remove them from all the organization's repositories.
", "responses": [ @@ -13143,9 +13061,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "org-pre-receive-hooks", "subcategoryLabel": "Org pre receive hooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.
", "responses": [ @@ -13222,9 +13138,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "org-pre-receive-hooks", "subcategoryLabel": "Org pre receive hooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -13334,9 +13248,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "org-pre-receive-hooks", "subcategoryLabel": "Org pre receive hooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "For pre-receive hooks which are allowed to be configured at the org level, you can set enforcement and allow_downstream_configuration
Removes any overrides for this hook at the org level for this org.
", "responses": [ @@ -13536,9 +13446,7 @@ "slug": "list-organization-projects", "category": "projects", "categoryLabel": "Projects", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the projects in an organization. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Creates an organization project board. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Members of an organization can choose to have their membership publicized or not.
", "responses": [ @@ -13844,9 +13748,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -14135,9 +14037,7 @@ "slug": "list-organization-repositories", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists repositories for the specified organization.
", "responses": [ @@ -14401,9 +14301,7 @@ "slug": "create-an-organization-repository", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.
\nOAuth scope requirements
\nWhen using OAuth, authorizations must include:
\npublic_repo scope or repo scope to create a public repositoryrepo scope to create a private repositoryLists all teams in an organization that are visible to the authenticated user.
", "responses": [ @@ -14827,9 +14723,7 @@ "slug": "create-a-team", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "To create a team, the authenticated user must be a member or owner of {org}. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"Setting team creation permissions.\"
When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of maintainers. For more information, see \"About teams\".
Gets a team using the team's slug. GitHub Enterprise Server generates the slug from the team name.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key.
Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
Gets a project by its id. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Updates a project board's information. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project admin to list collaborators.
Returns the collaborator's permission level for an organization project. Possible values for the permission key: admin, write, read, none. You must be an organization owner or a project admin to review a user's permission level.
Note: Accessing this endpoint does not count against your REST API rate limit.
\nNote: The rate object is deprecated. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.
When you pass the scarlet-witch-preview media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file.
The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.
Note: To edit a repository's topics, use the Replace all repository topics endpoint.
", "bodyParameters": [ { @@ -18031,9 +17877,7 @@ "slug": "delete-a-repository", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Deleting a repository requires admin access. If OAuth is used, the delete_repo scope is required.
If an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a 403 Forbidden response.
Lists the available assignees for issues in a repository.
", "responses": [ @@ -18219,9 +18061,7 @@ "categoryLabel": "Issues", "subcategory": "assignees", "subcategoryLabel": "Assignees", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -18325,9 +18165,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -18418,9 +18256,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -18517,9 +18353,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "responses": [ @@ -19103,9 +18937,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -19644,9 +19476,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -19730,9 +19560,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "responses": [ @@ -19812,9 +19640,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
", "responses": [ @@ -19894,9 +19720,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -19987,9 +19811,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -20193,9 +20015,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
\nNote: Passing new arrays of users and teams replaces their previous values.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.
Note: You must enable branch protection to require signed commits.
", "responses": [ @@ -20562,9 +20378,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.
", "responses": [ @@ -20656,9 +20470,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -20742,9 +20554,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "responses": [ @@ -20867,9 +20677,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.
", "bodyParameters": [ { @@ -20981,9 +20789,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -21062,9 +20868,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "responses": [ @@ -21181,9 +20985,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "bodyParameters": [ { @@ -21323,9 +21125,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "bodyParameters": [ { @@ -21460,9 +21260,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "bodyParameters": [ { @@ -21565,9 +21363,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists who has access to this protected branch.
\nNote: Users, apps, and teams restrictions are only available for organization-owned repositories.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists the teams who have push access to this branch. The list includes child teams.
", "responses": [ @@ -21852,9 +21644,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nGrants the specified teams push access for this branch. You can also give push access to child teams.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | The teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | The teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Teams that should no longer have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists the people who have push access to this branch.
", "responses": [ @@ -22335,9 +22119,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nGrants the specified people push access for this branch.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nRemoves the ability of a user to push to this branch.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames of the people who should no longer have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Creates a new check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to create check runs.
In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
", "responses": [ { @@ -24741,9 +24517,7 @@ "categoryLabel": "Checks", "subcategory": "runs", "subcategoryLabel": "Runs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Updates a check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to edit check runs.
Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"Update repository preferences for check suites\". Your GitHub App must have the checks:write permission to create check suites.
Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually Create a check suite. You must have admin permissions in the repository to set preferences for check suites.
", "responses": [ { @@ -27266,9 +27032,7 @@ "categoryLabel": "Checks", "subcategory": "suites", "subcategoryLabel": "Suites", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
\nTeam members will include the members of child teams.
", "responses": [ @@ -27697,9 +27455,7 @@ "categoryLabel": "Repos", "subcategory": "collaborators", "subcategoryLabel": "Collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -27820,9 +27576,7 @@ "categoryLabel": "Repos", "subcategory": "collaborators", "subcategoryLabel": "Collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nFor more information the permission levels, see \"Repository permission levels for an organization\".
\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.
\nRate limits
\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
", "bodyParameters": [ { @@ -27943,9 +27697,7 @@ "categoryLabel": "Repos", "subcategory": "collaborators", "subcategoryLabel": "Collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -28023,9 +27775,7 @@ "categoryLabel": "Repos", "subcategory": "collaborators", "subcategoryLabel": "Collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Checks the repository permission of a collaborator. The possible repository permissions are admin, write, read, and none.
Commit Comments use these custom media types. You can read more about the use of media types in the API here.
\nComments are ordered by ascending ID.
", "responses": [ @@ -28216,9 +27964,7 @@ "categoryLabel": "Repos", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -28329,9 +28075,7 @@ "categoryLabel": "Repos", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -28426,9 +28170,7 @@ "categoryLabel": "Repos", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -28557,9 +28299,7 @@ "slug": "list-reactions-for-a-commit-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List the reactions to a commit comment.
", "responses": [ @@ -28690,9 +28430,7 @@ "slug": "create-reaction-for-a-commit-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Create a reaction to a commit comment. A response with a Status: 200 OK means that you already added the reaction type to this commit comment.
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.
", "responses": [ @@ -29096,9 +28830,7 @@ "categoryLabel": "Repos", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Use the :commit_sha to specify the commit that will have its comments listed.
Create a comment for a commit using its :commit_sha.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -29391,9 +29121,7 @@ "categoryLabel": "Repos", "subcategory": "commits", "subcategoryLabel": "Commits", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the List pull requests endpoint.
", "responses": [ @@ -29478,9 +29206,7 @@ "categoryLabel": "Repos", "subcategory": "commits", "subcategoryLabel": "Commits", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.
Note: If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
\nYou can pass the appropriate media type to fetch diff and patch formats. Diffs with binary data will have no patch property.
To return only the SHA-1 hash of the commit reference, you can provide the sha custom media type in the Accept header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.
Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.
\nThe most recent status for each context is returned, up to 100. This field paginates if there are over 100 contexts.
\nAdditionally, a combined state is returned. The state is one of:
error or failurependingsuccessUsers with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.
\nThis resource is also available via a legacy route: GET /repos/:owner/:repo/statuses/:ref.
This method returns the contents of the repository's code of conduct file, if one is detected.
", "responses": [ @@ -30133,9 +29849,7 @@ "categoryLabel": "Repos", "subcategory": "commits", "subcategoryLabel": "Commits", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Both :base and :head must be branch names in :repo. To compare branches across other repositories in the same network as :repo, use the format <USERNAME>:branch.
The response from the API is equivalent to running the git log base..head command; however, commits are returned in chronological order. Pass the appropriate media type to fetch diff and patch formats.
The response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.
Working with large comparisons
\nThe response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the List commits to enumerate all commits in the range.
\nFor comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long\nto generate. You can typically resolve this error by using a smaller commit range.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of all files in the repository.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNote:
\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
Creates a new file or replaces an existing file in a repository.
", "responses": [ { @@ -31034,9 +30744,7 @@ "categoryLabel": "Repos", "subcategory": "contents", "subcategoryLabel": "Contents", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Deletes a file in a repository.
\nYou can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.
The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.
You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.
Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.
\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.
", "responses": [ @@ -31450,9 +31156,7 @@ "categoryLabel": "Repos", "subcategory": "deployments", "subcategoryLabel": "Deployments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Simple filtering of deployments is available via query parameters:
", "responses": [ @@ -31666,9 +31370,7 @@ "categoryLabel": "Repos", "subcategory": "deployments", "subcategoryLabel": "Deployments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Deployments offer a few configurable parameters with certain defaults.
\nThe ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.
The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.
The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.
By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.
The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.
The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.
Users with repo or repo_deployment scopes can create a deployment for a given ref.
You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:
\nmaster in the response exampleIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.
\nThis error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.
This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.
Users with pull access can view deployment statuses for a deployment:
", "responses": [ @@ -32212,9 +31910,7 @@ "categoryLabel": "Repos", "subcategory": "deployments", "subcategoryLabel": "Deployments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Users with push access can create deployment statuses for a given deployment.
GitHub Apps require read & write access to \"Deployments\" and read-only access to \"Repo contents\" (for private repos). OAuth Apps require the repo_deployment scope.
Users with pull access can view a deployment status for a deployment:
", "responses": [ @@ -32511,9 +32205,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -32618,9 +32310,7 @@ "categoryLabel": "Repos", "subcategory": "forks", "subcategoryLabel": "Forks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -32715,9 +32405,7 @@ "categoryLabel": "Repos", "subcategory": "forks", "subcategoryLabel": "Forks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Create a fork for the authenticated user.
\nNote: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub Enterprise Server Support or GitHub Enterprise Server Premium Support.
", "bodyParameters": [ { @@ -32854,9 +32542,7 @@ "categoryLabel": "Git", "subcategory": "blobs", "subcategoryLabel": "Blobs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -32975,9 +32661,7 @@ "categoryLabel": "Git", "subcategory": "blobs", "subcategoryLabel": "Blobs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "The content in the response will always be Base64 encoded.
Note: This API supports blobs up to 100 megabytes in size.
", "responses": [ @@ -33275,9 +32959,7 @@ "categoryLabel": "Git", "subcategory": "commits", "subcategoryLabel": "Commits", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates a new Git commit object.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Gets a Git commit object.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.
", "bodyParameters": [ { @@ -33801,9 +33479,7 @@ "categoryLabel": "Git", "subcategory": "refs", "subcategoryLabel": "Refs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -33919,9 +33595,7 @@ "categoryLabel": "Git", "subcategory": "refs", "subcategoryLabel": "Refs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -34026,9 +33700,7 @@ "categoryLabel": "Git", "subcategory": "refs", "subcategoryLabel": "Refs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -34244,9 +33916,7 @@ "categoryLabel": "Git", "subcategory": "tags", "subcategoryLabel": "Tags", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary.
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.
\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"Create a commit\" and \"Update a reference.\"
", "responses": [ { @@ -34948,9 +34614,7 @@ "categoryLabel": "Git", "subcategory": "trees", "subcategoryLabel": "Trees", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns a single tree using the SHA1 value for that tree.
\nIf truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.
Repositories can have multiple webhooks installed. Each webhook should have a unique config. Multiple webhooks can\nshare the same config as long as those webhooks do not have any events that overlap.
Returns a webhook configured in a repository. To get only the webhook config properties, see \"Get a webhook configuration for a repository.\"
Updates a webhook configured in a repository. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use \"Update a webhook configuration for a repository.\"
When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.
", "responses": [ @@ -36648,9 +36296,7 @@ "categoryLabel": "Repos", "subcategory": "invitations", "subcategoryLabel": "Invitations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -36747,9 +36393,7 @@ "categoryLabel": "Repos", "subcategory": "invitations", "subcategoryLabel": "Invitations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -36949,9 +36593,7 @@ "slug": "list-repository-issues", "category": "issues", "categoryLabel": "Issues", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List issues in a repository.
\nNote: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.
Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -37390,9 +37030,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "By default, Issue Comments are ordered by ascending ID.
", "responses": [ @@ -37489,9 +37127,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -37602,9 +37238,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -37699,9 +37333,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -37825,9 +37457,7 @@ "slug": "list-reactions-for-an-issue-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List the reactions to an issue comment.
", "responses": [ @@ -37958,9 +37588,7 @@ "slug": "create-reaction-for-an-issue-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Create a reaction to an issue comment. A response with a Status: 200 OK means that you already added the reaction type to this issue comment.
The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.
Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.
Issue owners and users with push access can edit an issue.
", "bodyParameters": [ { @@ -38761,9 +38381,7 @@ "categoryLabel": "Issues", "subcategory": "assignees", "subcategoryLabel": "Assignees", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.
", "bodyParameters": [ { @@ -38885,9 +38503,7 @@ "categoryLabel": "Issues", "subcategory": "assignees", "subcategoryLabel": "Assignees", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Removes one or more assignees from an issue.
", "bodyParameters": [ { @@ -39017,9 +38633,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Issue Comments are ordered by ascending ID.
", "responses": [ @@ -39136,9 +38750,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -39281,9 +38893,7 @@ "categoryLabel": "Issues", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -39388,9 +38998,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -39507,9 +39115,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -39641,9 +39247,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Removes any previous labels and sets the new labels for an issue.
", "bodyParameters": [ { @@ -39746,9 +39350,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -39841,9 +39443,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a 404 Not Found status if the label does not exist.
List the reactions to an issue.
", "responses": [ @@ -40495,9 +40089,7 @@ "categoryLabel": "Issues", "subcategory": "timeline", "subcategoryLabel": "Timeline", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -40602,9 +40194,7 @@ "categoryLabel": "Repos", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -40720,9 +40310,7 @@ "categoryLabel": "Repos", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "You can create a read-only deploy key.
", "bodyParameters": [ { @@ -40835,9 +40423,7 @@ "categoryLabel": "Repos", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -40922,9 +40508,7 @@ "categoryLabel": "Repos", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -41013,9 +40597,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -41136,9 +40718,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -41255,9 +40835,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -41341,9 +40919,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -41410,9 +40986,7 @@ "slug": "list-repository-languages", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.
", "responses": [ @@ -41480,9 +41054,7 @@ "slug": "get-the-license-for-a-repository", "category": "licenses", "categoryLabel": "Licenses", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "This method returns the contents of the repository's license file, if one is detected.
\nSimilar to Get repository content, this method also supports custom media types for retrieving the raw license content or rendered license HTML.
", "responses": [ @@ -41599,9 +41171,7 @@ "categoryLabel": "Repos", "subcategory": "merging", "subcategoryLabel": "Merging", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -41793,9 +41363,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -41931,9 +41499,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -42065,9 +41631,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -42210,9 +41774,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -42334,9 +41896,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -42440,9 +42000,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -42743,9 +42301,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -42930,9 +42486,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Configures a GitHub Enterprise Server Pages site. For more information, see \"About GitHub Pages.\"
", "responses": [ { @@ -43162,9 +42716,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -43298,9 +42850,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -43404,9 +42954,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -43476,9 +43024,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.
\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.
", "responses": [ @@ -43548,9 +43094,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -43629,9 +43173,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -43728,9 +43270,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "repo-pre-receive-hooks", "subcategoryLabel": "Repo pre receive hooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.
", "responses": [ @@ -43816,9 +43356,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "repo-pre-receive-hooks", "subcategoryLabel": "Repo pre receive hooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -43927,9 +43465,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "repo-pre-receive-hooks", "subcategoryLabel": "Repo pre receive hooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "For pre-receive hooks which are allowed to be configured at the repo level, you can set enforcement
Deletes any overridden enforcement on this repository for the specified hook.
\nResponds with effective values inherited from owner and/or global level.
", "responses": [ @@ -44138,9 +43672,7 @@ "slug": "list-repository-projects", "category": "projects", "categoryLabel": "Projects", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the projects in a repository. Returns a 404 Not Found status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Creates a repository project board. Returns a 404 Not Found status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team, GitHub Enterprise Server 2.17+, and GitHub Enterprise Cloud.
", "responses": [ @@ -44666,9 +44194,7 @@ "slug": "create-a-pull-request", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team, GitHub Enterprise Server 2.17+, and GitHub Enterprise Cloud. You can create a new pull request. This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.
", "bodyParameters": [ { @@ -44884,9 +44410,7 @@ "categoryLabel": "Pulls", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nProvides details for a review comment.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nEnables you to edit a review comment.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.List the reactions to a pull request review comment.
", "responses": [ @@ -45455,9 +44971,7 @@ "slug": "create-reaction-for-a-pull-request-review-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Create a reaction to a pull request review comment. A response with a Status: 200 OK means that you already added the reaction type to this pull request review comment.
Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nLists details of a pull request by providing its number.
\nWhen you get, create, or edit a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".
The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.
The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:
merge_commit_sha represents the SHA of the merge commit.merge_commit_sha represents the SHA of the squashed commit on the base branch.merge_commit_sha represents the commit that the base branch was updated to.Pass the appropriate media type to fetch diff and patch formats.
", "responses": [ @@ -45742,9 +45254,7 @@ "slug": "update-a-pull-request", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team, GitHub Enterprise Server 2.17+, and GitHub Enterprise Cloud.
", "bodyParameters": [ { @@ -45955,9 +45465,7 @@ "categoryLabel": "Pulls", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\"
\nNote: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.
", "bodyParameters": [ { @@ -46321,9 +45827,7 @@ "slug": "list-commits-on-a-pull-request", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the List commits endpoint.
", "responses": [ @@ -46420,9 +45924,7 @@ "slug": "list-pull-requests-files", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
", "responses": [ @@ -46509,9 +46011,7 @@ "slug": "check-if-a-pull-request-has-been-merged", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -46645,9 +46145,7 @@ "slug": "merge-a-pull-request", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -46815,9 +46313,7 @@ "categoryLabel": "Pulls", "subcategory": "review-requests", "subcategoryLabel": "Review requests", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -46942,9 +46438,7 @@ "categoryLabel": "Pulls", "subcategory": "review-requests", "subcategoryLabel": "Review requests", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -47103,9 +46597,7 @@ "categoryLabel": "Pulls", "subcategory": "review-requests", "subcategoryLabel": "Review requests", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -47233,9 +46725,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "The list of reviews returns in chronological order.
", "responses": [ @@ -47522,9 +47012,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nPull request reviews created in the PENDING state do not include the submitted_at property in the response.
Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API v3 offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
Update the review summary comment with new text.
", "bodyParameters": [ { @@ -48036,9 +47520,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -48157,9 +47639,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List comments for a specific pull request review.
", "responses": [ @@ -48285,9 +47765,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
", "bodyParameters": [ { @@ -48442,9 +47920,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -48695,9 +48171,7 @@ "categoryLabel": "Repos", "subcategory": "contents", "subcategoryLabel": "Contents", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Gets the preferred README for a repository.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", "responses": [ @@ -48797,9 +48271,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the Repository Tags API.
\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.
", "responses": [ @@ -48953,9 +48425,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Users with push access to the repository can create a release.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -49097,9 +48567,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.
Users with push access to the repository can edit a release asset.
", "bodyParameters": [ { @@ -49346,9 +48812,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -49417,9 +48881,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "View the latest published full release for the repository.
\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the created_at attribute. The created_at attribute is the date of the commit used for the release, and not the date when the release was drafted or published.
Get a published release with the specified tag.
", "responses": [ @@ -49586,9 +49046,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.
Users with push access to the repository can edit a release.
", "bodyParameters": [ { @@ -49883,9 +49339,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -49984,9 +49438,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -50103,9 +49555,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nLists the people that have starred the repository.
\nYou can also find out when stars were created by passing the following custom media type via the Accept header:
Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
", "responses": [ @@ -50344,9 +49790,7 @@ "categoryLabel": "Repos", "subcategory": "statistics", "subcategoryLabel": "Statistics", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns the last year of commit activity grouped by week. The days array is a group of commits per day, starting on Sunday.
Returns the total number of commits authored by the contributor. In addition, the response includes a Weekly Hash (weeks array) with the following information:
w - Start of the week, given as a Unix timestamp.a - Number of additionsd - Number of deletionsc - Number of commitsReturns the total commit counts for the owner and total commit counts in all. all is everyone combined, including the owner in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract owner from all.
The array order is oldest week (index 0) to most recent week.
", "responses": [ @@ -50565,9 +50005,7 @@ "categoryLabel": "Repos", "subcategory": "statistics", "subcategoryLabel": "Statistics", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Each array contains the day number, hour number, and number of commits:
\n0-6: Sunday - Saturday0-23: Hour of dayFor example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.
Users with push access in a repository can create commit statuses for a given SHA.
\nNote: there is a limit of 1000 statuses per sha and context within a repository. Attempts to create more than 1000 statuses will result in a validation error.
Lists the people watching the specified repository.
", "responses": [ @@ -51202,9 +50636,7 @@ "slug": "list-repository-tags", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -51283,9 +50715,7 @@ "categoryLabel": "Repos", "subcategory": "contents", "subcategoryLabel": "Contents", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "302", @@ -51372,9 +50802,7 @@ "slug": "list-repository-teams", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -51449,9 +50877,7 @@ "slug": "get-all-repository-topics", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -51570,9 +50996,7 @@ "slug": "replace-all-repository-topics", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -51707,9 +51131,7 @@ "slug": "transfer-a-repository", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original owner, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see about repository transfers.
Lists all public repositories in the order that they were created.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.
Searches for query terms inside of a file. This method returns up to 100 results per page.
\nWhen searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:
q=addClass+in:file+language:js+repo:jquery/jquery
This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.
Due to the complexity of searching code, there are a few restrictions on how searches are performed:
\nmaster branch.language:go is not valid, while amazing language:go is.Find commits via various criteria on the default branch (usually master). This method returns up to 100 results per page.
When searching for commits, you can get text match metadata for the message field when you provide the text-match media type. For more details about how to receive highlighted search results, see Text match\nmetadata.
For example, if you want to find commits related to CSS in the octocat/Spoon-Knife repository. Your query would look something like this:
\nq=repo:octocat/Spoon-Knife+css
Find issues by state and keyword. This method returns up to 100 results per page.
\nWhen searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.
For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.
\nq=windows+label:bug+language:python+state:open&sort=created&order=asc
This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.
Note: For user-to-server GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"
Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results per page.
\nWhen searching for labels, you can get text match metadata for the label name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to find labels in the linguist repository that match bug, defect, or enhancement. Your query might look like this:
q=bug+defect+enhancement&repository_id=64778136
The labels that best match the query appear first in the search results.
", "responses": [ @@ -52879,9 +52285,7 @@ "slug": "search-repositories", "category": "search", "categoryLabel": "Search", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Find repositories via various criteria. This method returns up to 100 results per page.
\nWhen searching for repositories, you can get text match metadata for the name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:
\nq=tetris+language:assembly&sort=stars&order=desc
This query searches for repositories with the word tetris in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.
When you include the mercy preview header, you can also search for multiple topics by adding more topic: instances. For example, your query might look like this:
q=topic:ruby+topic:rails
Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results per page. See \"Searching topics\" for a detailed list of qualifiers.
\nWhen searching for topics, you can get text match metadata for the topic's short_description, description, name, or display_name field when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:
\nq=ruby+is:featured
This query searches for topics with the keyword ruby and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.
Find users via various criteria. This method returns up to 100 results per page.
\nWhen searching for users, you can get text match metadata for the issue login, email, and name fields when you pass the text-match media type. For more details about highlighting search results, see Text match metadata. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you're looking for a list of popular users, you might try this query:
\nq=tom+repos:%3E42+followers:%3E1000
This query searches for users with the name tom. The results are restricted to users with more than 42 repositories and over 1,000 followers.
To edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote: With nested teams, the privacy for parent teams cannot be secret.
List all discussions on a team's page. OAuth access tokens require the read:discussion scope.
Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.
", "bodyParameters": [ { @@ -54603,9 +53993,7 @@ "categoryLabel": "Teams", "subcategory": "discussions", "subcategoryLabel": "Discussions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Get a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.
Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion scope.
List all comments on a team discussion. OAuth access tokens require the read:discussion scope.
Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.
", "bodyParameters": [ { @@ -55208,9 +54588,7 @@ "categoryLabel": "Teams", "subcategory": "discussion-comments", "subcategoryLabel": "Discussion comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Get a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.
Edits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with a Status: 200 OK means that you already added the reaction type to this team discussion comment.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
If you pass the hellcat-preview media type, team members will include the members of child teams.
To list members in a team, the team must be visible to the authenticated user.
", "responses": [ @@ -56212,9 +55578,7 @@ "categoryLabel": "Teams", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -56291,9 +55655,7 @@ "categoryLabel": "Teams", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "The \"Add team member\" endpoint (described below) is deprecated.
\nWe recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.
\nNote: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
If you pass the hellcat-preview media type, team members will include the members of child teams.
To get a user's membership with a team, the team must be visible to the authenticated user.
\nNote: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create a team.
If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.
\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
", "bodyParameters": [ { @@ -56678,9 +56034,7 @@ "categoryLabel": "Teams", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -56782,9 +56136,7 @@ "slug": "list-team-projects", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the organization projects for a team. If you are an authenticated site administrator for your Enterprise instance, you will be able to list all projects for the team. If you pass the hellcat-preview media type, the response will include projects inherited from a parent team.
Checks whether a team has read, write, or admin permissions for an organization project. If you pass the hellcat-preview media type, the response will include projects inherited from a parent team.
Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.
Note: If you pass the hellcat-preview media type, the response will include any repositories inherited through a parent team.
If you are an authenticated site administrator for your Enterprise instance, you will be able to list all repositories for the team.
", "responses": [ @@ -57263,9 +56607,7 @@ "slug": "check-team-permissions-for-a-repository", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -57383,9 +56725,7 @@ "slug": "add-or-update-team-repository-permissions", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -57476,9 +56816,7 @@ "slug": "remove-a-repository-from-a-team", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -57563,9 +56901,7 @@ "slug": "list-child-teams", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "You must use the hellcat-preview media type to use this endpoint.
Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
Provides publicly available information about someone with a GitHub account.
\nGitHub Apps with the Plan user permission can use this endpoint to retrieve information about a user's GitHub Enterprise Server plan. The GitHub App must be authenticated as a user. See \"Identifying and authorizing users for GitHub Apps\" for details about authentication. For an example response, see 'Response with GitHub Enterprise Server plan information' below\"
The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.
The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".
", "responses": [ @@ -62269,9 +61599,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -62440,9 +61768,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -62522,9 +61848,7 @@ "categoryLabel": "Users", "subcategory": "followers", "subcategoryLabel": "Followers", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the people following the specified user.
", "responses": [ @@ -62605,9 +61929,7 @@ "categoryLabel": "Users", "subcategory": "followers", "subcategoryLabel": "Followers", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the people who the specified user follows.
", "responses": [ @@ -62677,9 +61999,7 @@ "categoryLabel": "Users", "subcategory": "followers", "subcategoryLabel": "Followers", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -62858,9 +62178,7 @@ "categoryLabel": "Users", "subcategory": "gpg-keys", "subcategoryLabel": "Gpg keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the GPG keys for a user. This information is accessible by anyone.
", "responses": [ @@ -63112,9 +62430,7 @@ "categoryLabel": "Users", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the verified public SSH keys for a user. This is accessible by anyone.
", "responses": [ @@ -63193,9 +62509,7 @@ "slug": "list-organizations-for-a-user", "category": "orgs", "categoryLabel": "Orgs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List public organization memberships for the specified user.
\nThis method only lists public memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the List organizations for the authenticated user API instead.
", "responses": [ @@ -63388,9 +62702,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -63470,9 +62782,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -63604,9 +62914,7 @@ "slug": "list-repositories-for-a-user", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists public repositories for the specified user.
", "responses": [ @@ -63837,9 +63145,7 @@ "categoryLabel": "Activity", "subcategory": "starring", "subcategoryLabel": "Starring", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists repositories a user has starred.
\nYou can also find out when stars were created by passing the following custom media type via the Accept header:
Lists repositories a user is watching.
", "responses": [ @@ -64146,9 +63450,7 @@ "slug": "get-the-zen-of-github", "category": "meta", "categoryLabel": "Meta", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", diff --git a/lib/rest/static/decorated/ghes-2.19.json b/lib/rest/static/decorated/ghes-2.19.json index 285b1c6f9db2..2c1ae65a2d32 100644 --- a/lib/rest/static/decorated/ghes-2.19.json +++ b/lib/rest/static/decorated/ghes-2.19.json @@ -31,9 +31,7 @@ "slug": "github-api-root", "category": "meta", "categoryLabel": "Meta", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -3534,9 +3532,7 @@ "slug": "get-the-authenticated-app", "category": "apps", "categoryLabel": "Apps", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count in the response. For more details about your app's installations, see the \"List installations for the authenticated app\" endpoint.
You must use a JWT to access this endpoint.
", "responses": [ @@ -3692,9 +3688,7 @@ "slug": "list-installations-for-the-authenticated-app", "category": "apps", "categoryLabel": "Apps", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "You must use a JWT to access this endpoint.
\nThe permissions the installation has are included under the permissions key.
Enables an authenticated GitHub App to find an installation's information using the installation id. The installation's account type (target_type) will be either an organization or a user account, depending which account the repository belongs to.
You must use a JWT to access this endpoint.
", "responses": [ @@ -4092,9 +4084,7 @@ "slug": "create-an-installation-access-token-for-an-app", "category": "apps", "categoryLabel": "Apps", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of 401 - Unauthorized, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the repository_ids when creating the token. When you omit repository_ids, the response does not contain the repositories key.
You must use a JWT to access this endpoint.
", "responses": [ { @@ -4837,9 +4827,7 @@ "slug": "get-an-app", "category": "apps", "categoryLabel": "Apps", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: The :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).
If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a personal access token or an installation access token to access this endpoint.
", "responses": [ @@ -5997,9 +5985,7 @@ "slug": "get-all-codes-of-conduct", "category": "codes-of-conduct", "categoryLabel": "Codes of conduct", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -6075,9 +6061,7 @@ "slug": "get-a-code-of-conduct", "category": "codes-of-conduct", "categoryLabel": "Codes of conduct", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -6197,9 +6181,7 @@ "categoryLabel": "Apps", "subcategory": "installations", "subcategoryLabel": "Installations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id of the content reference from the content_reference event to create an attachment.
The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.
\nYou must use an installation access token to access this endpoint.
", "bodyParameters": [ { @@ -6301,9 +6283,7 @@ "slug": "get-emojis", "category": "emojis", "categoryLabel": "Emojis", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -6491,9 +6471,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -6558,9 +6536,7 @@ "categoryLabel": "Activity", "subcategory": "feeds", "subcategoryLabel": "Feeds", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "GitHub Enterprise Server provides several timeline resources in Atom format. The Feeds API lists all the feeds available to the authenticated user:
\nNote: Private feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
", "responses": [ @@ -8491,9 +8467,7 @@ "slug": "get-all-gitignore-templates", "category": "gitignore", "categoryLabel": "Gitignore", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List all templates available to pass as an option when creating a repository.
", "responses": [ @@ -8557,9 +8531,7 @@ "slug": "get-a-gitignore-template", "category": "gitignore", "categoryLabel": "Gitignore", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "The API also allows fetching the source of a single template.\nUse the raw media type to get the raw contents.
", "responses": [ @@ -8660,9 +8632,7 @@ "categoryLabel": "Apps", "subcategory": "installations", "subcategoryLabel": "Installations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List repositories that an app installation can access.
\nYou must use an installation access token to access this endpoint.
", "responses": [ @@ -8958,9 +8928,7 @@ "slug": "get-all-commonly-used-licenses", "category": "licenses", "categoryLabel": "Licenses", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -9024,9 +8992,7 @@ "slug": "get-a-license", "category": "licenses", "categoryLabel": "Licenses", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -9137,9 +9103,7 @@ "slug": "render-a-markdown-document", "category": "markdown", "categoryLabel": "Markdown", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -9240,9 +9204,7 @@ "slug": "render-a-markdown-document-in-raw-mode", "category": "markdown", "categoryLabel": "Markdown", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -9295,9 +9257,7 @@ "slug": "get-github-enterprise-server-meta-information", "category": "meta", "categoryLabel": "Meta", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "This endpoint provides a list of GitHub's IP addresses. For more information, see \"About GitHub's IP addresses.\"
", "responses": [ @@ -9392,9 +9352,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -10132,9 +10090,7 @@ "slug": "get-octocat", "category": "meta", "categoryLabel": "Meta", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -10203,9 +10159,7 @@ "slug": "list-organizations", "category": "orgs", "categoryLabel": "Orgs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists all organizations, in the order that they were created on GitHub Enterprise Server.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
To see many of the organization response values, you need to be an authenticated organization owner with the admin:org scope. When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.
GitHub Apps with the Organization plan permission can use this endpoint to retrieve information about an organization's GitHub Enterprise Server plan. See \"Authenticating with GitHub Apps\" for details. For an example response, see 'Response with GitHub Enterprise Server plan information' below.\"
Parameter Deprecation Notice: GitHub Enterprise Server will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.
Enables an authenticated organization owner with the admin:org scope to update the organization's profile and member privileges.
Here's how you can create a hook that posts payloads in JSON format:
", "responses": [ { @@ -11417,9 +11361,7 @@ "categoryLabel": "Orgs", "subcategory": "webhooks", "subcategoryLabel": "Webhooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns a webhook configured in an organization. To get only the webhook config properties, see \"Get a webhook configuration for an organization.\"
Updates a webhook configured in an organization. When you update a webhook, the secret will be overwritten. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use \"Update a webhook configuration for an organization.\"
Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with admin:read scope to use this endpoint.
List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.
", "responses": [ @@ -12495,9 +12427,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -12576,9 +12506,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -12652,9 +12580,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "In order to get a user's membership with an organization, the authenticated user must be an organization member.
", "responses": [ @@ -12771,9 +12697,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Only authenticated organization owners can add a member to the organization or update the member's role.
\npending until they accept the invitation.role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.Rate limits
\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
", "bodyParameters": [ { @@ -12874,9 +12798,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -12981,9 +12903,7 @@ "categoryLabel": "Orgs", "subcategory": "outside-collaborators", "subcategoryLabel": "Outside collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List all users who are outside collaborators of an organization.
", "responses": [ @@ -13053,9 +12973,7 @@ "categoryLabel": "Orgs", "subcategory": "outside-collaborators", "subcategoryLabel": "Outside collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\".
", "responses": [ @@ -13146,9 +13064,7 @@ "categoryLabel": "Orgs", "subcategory": "outside-collaborators", "subcategoryLabel": "Outside collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Removing a user from this list will remove them from all the organization's repositories.
", "responses": [ @@ -13241,9 +13157,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "org-pre-receive-hooks", "subcategoryLabel": "Org pre receive hooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.
", "responses": [ @@ -13320,9 +13234,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "org-pre-receive-hooks", "subcategoryLabel": "Org pre receive hooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -13432,9 +13344,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "org-pre-receive-hooks", "subcategoryLabel": "Org pre receive hooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "For pre-receive hooks which are allowed to be configured at the org level, you can set enforcement and allow_downstream_configuration
Removes any overrides for this hook at the org level for this org.
", "responses": [ @@ -13634,9 +13542,7 @@ "slug": "list-organization-projects", "category": "projects", "categoryLabel": "Projects", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the projects in an organization. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Creates an organization project board. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Members of an organization can choose to have their membership publicized or not.
", "responses": [ @@ -13942,9 +13844,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -14233,9 +14133,7 @@ "slug": "list-organization-repositories", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists repositories for the specified organization.
", "responses": [ @@ -14499,9 +14397,7 @@ "slug": "create-an-organization-repository", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.
\nOAuth scope requirements
\nWhen using OAuth, authorizations must include:
\npublic_repo scope or repo scope to create a public repositoryrepo scope to create a private repositoryLists all teams in an organization that are visible to the authenticated user.
", "responses": [ @@ -14925,9 +14819,7 @@ "slug": "create-a-team", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "To create a team, the authenticated user must be a member or owner of {org}. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"Setting team creation permissions.\"
When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of maintainers. For more information, see \"About teams\".
Gets a team using the team's slug. GitHub Enterprise Server generates the slug from the team name.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key.
Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
Gets a project by its id. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Updates a project board's information. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project admin to list collaborators.
Returns the collaborator's permission level for an organization project. Possible values for the permission key: admin, write, read, none. You must be an organization owner or a project admin to review a user's permission level.
Note: Accessing this endpoint does not count against your REST API rate limit.
\nNote: The rate object is deprecated. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.
When you pass the scarlet-witch-preview media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file.
The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.
Note: To edit a repository's topics, use the Replace all repository topics endpoint.
", "bodyParameters": [ { @@ -18121,9 +17965,7 @@ "slug": "delete-a-repository", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Deleting a repository requires admin access. If OAuth is used, the delete_repo scope is required.
If an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a 403 Forbidden response.
Lists the available assignees for issues in a repository.
", "responses": [ @@ -18309,9 +18149,7 @@ "categoryLabel": "Issues", "subcategory": "assignees", "subcategoryLabel": "Assignees", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -18415,9 +18253,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -18508,9 +18344,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -18607,9 +18441,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "responses": [ @@ -19193,9 +19025,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -19734,9 +19564,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -19820,9 +19648,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "responses": [ @@ -19902,9 +19728,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
", "responses": [ @@ -19984,9 +19808,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -20077,9 +19899,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -20283,9 +20103,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
\nNote: Passing new arrays of users and teams replaces their previous values.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.
Note: You must enable branch protection to require signed commits.
", "responses": [ @@ -20652,9 +20466,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.
", "responses": [ @@ -20746,9 +20558,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -20832,9 +20642,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "responses": [ @@ -20957,9 +20765,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.
", "bodyParameters": [ { @@ -21071,9 +20877,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -21152,9 +20956,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "responses": [ @@ -21271,9 +21073,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "bodyParameters": [ { @@ -21413,9 +21213,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "bodyParameters": [ { @@ -21550,9 +21348,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "bodyParameters": [ { @@ -21655,9 +21451,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists who has access to this protected branch.
\nNote: Users, apps, and teams restrictions are only available for organization-owned repositories.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nGrants the specified apps push access for this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
| Type | Description |
|---|---|
array | The GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
| Type | Description |
|---|---|
array | The GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nRemoves the ability of an app to push to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
| Type | Description |
|---|---|
array | The GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists the teams who have push access to this branch. The list includes child teams.
", "responses": [ @@ -22425,9 +22207,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nGrants the specified teams push access for this branch. You can also give push access to child teams.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | The teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | The teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Teams that should no longer have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists the people who have push access to this branch.
", "responses": [ @@ -22908,9 +22682,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nGrants the specified people push access for this branch.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nRemoves the ability of a user to push to this branch.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames of the people who should no longer have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Creates a new check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to create check runs.
In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
", "responses": [ { @@ -25314,9 +25080,7 @@ "categoryLabel": "Checks", "subcategory": "runs", "subcategoryLabel": "Runs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Updates a check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to edit check runs.
Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"Update repository preferences for check suites\". Your GitHub App must have the checks:write permission to create check suites.
Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually Create a check suite. You must have admin permissions in the repository to set preferences for check suites.
", "responses": [ { @@ -27839,9 +27595,7 @@ "categoryLabel": "Checks", "subcategory": "suites", "subcategoryLabel": "Suites", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
\nTeam members will include the members of child teams.
", "responses": [ @@ -28270,9 +28018,7 @@ "categoryLabel": "Repos", "subcategory": "collaborators", "subcategoryLabel": "Collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -28393,9 +28139,7 @@ "categoryLabel": "Repos", "subcategory": "collaborators", "subcategoryLabel": "Collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nFor more information the permission levels, see \"Repository permission levels for an organization\".
\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.
\nRate limits
\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
", "bodyParameters": [ { @@ -28516,9 +28260,7 @@ "categoryLabel": "Repos", "subcategory": "collaborators", "subcategoryLabel": "Collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -28596,9 +28338,7 @@ "categoryLabel": "Repos", "subcategory": "collaborators", "subcategoryLabel": "Collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Checks the repository permission of a collaborator. The possible repository permissions are admin, write, read, and none.
Commit Comments use these custom media types. You can read more about the use of media types in the API here.
\nComments are ordered by ascending ID.
", "responses": [ @@ -28789,9 +28527,7 @@ "categoryLabel": "Repos", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -28902,9 +28638,7 @@ "categoryLabel": "Repos", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -28999,9 +28733,7 @@ "categoryLabel": "Repos", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -29130,9 +28862,7 @@ "slug": "list-reactions-for-a-commit-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List the reactions to a commit comment.
", "responses": [ @@ -29263,9 +28993,7 @@ "slug": "create-reaction-for-a-commit-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Create a reaction to a commit comment. A response with a Status: 200 OK means that you already added the reaction type to this commit comment.
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.
", "responses": [ @@ -29669,9 +29393,7 @@ "categoryLabel": "Repos", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Use the :commit_sha to specify the commit that will have its comments listed.
Create a comment for a commit using its :commit_sha.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -29964,9 +29684,7 @@ "categoryLabel": "Repos", "subcategory": "commits", "subcategoryLabel": "Commits", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the List pull requests endpoint.
", "responses": [ @@ -30051,9 +29769,7 @@ "categoryLabel": "Repos", "subcategory": "commits", "subcategoryLabel": "Commits", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.
Note: If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
\nYou can pass the appropriate media type to fetch diff and patch formats. Diffs with binary data will have no patch property.
To return only the SHA-1 hash of the commit reference, you can provide the sha custom media type in the Accept header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.
Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.
\nThe most recent status for each context is returned, up to 100. This field paginates if there are over 100 contexts.
\nAdditionally, a combined state is returned. The state is one of:
error or failurependingsuccessUsers with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.
\nThis resource is also available via a legacy route: GET /repos/:owner/:repo/statuses/:ref.
This method returns the contents of the repository's code of conduct file, if one is detected.
", "responses": [ @@ -30706,9 +30412,7 @@ "categoryLabel": "Repos", "subcategory": "commits", "subcategoryLabel": "Commits", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Both :base and :head must be branch names in :repo. To compare branches across other repositories in the same network as :repo, use the format <USERNAME>:branch.
The response from the API is equivalent to running the git log base..head command; however, commits are returned in chronological order. Pass the appropriate media type to fetch diff and patch formats.
The response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.
Working with large comparisons
\nThe response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the List commits to enumerate all commits in the range.
\nFor comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long\nto generate. You can typically resolve this error by using a smaller commit range.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of all files in the repository.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNote:
\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
Creates a new file or replaces an existing file in a repository.
", "responses": [ { @@ -31607,9 +31307,7 @@ "categoryLabel": "Repos", "subcategory": "contents", "subcategoryLabel": "Contents", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Deletes a file in a repository.
\nYou can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.
The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.
You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.
Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.
\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.
", "responses": [ @@ -32023,9 +31719,7 @@ "categoryLabel": "Repos", "subcategory": "deployments", "subcategoryLabel": "Deployments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Simple filtering of deployments is available via query parameters:
", "responses": [ @@ -32239,9 +31933,7 @@ "categoryLabel": "Repos", "subcategory": "deployments", "subcategoryLabel": "Deployments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Deployments offer a few configurable parameters with certain defaults.
\nThe ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.
The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.
The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.
By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.
The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.
The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.
Users with repo or repo_deployment scopes can create a deployment for a given ref.
You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:
\nmaster in the response exampleIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.
\nThis error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.
This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.
Users with pull access can view deployment statuses for a deployment:
", "responses": [ @@ -32785,9 +32473,7 @@ "categoryLabel": "Repos", "subcategory": "deployments", "subcategoryLabel": "Deployments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Users with push access can create deployment statuses for a given deployment.
GitHub Apps require read & write access to \"Deployments\" and read-only access to \"Repo contents\" (for private repos). OAuth Apps require the repo_deployment scope.
Users with pull access can view a deployment status for a deployment:
", "responses": [ @@ -33084,9 +32768,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -33191,9 +32873,7 @@ "categoryLabel": "Repos", "subcategory": "forks", "subcategoryLabel": "Forks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -33288,9 +32968,7 @@ "categoryLabel": "Repos", "subcategory": "forks", "subcategoryLabel": "Forks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Create a fork for the authenticated user.
\nNote: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub Enterprise Server Support or GitHub Enterprise Server Premium Support.
", "bodyParameters": [ { @@ -33427,9 +33105,7 @@ "categoryLabel": "Git", "subcategory": "blobs", "subcategoryLabel": "Blobs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -33548,9 +33224,7 @@ "categoryLabel": "Git", "subcategory": "blobs", "subcategoryLabel": "Blobs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "The content in the response will always be Base64 encoded.
Note: This API supports blobs up to 100 megabytes in size.
", "responses": [ @@ -33848,9 +33522,7 @@ "categoryLabel": "Git", "subcategory": "commits", "subcategoryLabel": "Commits", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates a new Git commit object.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Gets a Git commit object.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.
When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.
Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nIf you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.
Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.
Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
", "responses": [ @@ -34438,9 +34104,7 @@ "categoryLabel": "Git", "subcategory": "refs", "subcategoryLabel": "Refs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.
", "bodyParameters": [ { @@ -34590,9 +34254,7 @@ "categoryLabel": "Git", "subcategory": "refs", "subcategoryLabel": "Refs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -34697,9 +34359,7 @@ "categoryLabel": "Git", "subcategory": "refs", "subcategoryLabel": "Refs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -34915,9 +34575,7 @@ "categoryLabel": "Git", "subcategory": "tags", "subcategoryLabel": "Tags", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary.
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.
\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"Create a commit\" and \"Update a reference.\"
", "responses": [ { @@ -35619,9 +35273,7 @@ "categoryLabel": "Git", "subcategory": "trees", "subcategoryLabel": "Trees", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns a single tree using the SHA1 value for that tree.
\nIf truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.
Repositories can have multiple webhooks installed. Each webhook should have a unique config. Multiple webhooks can\nshare the same config as long as those webhooks do not have any events that overlap.
Returns a webhook configured in a repository. To get only the webhook config properties, see \"Get a webhook configuration for a repository.\"
Updates a webhook configured in a repository. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use \"Update a webhook configuration for a repository.\"
When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.
", "responses": [ @@ -37319,9 +36955,7 @@ "categoryLabel": "Repos", "subcategory": "invitations", "subcategoryLabel": "Invitations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -37418,9 +37052,7 @@ "categoryLabel": "Repos", "subcategory": "invitations", "subcategoryLabel": "Invitations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -37620,9 +37252,7 @@ "slug": "list-repository-issues", "category": "issues", "categoryLabel": "Issues", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List issues in a repository.
\nNote: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.
Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -38061,9 +37689,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "By default, Issue Comments are ordered by ascending ID.
", "responses": [ @@ -38160,9 +37786,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -38273,9 +37897,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -38370,9 +37992,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -38496,9 +38116,7 @@ "slug": "list-reactions-for-an-issue-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List the reactions to an issue comment.
", "responses": [ @@ -38629,9 +38247,7 @@ "slug": "create-reaction-for-an-issue-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Create a reaction to an issue comment. A response with a Status: 200 OK means that you already added the reaction type to this issue comment.
The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.
Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.
Issue owners and users with push access can edit an issue.
", "bodyParameters": [ { @@ -39432,9 +39040,7 @@ "categoryLabel": "Issues", "subcategory": "assignees", "subcategoryLabel": "Assignees", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.
", "bodyParameters": [ { @@ -39556,9 +39162,7 @@ "categoryLabel": "Issues", "subcategory": "assignees", "subcategoryLabel": "Assignees", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Removes one or more assignees from an issue.
", "bodyParameters": [ { @@ -39688,9 +39292,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Issue Comments are ordered by ascending ID.
", "responses": [ @@ -39807,9 +39409,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -39952,9 +39552,7 @@ "categoryLabel": "Issues", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -40059,9 +39657,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -40178,9 +39774,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -40312,9 +39906,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Removes any previous labels and sets the new labels for an issue.
", "bodyParameters": [ { @@ -40417,9 +40009,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -40512,9 +40102,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a 404 Not Found status if the label does not exist.
List the reactions to an issue.
", "responses": [ @@ -41166,9 +40748,7 @@ "categoryLabel": "Issues", "subcategory": "timeline", "subcategoryLabel": "Timeline", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -41273,9 +40853,7 @@ "categoryLabel": "Repos", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -41391,9 +40969,7 @@ "categoryLabel": "Repos", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "You can create a read-only deploy key.
", "bodyParameters": [ { @@ -41506,9 +41082,7 @@ "categoryLabel": "Repos", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -41593,9 +41167,7 @@ "categoryLabel": "Repos", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -41684,9 +41256,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -41807,9 +41377,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -41926,9 +41494,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -42055,9 +41621,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -42164,9 +41728,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -42233,9 +41795,7 @@ "slug": "list-repository-languages", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.
", "responses": [ @@ -42303,9 +41863,7 @@ "slug": "get-the-license-for-a-repository", "category": "licenses", "categoryLabel": "Licenses", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "This method returns the contents of the repository's license file, if one is detected.
\nSimilar to Get repository content, this method also supports custom media types for retrieving the raw license content or rendered license HTML.
", "responses": [ @@ -42422,9 +41980,7 @@ "categoryLabel": "Repos", "subcategory": "merging", "subcategoryLabel": "Merging", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -42616,9 +42172,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -42754,9 +42308,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -42888,9 +42440,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -43033,9 +42583,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -43157,9 +42705,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -43263,9 +42809,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -43566,9 +43110,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -43747,9 +43289,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Configures a GitHub Enterprise Server Pages site. For more information, see \"About GitHub Pages.\"
", "responses": [ { @@ -43972,9 +43512,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -44108,9 +43646,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -44214,9 +43750,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -44286,9 +43820,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.
\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.
", "responses": [ @@ -44358,9 +43890,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -44439,9 +43969,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -44538,9 +44066,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "repo-pre-receive-hooks", "subcategoryLabel": "Repo pre receive hooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.
", "responses": [ @@ -44626,9 +44152,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "repo-pre-receive-hooks", "subcategoryLabel": "Repo pre receive hooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -44737,9 +44261,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "repo-pre-receive-hooks", "subcategoryLabel": "Repo pre receive hooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "For pre-receive hooks which are allowed to be configured at the repo level, you can set enforcement
Deletes any overridden enforcement on this repository for the specified hook.
\nResponds with effective values inherited from owner and/or global level.
", "responses": [ @@ -44948,9 +44468,7 @@ "slug": "list-repository-projects", "category": "projects", "categoryLabel": "Projects", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the projects in a repository. Returns a 404 Not Found status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Creates a repository project board. Returns a 404 Not Found status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team, GitHub Enterprise Server 2.17+, and GitHub Enterprise Cloud.
", "responses": [ @@ -45476,9 +44990,7 @@ "slug": "create-a-pull-request", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team, GitHub Enterprise Server 2.17+, and GitHub Enterprise Cloud. You can create a new pull request. This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.
", "bodyParameters": [ { @@ -45694,9 +45206,7 @@ "categoryLabel": "Pulls", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nProvides details for a review comment.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nEnables you to edit a review comment.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.List the reactions to a pull request review comment.
", "responses": [ @@ -46265,9 +45767,7 @@ "slug": "create-reaction-for-a-pull-request-review-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Create a reaction to a pull request review comment. A response with a Status: 200 OK means that you already added the reaction type to this pull request review comment.
Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nLists details of a pull request by providing its number.
\nWhen you get, create, or edit a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".
The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.
The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:
merge_commit_sha represents the SHA of the merge commit.merge_commit_sha represents the SHA of the squashed commit on the base branch.merge_commit_sha represents the commit that the base branch was updated to.Pass the appropriate media type to fetch diff and patch formats.
", "responses": [ @@ -46552,9 +46050,7 @@ "slug": "update-a-pull-request", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team, GitHub Enterprise Server 2.17+, and GitHub Enterprise Cloud.
", "bodyParameters": [ { @@ -46765,9 +46261,7 @@ "categoryLabel": "Pulls", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\"
\nNote: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.
", "bodyParameters": [ { @@ -47131,9 +46623,7 @@ "slug": "list-commits-on-a-pull-request", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the List commits endpoint.
", "responses": [ @@ -47230,9 +46720,7 @@ "slug": "list-pull-requests-files", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
", "responses": [ @@ -47319,9 +46807,7 @@ "slug": "check-if-a-pull-request-has-been-merged", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -47455,9 +46941,7 @@ "slug": "merge-a-pull-request", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -47625,9 +47109,7 @@ "categoryLabel": "Pulls", "subcategory": "review-requests", "subcategoryLabel": "Review requests", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -47752,9 +47234,7 @@ "categoryLabel": "Pulls", "subcategory": "review-requests", "subcategoryLabel": "Review requests", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -47913,9 +47393,7 @@ "categoryLabel": "Pulls", "subcategory": "review-requests", "subcategoryLabel": "Review requests", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -48043,9 +47521,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "The list of reviews returns in chronological order.
", "responses": [ @@ -48332,9 +47808,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nPull request reviews created in the PENDING state do not include the submitted_at property in the response.
Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API v3 offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
Update the review summary comment with new text.
", "bodyParameters": [ { @@ -48846,9 +48316,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -48967,9 +48435,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List comments for a specific pull request review.
", "responses": [ @@ -49095,9 +48561,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
", "bodyParameters": [ { @@ -49252,9 +48716,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -49505,9 +48967,7 @@ "categoryLabel": "Repos", "subcategory": "contents", "subcategoryLabel": "Contents", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Gets the preferred README for a repository.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", "responses": [ @@ -49607,9 +49067,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the Repository Tags API.
\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.
", "responses": [ @@ -49763,9 +49221,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Users with push access to the repository can create a release.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -49907,9 +49363,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.
Users with push access to the repository can edit a release asset.
", "bodyParameters": [ { @@ -50156,9 +49608,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -50227,9 +49677,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "View the latest published full release for the repository.
\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the created_at attribute. The created_at attribute is the date of the commit used for the release, and not the date when the release was drafted or published.
Get a published release with the specified tag.
", "responses": [ @@ -50396,9 +49842,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.
Users with push access to the repository can edit a release.
", "bodyParameters": [ { @@ -50693,9 +50135,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -50794,9 +50234,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -50913,9 +50351,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nLists the people that have starred the repository.
\nYou can also find out when stars were created by passing the following custom media type via the Accept header:
Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
", "responses": [ @@ -51154,9 +50586,7 @@ "categoryLabel": "Repos", "subcategory": "statistics", "subcategoryLabel": "Statistics", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns the last year of commit activity grouped by week. The days array is a group of commits per day, starting on Sunday.
Returns the total number of commits authored by the contributor. In addition, the response includes a Weekly Hash (weeks array) with the following information:
w - Start of the week, given as a Unix timestamp.a - Number of additionsd - Number of deletionsc - Number of commitsReturns the total commit counts for the owner and total commit counts in all. all is everyone combined, including the owner in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract owner from all.
The array order is oldest week (index 0) to most recent week.
", "responses": [ @@ -51375,9 +50801,7 @@ "categoryLabel": "Repos", "subcategory": "statistics", "subcategoryLabel": "Statistics", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Each array contains the day number, hour number, and number of commits:
\n0-6: Sunday - Saturday0-23: Hour of dayFor example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.
Users with push access in a repository can create commit statuses for a given SHA.
\nNote: there is a limit of 1000 statuses per sha and context within a repository. Attempts to create more than 1000 statuses will result in a validation error.
Lists the people watching the specified repository.
", "responses": [ @@ -52012,9 +51432,7 @@ "slug": "list-repository-tags", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -52093,9 +51511,7 @@ "categoryLabel": "Repos", "subcategory": "contents", "subcategoryLabel": "Contents", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "302", @@ -52182,9 +51598,7 @@ "slug": "list-repository-teams", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -52259,9 +51673,7 @@ "slug": "get-all-repository-topics", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -52380,9 +51792,7 @@ "slug": "replace-all-repository-topics", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -52517,9 +51927,7 @@ "slug": "transfer-a-repository", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original owner, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see about repository transfers.
Lists all public repositories in the order that they were created.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.
Searches for query terms inside of a file. This method returns up to 100 results per page.
\nWhen searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:
q=addClass+in:file+language:js+repo:jquery/jquery
This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.
Due to the complexity of searching code, there are a few restrictions on how searches are performed:
\nmaster branch.language:go is not valid, while amazing language:go is.Find commits via various criteria on the default branch (usually master). This method returns up to 100 results per page.
When searching for commits, you can get text match metadata for the message field when you provide the text-match media type. For more details about how to receive highlighted search results, see Text match\nmetadata.
For example, if you want to find commits related to CSS in the octocat/Spoon-Knife repository. Your query would look something like this:
\nq=repo:octocat/Spoon-Knife+css
Find issues by state and keyword. This method returns up to 100 results per page.
\nWhen searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.
For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.
\nq=windows+label:bug+language:python+state:open&sort=created&order=asc
This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.
Note: For user-to-server GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"
Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results per page.
\nWhen searching for labels, you can get text match metadata for the label name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to find labels in the linguist repository that match bug, defect, or enhancement. Your query might look like this:
q=bug+defect+enhancement&repository_id=64778136
The labels that best match the query appear first in the search results.
", "responses": [ @@ -53689,9 +53081,7 @@ "slug": "search-repositories", "category": "search", "categoryLabel": "Search", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Find repositories via various criteria. This method returns up to 100 results per page.
\nWhen searching for repositories, you can get text match metadata for the name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:
\nq=tetris+language:assembly&sort=stars&order=desc
This query searches for repositories with the word tetris in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.
When you include the mercy preview header, you can also search for multiple topics by adding more topic: instances. For example, your query might look like this:
q=topic:ruby+topic:rails
Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results per page. See \"Searching topics\" for a detailed list of qualifiers.
\nWhen searching for topics, you can get text match metadata for the topic's short_description, description, name, or display_name field when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:
\nq=ruby+is:featured
This query searches for topics with the keyword ruby and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.
Find users via various criteria. This method returns up to 100 results per page.
\nWhen searching for users, you can get text match metadata for the issue login, email, and name fields when you pass the text-match media type. For more details about highlighting search results, see Text match metadata. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you're looking for a list of popular users, you might try this query:
\nq=tom+repos:%3E42+followers:%3E1000
This query searches for users with the name tom. The results are restricted to users with more than 42 repositories and over 1,000 followers.
To edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote: With nested teams, the privacy for parent teams cannot be secret.
List all discussions on a team's page. OAuth access tokens require the read:discussion scope.
Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.
", "bodyParameters": [ { @@ -55359,9 +54735,7 @@ "categoryLabel": "Teams", "subcategory": "discussions", "subcategoryLabel": "Discussions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Get a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.
Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion scope.
List all comments on a team discussion. OAuth access tokens require the read:discussion scope.
Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.
", "bodyParameters": [ { @@ -55874,9 +55240,7 @@ "categoryLabel": "Teams", "subcategory": "discussion-comments", "subcategoryLabel": "Discussion comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Get a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.
Edits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with a Status: 200 OK means that you already added the reaction type to this team discussion comment.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
If you pass the hellcat-preview media type, team members will include the members of child teams.
To list members in a team, the team must be visible to the authenticated user.
", "responses": [ @@ -56810,9 +56162,7 @@ "categoryLabel": "Teams", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -56889,9 +56239,7 @@ "categoryLabel": "Teams", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "The \"Add team member\" endpoint (described below) is deprecated.
\nWe recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.
\nNote: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
If you pass the hellcat-preview media type, team members will include the members of child teams.
To get a user's membership with a team, the team must be visible to the authenticated user.
\nNote: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create a team.
If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.
\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
", "bodyParameters": [ { @@ -57276,9 +56618,7 @@ "categoryLabel": "Teams", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -57380,9 +56720,7 @@ "slug": "list-team-projects", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the organization projects for a team. If you are an authenticated site administrator for your Enterprise instance, you will be able to list all projects for the team. If you pass the hellcat-preview media type, the response will include projects inherited from a parent team.
Checks whether a team has read, write, or admin permissions for an organization project. If you pass the hellcat-preview media type, the response will include projects inherited from a parent team.
Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.
Note: If you pass the hellcat-preview media type, the response will include any repositories inherited through a parent team.
If you are an authenticated site administrator for your Enterprise instance, you will be able to list all repositories for the team.
", "responses": [ @@ -57861,9 +57191,7 @@ "slug": "check-team-permissions-for-a-repository", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -57981,9 +57309,7 @@ "slug": "add-or-update-team-repository-permissions", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -58074,9 +57400,7 @@ "slug": "remove-a-repository-from-a-team", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -58161,9 +57485,7 @@ "slug": "list-child-teams", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "You must use the hellcat-preview media type to use this endpoint.
Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
Provides publicly available information about someone with a GitHub account.
\nGitHub Apps with the Plan user permission can use this endpoint to retrieve information about a user's GitHub Enterprise Server plan. The GitHub App must be authenticated as a user. See \"Identifying and authorizing users for GitHub Apps\" for details about authentication. For an example response, see 'Response with GitHub Enterprise Server plan information' below\"
The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.
The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".
", "responses": [ @@ -62867,9 +62183,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -63038,9 +62352,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -63120,9 +62432,7 @@ "categoryLabel": "Users", "subcategory": "followers", "subcategoryLabel": "Followers", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the people following the specified user.
", "responses": [ @@ -63203,9 +62513,7 @@ "categoryLabel": "Users", "subcategory": "followers", "subcategoryLabel": "Followers", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the people who the specified user follows.
", "responses": [ @@ -63275,9 +62583,7 @@ "categoryLabel": "Users", "subcategory": "followers", "subcategoryLabel": "Followers", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -63456,9 +62762,7 @@ "categoryLabel": "Users", "subcategory": "gpg-keys", "subcategoryLabel": "Gpg keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the GPG keys for a user. This information is accessible by anyone.
", "responses": [ @@ -63710,9 +63014,7 @@ "categoryLabel": "Users", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the verified public SSH keys for a user. This is accessible by anyone.
", "responses": [ @@ -63791,9 +63093,7 @@ "slug": "list-organizations-for-a-user", "category": "orgs", "categoryLabel": "Orgs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List public organization memberships for the specified user.
\nThis method only lists public memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the List organizations for the authenticated user API instead.
", "responses": [ @@ -63986,9 +63286,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -64068,9 +63366,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -64202,9 +63498,7 @@ "slug": "list-repositories-for-a-user", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists public repositories for the specified user.
", "responses": [ @@ -64435,9 +63729,7 @@ "categoryLabel": "Activity", "subcategory": "starring", "subcategoryLabel": "Starring", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists repositories a user has starred.
\nYou can also find out when stars were created by passing the following custom media type via the Accept header:
Lists repositories a user is watching.
", "responses": [ @@ -64744,9 +64034,7 @@ "slug": "get-the-zen-of-github", "category": "meta", "categoryLabel": "Meta", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", diff --git a/lib/rest/static/decorated/ghes-2.20.json b/lib/rest/static/decorated/ghes-2.20.json index 9abf62da4863..4cfca802191c 100644 --- a/lib/rest/static/decorated/ghes-2.20.json +++ b/lib/rest/static/decorated/ghes-2.20.json @@ -31,9 +31,7 @@ "slug": "github-api-root", "category": "meta", "categoryLabel": "Meta", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -3527,9 +3525,7 @@ "slug": "get-the-authenticated-app", "category": "apps", "categoryLabel": "Apps", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count in the response. For more details about your app's installations, see the \"List installations for the authenticated app\" endpoint.
You must use a JWT to access this endpoint.
", "responses": [ @@ -3685,9 +3681,7 @@ "slug": "list-installations-for-the-authenticated-app", "category": "apps", "categoryLabel": "Apps", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "You must use a JWT to access this endpoint.
\nThe permissions the installation has are included under the permissions key.
Enables an authenticated GitHub App to find an installation's information using the installation id. The installation's account type (target_type) will be either an organization or a user account, depending which account the repository belongs to.
You must use a JWT to access this endpoint.
", "responses": [ @@ -4085,9 +4077,7 @@ "slug": "create-an-installation-access-token-for-an-app", "category": "apps", "categoryLabel": "Apps", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of 401 - Unauthorized, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the repository_ids when creating the token. When you omit repository_ids, the response does not contain the repositories key.
You must use a JWT to access this endpoint.
", "responses": [ { @@ -5254,9 +5244,7 @@ "slug": "get-an-app", "category": "apps", "categoryLabel": "Apps", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: The :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).
If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a personal access token or an installation access token to access this endpoint.
", "responses": [ @@ -6414,9 +6402,7 @@ "slug": "get-all-codes-of-conduct", "category": "codes-of-conduct", "categoryLabel": "Codes of conduct", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -6492,9 +6478,7 @@ "slug": "get-a-code-of-conduct", "category": "codes-of-conduct", "categoryLabel": "Codes of conduct", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -6614,9 +6598,7 @@ "categoryLabel": "Apps", "subcategory": "installations", "subcategoryLabel": "Installations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id of the content reference from the content_reference event to create an attachment.
The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.
\nYou must use an installation access token to access this endpoint.
", "bodyParameters": [ { @@ -6718,9 +6700,7 @@ "slug": "get-emojis", "category": "emojis", "categoryLabel": "Emojis", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -6908,9 +6888,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -6975,9 +6953,7 @@ "categoryLabel": "Activity", "subcategory": "feeds", "subcategoryLabel": "Feeds", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "GitHub Enterprise Server provides several timeline resources in Atom format. The Feeds API lists all the feeds available to the authenticated user:
\nNote: Private feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
", "responses": [ @@ -8908,9 +8884,7 @@ "slug": "get-all-gitignore-templates", "category": "gitignore", "categoryLabel": "Gitignore", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List all templates available to pass as an option when creating a repository.
", "responses": [ @@ -8974,9 +8948,7 @@ "slug": "get-a-gitignore-template", "category": "gitignore", "categoryLabel": "Gitignore", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "The API also allows fetching the source of a single template.\nUse the raw media type to get the raw contents.
", "responses": [ @@ -9077,9 +9049,7 @@ "categoryLabel": "Apps", "subcategory": "installations", "subcategoryLabel": "Installations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List repositories that an app installation can access.
\nYou must use an installation access token to access this endpoint.
", "responses": [ @@ -9145,9 +9115,7 @@ "categoryLabel": "Apps", "subcategory": "installations", "subcategoryLabel": "Installations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -9427,9 +9395,7 @@ "slug": "get-all-commonly-used-licenses", "category": "licenses", "categoryLabel": "Licenses", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -9493,9 +9459,7 @@ "slug": "get-a-license", "category": "licenses", "categoryLabel": "Licenses", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -9606,9 +9570,7 @@ "slug": "render-a-markdown-document", "category": "markdown", "categoryLabel": "Markdown", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -9709,9 +9671,7 @@ "slug": "render-a-markdown-document-in-raw-mode", "category": "markdown", "categoryLabel": "Markdown", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -9764,9 +9724,7 @@ "slug": "get-github-enterprise-server-meta-information", "category": "meta", "categoryLabel": "Meta", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "This endpoint provides a list of GitHub's IP addresses. For more information, see \"About GitHub's IP addresses.\"
", "responses": [ @@ -9861,9 +9819,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -10601,9 +10557,7 @@ "slug": "get-octocat", "category": "meta", "categoryLabel": "Meta", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -10672,9 +10626,7 @@ "slug": "list-organizations", "category": "orgs", "categoryLabel": "Orgs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists all organizations, in the order that they were created on GitHub Enterprise Server.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
To see many of the organization response values, you need to be an authenticated organization owner with the admin:org scope. When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.
GitHub Apps with the Organization plan permission can use this endpoint to retrieve information about an organization's GitHub Enterprise Server plan. See \"Authenticating with GitHub Apps\" for details. For an example response, see 'Response with GitHub Enterprise Server plan information' below.\"
Parameter Deprecation Notice: GitHub Enterprise Server will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.
Enables an authenticated organization owner with the admin:org scope to update the organization's profile and member privileges.
Here's how you can create a hook that posts payloads in JSON format:
", "responses": [ { @@ -11886,9 +11828,7 @@ "categoryLabel": "Orgs", "subcategory": "webhooks", "subcategoryLabel": "Webhooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns a webhook configured in an organization. To get only the webhook config properties, see \"Get a webhook configuration for an organization.\"
Updates a webhook configured in an organization. When you update a webhook, the secret will be overwritten. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use \"Update a webhook configuration for an organization.\"
Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with admin:read scope to use this endpoint.
List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.
", "responses": [ @@ -12964,9 +12894,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -13045,9 +12973,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -13121,9 +13047,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "In order to get a user's membership with an organization, the authenticated user must be an organization member.
", "responses": [ @@ -13240,9 +13164,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Only authenticated organization owners can add a member to the organization or update the member's role.
\npending until they accept the invitation.role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.Rate limits
\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
", "bodyParameters": [ { @@ -13343,9 +13265,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -13450,9 +13370,7 @@ "categoryLabel": "Orgs", "subcategory": "outside-collaborators", "subcategoryLabel": "Outside collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List all users who are outside collaborators of an organization.
", "responses": [ @@ -13522,9 +13440,7 @@ "categoryLabel": "Orgs", "subcategory": "outside-collaborators", "subcategoryLabel": "Outside collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\".
", "responses": [ @@ -13615,9 +13531,7 @@ "categoryLabel": "Orgs", "subcategory": "outside-collaborators", "subcategoryLabel": "Outside collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Removing a user from this list will remove them from all the organization's repositories.
", "responses": [ @@ -13710,9 +13624,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "org-pre-receive-hooks", "subcategoryLabel": "Org pre receive hooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.
", "responses": [ @@ -13789,9 +13701,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "org-pre-receive-hooks", "subcategoryLabel": "Org pre receive hooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -13901,9 +13811,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "org-pre-receive-hooks", "subcategoryLabel": "Org pre receive hooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "For pre-receive hooks which are allowed to be configured at the org level, you can set enforcement and allow_downstream_configuration
Removes any overrides for this hook at the org level for this org.
", "responses": [ @@ -14103,9 +14009,7 @@ "slug": "list-organization-projects", "category": "projects", "categoryLabel": "Projects", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the projects in an organization. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Creates an organization project board. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Members of an organization can choose to have their membership publicized or not.
", "responses": [ @@ -14411,9 +14311,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -14702,9 +14600,7 @@ "slug": "list-organization-repositories", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists repositories for the specified organization.
", "responses": [ @@ -14968,9 +14864,7 @@ "slug": "create-an-organization-repository", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.
\nOAuth scope requirements
\nWhen using OAuth, authorizations must include:
\npublic_repo scope or repo scope to create a public repositoryrepo scope to create a private repositoryLists all teams in an organization that are visible to the authenticated user.
", "responses": [ @@ -15394,9 +15286,7 @@ "slug": "create-a-team", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "To create a team, the authenticated user must be a member or owner of {org}. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"Setting team creation permissions.\"
When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of maintainers. For more information, see \"About teams\".
Gets a team using the team's slug. GitHub Enterprise Server generates the slug from the team name.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key.
Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
Gets a project by its id. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Updates a project board's information. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project admin to list collaborators.
Returns the collaborator's permission level for an organization project. Possible values for the permission key: admin, write, read, none. You must be an organization owner or a project admin to review a user's permission level.
Note: Accessing this endpoint does not count against your REST API rate limit.
\nNote: The rate object is deprecated. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.
When you pass the scarlet-witch-preview media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file.
The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.
Note: To edit a repository's topics, use the Replace all repository topics endpoint.
", "bodyParameters": [ { @@ -18590,9 +18432,7 @@ "slug": "delete-a-repository", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Deleting a repository requires admin access. If OAuth is used, the delete_repo scope is required.
If an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a 403 Forbidden response.
Lists the available assignees for issues in a repository.
", "responses": [ @@ -18778,9 +18616,7 @@ "categoryLabel": "Issues", "subcategory": "assignees", "subcategoryLabel": "Assignees", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -18884,9 +18720,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -18977,9 +18811,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -19076,9 +18908,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "responses": [ @@ -19662,9 +19492,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -20203,9 +20031,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -20289,9 +20115,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "responses": [ @@ -20371,9 +20195,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
", "responses": [ @@ -20453,9 +20275,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -20546,9 +20366,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -20752,9 +20570,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
\nNote: Passing new arrays of users and teams replaces their previous values.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.
Note: You must enable branch protection to require signed commits.
", "responses": [ @@ -21121,9 +20933,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.
", "responses": [ @@ -21215,9 +21025,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -21301,9 +21109,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "responses": [ @@ -21426,9 +21232,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.
", "bodyParameters": [ { @@ -21540,9 +21344,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -21621,9 +21423,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "responses": [ @@ -21740,9 +21540,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "bodyParameters": [ { @@ -21882,9 +21680,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "bodyParameters": [ { @@ -22019,9 +21815,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "bodyParameters": [ { @@ -22124,9 +21918,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists who has access to this protected branch.
\nNote: Users, apps, and teams restrictions are only available for organization-owned repositories.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nGrants the specified apps push access for this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
| Type | Description |
|---|---|
array | The GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
| Type | Description |
|---|---|
array | The GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nRemoves the ability of an app to push to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
| Type | Description |
|---|---|
array | The GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists the teams who have push access to this branch. The list includes child teams.
", "responses": [ @@ -22894,9 +22674,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nGrants the specified teams push access for this branch. You can also give push access to child teams.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | The teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | The teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Teams that should no longer have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists the people who have push access to this branch.
", "responses": [ @@ -23377,9 +23149,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nGrants the specified people push access for this branch.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nRemoves the ability of a user to push to this branch.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames of the people who should no longer have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Creates a new check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to create check runs.
In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
", "responses": [ { @@ -25783,9 +25547,7 @@ "categoryLabel": "Checks", "subcategory": "runs", "subcategoryLabel": "Runs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Updates a check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to edit check runs.
Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"Update repository preferences for check suites\". Your GitHub App must have the checks:write permission to create check suites.
Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually Create a check suite. You must have admin permissions in the repository to set preferences for check suites.
", "responses": [ { @@ -28308,9 +28062,7 @@ "categoryLabel": "Checks", "subcategory": "suites", "subcategoryLabel": "Suites", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
\nTeam members will include the members of child teams.
", "responses": [ @@ -28739,9 +28485,7 @@ "categoryLabel": "Repos", "subcategory": "collaborators", "subcategoryLabel": "Collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -28862,9 +28606,7 @@ "categoryLabel": "Repos", "subcategory": "collaborators", "subcategoryLabel": "Collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nFor more information the permission levels, see \"Repository permission levels for an organization\".
\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.
\nRate limits
\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
", "bodyParameters": [ { @@ -28985,9 +28727,7 @@ "categoryLabel": "Repos", "subcategory": "collaborators", "subcategoryLabel": "Collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -29065,9 +28805,7 @@ "categoryLabel": "Repos", "subcategory": "collaborators", "subcategoryLabel": "Collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Checks the repository permission of a collaborator. The possible repository permissions are admin, write, read, and none.
Commit Comments use these custom media types. You can read more about the use of media types in the API here.
\nComments are ordered by ascending ID.
", "responses": [ @@ -29258,9 +28994,7 @@ "categoryLabel": "Repos", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -29371,9 +29105,7 @@ "categoryLabel": "Repos", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -29468,9 +29200,7 @@ "categoryLabel": "Repos", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -29599,9 +29329,7 @@ "slug": "list-reactions-for-a-commit-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List the reactions to a commit comment.
", "responses": [ @@ -29732,9 +29460,7 @@ "slug": "create-reaction-for-a-commit-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Create a reaction to a commit comment. A response with a Status: 200 OK means that you already added the reaction type to this commit comment.
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.
", "responses": [ @@ -30138,9 +29860,7 @@ "categoryLabel": "Repos", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Use the :commit_sha to specify the commit that will have its comments listed.
Create a comment for a commit using its :commit_sha.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -30433,9 +30151,7 @@ "categoryLabel": "Repos", "subcategory": "commits", "subcategoryLabel": "Commits", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the List pull requests endpoint.
", "responses": [ @@ -30520,9 +30236,7 @@ "categoryLabel": "Repos", "subcategory": "commits", "subcategoryLabel": "Commits", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.
Note: If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
\nYou can pass the appropriate media type to fetch diff and patch formats. Diffs with binary data will have no patch property.
To return only the SHA-1 hash of the commit reference, you can provide the sha custom media type in the Accept header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.
Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.
\nThe most recent status for each context is returned, up to 100. This field paginates if there are over 100 contexts.
\nAdditionally, a combined state is returned. The state is one of:
error or failurependingsuccessUsers with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.
\nThis resource is also available via a legacy route: GET /repos/:owner/:repo/statuses/:ref.
This method returns the contents of the repository's code of conduct file, if one is detected.
", "responses": [ @@ -31175,9 +30879,7 @@ "categoryLabel": "Repos", "subcategory": "commits", "subcategoryLabel": "Commits", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Both :base and :head must be branch names in :repo. To compare branches across other repositories in the same network as :repo, use the format <USERNAME>:branch.
The response from the API is equivalent to running the git log base..head command; however, commits are returned in chronological order. Pass the appropriate media type to fetch diff and patch formats.
The response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.
Working with large comparisons
\nThe response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the List commits to enumerate all commits in the range.
\nFor comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long\nto generate. You can typically resolve this error by using a smaller commit range.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of all files in the repository.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNote:
\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
Creates a new file or replaces an existing file in a repository.
", "responses": [ { @@ -32076,9 +31774,7 @@ "categoryLabel": "Repos", "subcategory": "contents", "subcategoryLabel": "Contents", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Deletes a file in a repository.
\nYou can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.
The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.
You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.
Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.
\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.
", "responses": [ @@ -32492,9 +32186,7 @@ "categoryLabel": "Repos", "subcategory": "deployments", "subcategoryLabel": "Deployments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Simple filtering of deployments is available via query parameters:
", "responses": [ @@ -32708,9 +32400,7 @@ "categoryLabel": "Repos", "subcategory": "deployments", "subcategoryLabel": "Deployments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Deployments offer a few configurable parameters with certain defaults.
\nThe ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.
The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.
The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.
By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.
The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.
The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.
Users with repo or repo_deployment scopes can create a deployment for a given ref.
You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:
\nmaster in the response exampleIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.
\nThis error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.
This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.
Users with pull access can view deployment statuses for a deployment:
", "responses": [ @@ -33254,9 +32940,7 @@ "categoryLabel": "Repos", "subcategory": "deployments", "subcategoryLabel": "Deployments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Users with push access can create deployment statuses for a given deployment.
GitHub Apps require read & write access to \"Deployments\" and read-only access to \"Repo contents\" (for private repos). OAuth Apps require the repo_deployment scope.
Users with pull access can view a deployment status for a deployment:
", "responses": [ @@ -33553,9 +33235,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -33660,9 +33340,7 @@ "categoryLabel": "Repos", "subcategory": "forks", "subcategoryLabel": "Forks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -33757,9 +33435,7 @@ "categoryLabel": "Repos", "subcategory": "forks", "subcategoryLabel": "Forks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Create a fork for the authenticated user.
\nNote: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub Enterprise Server Support or GitHub Enterprise Server Premium Support.
", "bodyParameters": [ { @@ -33896,9 +33572,7 @@ "categoryLabel": "Git", "subcategory": "blobs", "subcategoryLabel": "Blobs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -34017,9 +33691,7 @@ "categoryLabel": "Git", "subcategory": "blobs", "subcategoryLabel": "Blobs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "The content in the response will always be Base64 encoded.
Note: This API supports blobs up to 100 megabytes in size.
", "responses": [ @@ -34317,9 +33989,7 @@ "categoryLabel": "Git", "subcategory": "commits", "subcategoryLabel": "Commits", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates a new Git commit object.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Gets a Git commit object.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.
When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.
Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nIf you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.
Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.
Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
", "responses": [ @@ -34907,9 +34571,7 @@ "categoryLabel": "Git", "subcategory": "refs", "subcategoryLabel": "Refs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.
", "bodyParameters": [ { @@ -35059,9 +34721,7 @@ "categoryLabel": "Git", "subcategory": "refs", "subcategoryLabel": "Refs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -35166,9 +34826,7 @@ "categoryLabel": "Git", "subcategory": "refs", "subcategoryLabel": "Refs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -35384,9 +35042,7 @@ "categoryLabel": "Git", "subcategory": "tags", "subcategoryLabel": "Tags", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary.
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.
\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"Create a commit\" and \"Update a reference.\"
", "responses": [ { @@ -36088,9 +35740,7 @@ "categoryLabel": "Git", "subcategory": "trees", "subcategoryLabel": "Trees", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns a single tree using the SHA1 value for that tree.
\nIf truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.
Repositories can have multiple webhooks installed. Each webhook should have a unique config. Multiple webhooks can\nshare the same config as long as those webhooks do not have any events that overlap.
Returns a webhook configured in a repository. To get only the webhook config properties, see \"Get a webhook configuration for a repository.\"
Updates a webhook configured in a repository. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use \"Update a webhook configuration for a repository.\"
When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.
", "responses": [ @@ -37788,9 +37422,7 @@ "categoryLabel": "Repos", "subcategory": "invitations", "subcategoryLabel": "Invitations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -37887,9 +37519,7 @@ "categoryLabel": "Repos", "subcategory": "invitations", "subcategoryLabel": "Invitations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -38089,9 +37719,7 @@ "slug": "list-repository-issues", "category": "issues", "categoryLabel": "Issues", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List issues in a repository.
\nNote: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.
Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -38530,9 +38156,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "By default, Issue Comments are ordered by ascending ID.
", "responses": [ @@ -38629,9 +38253,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -38742,9 +38364,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -38839,9 +38459,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -38965,9 +38583,7 @@ "slug": "list-reactions-for-an-issue-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List the reactions to an issue comment.
", "responses": [ @@ -39098,9 +38714,7 @@ "slug": "create-reaction-for-an-issue-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Create a reaction to an issue comment. A response with a Status: 200 OK means that you already added the reaction type to this issue comment.
The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.
Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.
Issue owners and users with push access can edit an issue.
", "bodyParameters": [ { @@ -39901,9 +39507,7 @@ "categoryLabel": "Issues", "subcategory": "assignees", "subcategoryLabel": "Assignees", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.
", "bodyParameters": [ { @@ -40025,9 +39629,7 @@ "categoryLabel": "Issues", "subcategory": "assignees", "subcategoryLabel": "Assignees", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Removes one or more assignees from an issue.
", "bodyParameters": [ { @@ -40157,9 +39759,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Issue Comments are ordered by ascending ID.
", "responses": [ @@ -40276,9 +39876,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -40421,9 +40019,7 @@ "categoryLabel": "Issues", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -40528,9 +40124,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -40647,9 +40241,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -40781,9 +40373,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Removes any previous labels and sets the new labels for an issue.
", "bodyParameters": [ { @@ -40886,9 +40476,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -40981,9 +40569,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a 404 Not Found status if the label does not exist.
List the reactions to an issue.
", "responses": [ @@ -41635,9 +41215,7 @@ "categoryLabel": "Issues", "subcategory": "timeline", "subcategoryLabel": "Timeline", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -41742,9 +41320,7 @@ "categoryLabel": "Repos", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -41860,9 +41436,7 @@ "categoryLabel": "Repos", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "You can create a read-only deploy key.
", "bodyParameters": [ { @@ -41975,9 +41549,7 @@ "categoryLabel": "Repos", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -42062,9 +41634,7 @@ "categoryLabel": "Repos", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -42153,9 +41723,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -42276,9 +41844,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -42395,9 +41961,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -42524,9 +42088,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -42633,9 +42195,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -42702,9 +42262,7 @@ "slug": "list-repository-languages", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.
", "responses": [ @@ -42772,9 +42330,7 @@ "slug": "get-the-license-for-a-repository", "category": "licenses", "categoryLabel": "Licenses", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "This method returns the contents of the repository's license file, if one is detected.
\nSimilar to Get repository content, this method also supports custom media types for retrieving the raw license content or rendered license HTML.
", "responses": [ @@ -42891,9 +42447,7 @@ "categoryLabel": "Repos", "subcategory": "merging", "subcategoryLabel": "Merging", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -43085,9 +42639,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -43223,9 +42775,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -43357,9 +42907,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -43502,9 +43050,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -43626,9 +43172,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -43732,9 +43276,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -44035,9 +43577,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -44216,9 +43756,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Configures a GitHub Enterprise Server Pages site. For more information, see \"About GitHub Pages.\"
", "responses": [ { @@ -44441,9 +43979,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -44577,9 +44113,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -44683,9 +44217,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -44755,9 +44287,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.
\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.
", "responses": [ @@ -44827,9 +44357,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -44908,9 +44436,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -45007,9 +44533,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "repo-pre-receive-hooks", "subcategoryLabel": "Repo pre receive hooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.
", "responses": [ @@ -45095,9 +44619,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "repo-pre-receive-hooks", "subcategoryLabel": "Repo pre receive hooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -45206,9 +44728,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "repo-pre-receive-hooks", "subcategoryLabel": "Repo pre receive hooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "For pre-receive hooks which are allowed to be configured at the repo level, you can set enforcement
Deletes any overridden enforcement on this repository for the specified hook.
\nResponds with effective values inherited from owner and/or global level.
", "responses": [ @@ -45417,9 +44935,7 @@ "slug": "list-repository-projects", "category": "projects", "categoryLabel": "Projects", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the projects in a repository. Returns a 404 Not Found status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Creates a repository project board. Returns a 404 Not Found status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team, GitHub Enterprise Server 2.17+, and GitHub Enterprise Cloud.
", "responses": [ @@ -45945,9 +45457,7 @@ "slug": "create-a-pull-request", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team, GitHub Enterprise Server 2.17+, and GitHub Enterprise Cloud. You can create a new pull request. This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.
", "bodyParameters": [ { @@ -46163,9 +45673,7 @@ "categoryLabel": "Pulls", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nProvides details for a review comment.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nEnables you to edit a review comment.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.List the reactions to a pull request review comment.
", "responses": [ @@ -46734,9 +46234,7 @@ "slug": "create-reaction-for-a-pull-request-review-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Create a reaction to a pull request review comment. A response with a Status: 200 OK means that you already added the reaction type to this pull request review comment.
Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nLists details of a pull request by providing its number.
\nWhen you get, create, or edit a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".
The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.
The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:
merge_commit_sha represents the SHA of the merge commit.merge_commit_sha represents the SHA of the squashed commit on the base branch.merge_commit_sha represents the commit that the base branch was updated to.Pass the appropriate media type to fetch diff and patch formats.
", "responses": [ @@ -47021,9 +46517,7 @@ "slug": "update-a-pull-request", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team, GitHub Enterprise Server 2.17+, and GitHub Enterprise Cloud.
", "bodyParameters": [ { @@ -47234,9 +46728,7 @@ "categoryLabel": "Pulls", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.
You can still create a review comment using the position parameter. When you use position, the line, side, start_line, and start_side parameters are not required. For more information, see Multi-line comment summary.
Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the List commits endpoint.
", "responses": [ @@ -47882,9 +47370,7 @@ "slug": "list-pull-requests-files", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
", "responses": [ @@ -47971,9 +47457,7 @@ "slug": "check-if-a-pull-request-has-been-merged", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -48107,9 +47591,7 @@ "slug": "merge-a-pull-request", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -48277,9 +47759,7 @@ "categoryLabel": "Pulls", "subcategory": "review-requests", "subcategoryLabel": "Review requests", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -48404,9 +47884,7 @@ "categoryLabel": "Pulls", "subcategory": "review-requests", "subcategoryLabel": "Review requests", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -48565,9 +48043,7 @@ "categoryLabel": "Pulls", "subcategory": "review-requests", "subcategoryLabel": "Review requests", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -48695,9 +48171,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "The list of reviews returns in chronological order.
", "responses": [ @@ -48984,9 +48458,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nPull request reviews created in the PENDING state do not include the submitted_at property in the response.
Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API v3 offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
Update the review summary comment with new text.
", "bodyParameters": [ { @@ -49498,9 +48966,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -49619,9 +49085,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List comments for a specific pull request review.
", "responses": [ @@ -49747,9 +49211,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
", "bodyParameters": [ { @@ -49904,9 +49366,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -50157,9 +49617,7 @@ "categoryLabel": "Repos", "subcategory": "contents", "subcategoryLabel": "Contents", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Gets the preferred README for a repository.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", "responses": [ @@ -50259,9 +49717,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the Repository Tags API.
\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.
", "responses": [ @@ -50415,9 +49871,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Users with push access to the repository can create a release.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -50559,9 +50013,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.
Users with push access to the repository can edit a release asset.
", "bodyParameters": [ { @@ -50808,9 +50258,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -50879,9 +50327,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "View the latest published full release for the repository.
\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the created_at attribute. The created_at attribute is the date of the commit used for the release, and not the date when the release was drafted or published.
Get a published release with the specified tag.
", "responses": [ @@ -51048,9 +50492,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.
Users with push access to the repository can edit a release.
", "bodyParameters": [ { @@ -51345,9 +50785,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -51446,9 +50884,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -51565,9 +51001,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nLists the people that have starred the repository.
\nYou can also find out when stars were created by passing the following custom media type via the Accept header:
Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
", "responses": [ @@ -51806,9 +51236,7 @@ "categoryLabel": "Repos", "subcategory": "statistics", "subcategoryLabel": "Statistics", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns the last year of commit activity grouped by week. The days array is a group of commits per day, starting on Sunday.
Returns the total number of commits authored by the contributor. In addition, the response includes a Weekly Hash (weeks array) with the following information:
w - Start of the week, given as a Unix timestamp.a - Number of additionsd - Number of deletionsc - Number of commitsReturns the total commit counts for the owner and total commit counts in all. all is everyone combined, including the owner in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract owner from all.
The array order is oldest week (index 0) to most recent week.
", "responses": [ @@ -52027,9 +51451,7 @@ "categoryLabel": "Repos", "subcategory": "statistics", "subcategoryLabel": "Statistics", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Each array contains the day number, hour number, and number of commits:
\n0-6: Sunday - Saturday0-23: Hour of dayFor example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.
Users with push access in a repository can create commit statuses for a given SHA.
\nNote: there is a limit of 1000 statuses per sha and context within a repository. Attempts to create more than 1000 statuses will result in a validation error.
Lists the people watching the specified repository.
", "responses": [ @@ -52664,9 +52082,7 @@ "slug": "list-repository-tags", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -52745,9 +52161,7 @@ "categoryLabel": "Repos", "subcategory": "contents", "subcategoryLabel": "Contents", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "302", @@ -52834,9 +52248,7 @@ "slug": "list-repository-teams", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -52911,9 +52323,7 @@ "slug": "get-all-repository-topics", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -53032,9 +52442,7 @@ "slug": "replace-all-repository-topics", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -53169,9 +52577,7 @@ "slug": "transfer-a-repository", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original owner, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see about repository transfers.
Lists all public repositories in the order that they were created.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.
Searches for query terms inside of a file. This method returns up to 100 results per page.
\nWhen searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:
q=addClass+in:file+language:js+repo:jquery/jquery
This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.
Due to the complexity of searching code, there are a few restrictions on how searches are performed:
\nmaster branch.language:go is not valid, while amazing language:go is.Find commits via various criteria on the default branch (usually master). This method returns up to 100 results per page.
When searching for commits, you can get text match metadata for the message field when you provide the text-match media type. For more details about how to receive highlighted search results, see Text match\nmetadata.
For example, if you want to find commits related to CSS in the octocat/Spoon-Knife repository. Your query would look something like this:
\nq=repo:octocat/Spoon-Knife+css
Find issues by state and keyword. This method returns up to 100 results per page.
\nWhen searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.
For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.
\nq=windows+label:bug+language:python+state:open&sort=created&order=asc
This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.
Note: For user-to-server GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"
Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results per page.
\nWhen searching for labels, you can get text match metadata for the label name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to find labels in the linguist repository that match bug, defect, or enhancement. Your query might look like this:
q=bug+defect+enhancement&repository_id=64778136
The labels that best match the query appear first in the search results.
", "responses": [ @@ -54341,9 +53731,7 @@ "slug": "search-repositories", "category": "search", "categoryLabel": "Search", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Find repositories via various criteria. This method returns up to 100 results per page.
\nWhen searching for repositories, you can get text match metadata for the name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:
\nq=tetris+language:assembly&sort=stars&order=desc
This query searches for repositories with the word tetris in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.
When you include the mercy preview header, you can also search for multiple topics by adding more topic: instances. For example, your query might look like this:
q=topic:ruby+topic:rails
Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results per page. See \"Searching topics\" for a detailed list of qualifiers.
\nWhen searching for topics, you can get text match metadata for the topic's short_description, description, name, or display_name field when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:
\nq=ruby+is:featured
This query searches for topics with the keyword ruby and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.
Find users via various criteria. This method returns up to 100 results per page.
\nWhen searching for users, you can get text match metadata for the issue login, email, and name fields when you pass the text-match media type. For more details about highlighting search results, see Text match metadata. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you're looking for a list of popular users, you might try this query:
\nq=tom+repos:%3E42+followers:%3E1000
This query searches for users with the name tom. The results are restricted to users with more than 42 repositories and over 1,000 followers.
To edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote: With nested teams, the privacy for parent teams cannot be secret.
List all discussions on a team's page. OAuth access tokens require the read:discussion scope.
Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.
", "bodyParameters": [ { @@ -55987,9 +55361,7 @@ "categoryLabel": "Teams", "subcategory": "discussions", "subcategoryLabel": "Discussions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Get a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.
Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion scope.
List all comments on a team discussion. OAuth access tokens require the read:discussion scope.
Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.
", "bodyParameters": [ { @@ -56502,9 +55866,7 @@ "categoryLabel": "Teams", "subcategory": "discussion-comments", "subcategoryLabel": "Discussion comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Get a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.
Edits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with a Status: 200 OK means that you already added the reaction type to this team discussion comment.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Team members will include the members of child teams.
\nTo list members in a team, the team must be visible to the authenticated user.
", "responses": [ @@ -57431,9 +56781,7 @@ "categoryLabel": "Teams", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -57510,9 +56858,7 @@ "categoryLabel": "Teams", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "The \"Add team member\" endpoint (described below) is deprecated.
\nWe recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.
\nNote: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create a team.
If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.
\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
", "bodyParameters": [ { @@ -57890,9 +57230,7 @@ "categoryLabel": "Teams", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -57986,9 +57324,7 @@ "slug": "list-team-projects", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the organization projects for a team. If you are an authenticated site administrator for your Enterprise instance, you will be able to list all projects for the team.
", "responses": [ @@ -58072,9 +57408,7 @@ "slug": "check-team-permissions-for-a-project", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Checks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.
Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.
If you are an authenticated site administrator for your Enterprise instance, you will be able to list all repositories for the team.
", "responses": [ @@ -58435,9 +57763,7 @@ "slug": "check-team-permissions-for-a-repository", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -58547,9 +57873,7 @@ "slug": "add-or-update-team-repository-permissions", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -58640,9 +57964,7 @@ "slug": "remove-a-repository-from-a-team", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -58719,9 +58041,7 @@ "slug": "list-child-teams", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -61594,9 +60914,7 @@ "slug": "create-a-user-project", "category": "projects", "categoryLabel": "Projects", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -63265,9 +62583,7 @@ "slug": "list-users", "category": "users", "categoryLabel": "Users", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
Provides publicly available information about someone with a GitHub account.
\nGitHub Apps with the Plan user permission can use this endpoint to retrieve information about a user's GitHub Enterprise Server plan. The GitHub App must be authenticated as a user. See \"Identifying and authorizing users for GitHub Apps\" for details about authentication. For an example response, see 'Response with GitHub Enterprise Server plan information' below\"
The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.
The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".
", "responses": [ @@ -63425,9 +62739,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -63596,9 +62908,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -63678,9 +62988,7 @@ "categoryLabel": "Users", "subcategory": "followers", "subcategoryLabel": "Followers", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the people following the specified user.
", "responses": [ @@ -63761,9 +63069,7 @@ "categoryLabel": "Users", "subcategory": "followers", "subcategoryLabel": "Followers", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the people who the specified user follows.
", "responses": [ @@ -63833,9 +63139,7 @@ "categoryLabel": "Users", "subcategory": "followers", "subcategoryLabel": "Followers", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -64014,9 +63318,7 @@ "categoryLabel": "Users", "subcategory": "gpg-keys", "subcategoryLabel": "Gpg keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the GPG keys for a user. This information is accessible by anyone.
", "responses": [ @@ -64268,9 +63570,7 @@ "categoryLabel": "Users", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the verified public SSH keys for a user. This is accessible by anyone.
", "responses": [ @@ -64349,9 +63649,7 @@ "slug": "list-organizations-for-a-user", "category": "orgs", "categoryLabel": "Orgs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List public organization memberships for the specified user.
\nThis method only lists public memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the List organizations for the authenticated user API instead.
", "responses": [ @@ -64544,9 +63842,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -64626,9 +63922,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -64760,9 +64054,7 @@ "slug": "list-repositories-for-a-user", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists public repositories for the specified user.
", "responses": [ @@ -64993,9 +64285,7 @@ "categoryLabel": "Activity", "subcategory": "starring", "subcategoryLabel": "Starring", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists repositories a user has starred.
\nYou can also find out when stars were created by passing the following custom media type via the Accept header:
Lists repositories a user is watching.
", "responses": [ @@ -65302,9 +64590,7 @@ "slug": "get-the-zen-of-github", "category": "meta", "categoryLabel": "Meta", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", diff --git a/lib/rest/static/decorated/ghes-2.21.json b/lib/rest/static/decorated/ghes-2.21.json index 6cd1524aca86..a5e9a934e481 100644 --- a/lib/rest/static/decorated/ghes-2.21.json +++ b/lib/rest/static/decorated/ghes-2.21.json @@ -31,9 +31,7 @@ "slug": "github-api-root", "category": "meta", "categoryLabel": "Meta", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -3527,9 +3525,7 @@ "slug": "get-the-authenticated-app", "category": "apps", "categoryLabel": "Apps", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count in the response. For more details about your app's installations, see the \"List installations for the authenticated app\" endpoint.
You must use a JWT to access this endpoint.
", "responses": [ @@ -3685,9 +3681,7 @@ "slug": "list-installations-for-the-authenticated-app", "category": "apps", "categoryLabel": "Apps", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "You must use a JWT to access this endpoint.
\nThe permissions the installation has are included under the permissions key.
Enables an authenticated GitHub App to find an installation's information using the installation id. The installation's account type (target_type) will be either an organization or a user account, depending which account the repository belongs to.
You must use a JWT to access this endpoint.
", "responses": [ @@ -4079,9 +4071,7 @@ "slug": "create-an-installation-access-token-for-an-app", "category": "apps", "categoryLabel": "Apps", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of 401 - Unauthorized, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the repository_ids when creating the token. When you omit repository_ids, the response does not contain the repositories key.
You must use a JWT to access this endpoint.
", "responses": [ { @@ -5248,9 +5238,7 @@ "slug": "get-an-app", "category": "apps", "categoryLabel": "Apps", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: The :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).
If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a personal access token or an installation access token to access this endpoint.
", "responses": [ @@ -6408,9 +6396,7 @@ "slug": "get-all-codes-of-conduct", "category": "codes-of-conduct", "categoryLabel": "Codes of conduct", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -6486,9 +6472,7 @@ "slug": "get-a-code-of-conduct", "category": "codes-of-conduct", "categoryLabel": "Codes of conduct", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -6608,9 +6592,7 @@ "categoryLabel": "Apps", "subcategory": "installations", "subcategoryLabel": "Installations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id of the content reference from the content_reference event to create an attachment.
The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.
\nYou must use an installation access token to access this endpoint.
", "bodyParameters": [ { @@ -6712,9 +6694,7 @@ "slug": "get-emojis", "category": "emojis", "categoryLabel": "Emojis", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -6902,9 +6882,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -6969,9 +6947,7 @@ "categoryLabel": "Activity", "subcategory": "feeds", "subcategoryLabel": "Feeds", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "GitHub Enterprise Server provides several timeline resources in Atom format. The Feeds API lists all the feeds available to the authenticated user:
\nNote: Private feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
", "responses": [ @@ -8902,9 +8878,7 @@ "slug": "get-all-gitignore-templates", "category": "gitignore", "categoryLabel": "Gitignore", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List all templates available to pass as an option when creating a repository.
", "responses": [ @@ -8968,9 +8942,7 @@ "slug": "get-a-gitignore-template", "category": "gitignore", "categoryLabel": "Gitignore", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "The API also allows fetching the source of a single template.\nUse the raw media type to get the raw contents.
", "responses": [ @@ -9071,9 +9043,7 @@ "categoryLabel": "Apps", "subcategory": "installations", "subcategoryLabel": "Installations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List repositories that an app installation can access.
\nYou must use an installation access token to access this endpoint.
", "responses": [ @@ -9139,9 +9109,7 @@ "categoryLabel": "Apps", "subcategory": "installations", "subcategoryLabel": "Installations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -9421,9 +9389,7 @@ "slug": "get-all-commonly-used-licenses", "category": "licenses", "categoryLabel": "Licenses", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -9487,9 +9453,7 @@ "slug": "get-a-license", "category": "licenses", "categoryLabel": "Licenses", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -9600,9 +9564,7 @@ "slug": "render-a-markdown-document", "category": "markdown", "categoryLabel": "Markdown", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -9703,9 +9665,7 @@ "slug": "render-a-markdown-document-in-raw-mode", "category": "markdown", "categoryLabel": "Markdown", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -9758,9 +9718,7 @@ "slug": "get-github-enterprise-server-meta-information", "category": "meta", "categoryLabel": "Meta", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "This endpoint provides a list of GitHub's IP addresses. For more information, see \"About GitHub's IP addresses.\"
", "responses": [ @@ -9855,9 +9813,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -10595,9 +10551,7 @@ "slug": "get-octocat", "category": "meta", "categoryLabel": "Meta", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -10666,9 +10620,7 @@ "slug": "list-organizations", "category": "orgs", "categoryLabel": "Orgs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists all organizations, in the order that they were created on GitHub Enterprise Server.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
To see many of the organization response values, you need to be an authenticated organization owner with the admin:org scope. When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.
GitHub Apps with the Organization plan permission can use this endpoint to retrieve information about an organization's GitHub Enterprise Server plan. See \"Authenticating with GitHub Apps\" for details. For an example response, see 'Response with GitHub Enterprise Server plan information' below.\"
Parameter Deprecation Notice: GitHub Enterprise Server will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.
Enables an authenticated organization owner with the admin:org scope to update the organization's profile and member privileges.
Here's how you can create a hook that posts payloads in JSON format:
", "responses": [ { @@ -11880,9 +11822,7 @@ "categoryLabel": "Orgs", "subcategory": "webhooks", "subcategoryLabel": "Webhooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns a webhook configured in an organization. To get only the webhook config properties, see \"Get a webhook configuration for an organization.\"
Updates a webhook configured in an organization. When you update a webhook, the secret will be overwritten. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use \"Update a webhook configuration for an organization.\"
Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with admin:read scope to use this endpoint.
List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.
", "responses": [ @@ -12958,9 +12888,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -13039,9 +12967,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -13115,9 +13041,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "In order to get a user's membership with an organization, the authenticated user must be an organization member.
", "responses": [ @@ -13234,9 +13158,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Only authenticated organization owners can add a member to the organization or update the member's role.
\npending until they accept the invitation.role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.Rate limits
\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
", "bodyParameters": [ { @@ -13337,9 +13259,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -13444,9 +13364,7 @@ "categoryLabel": "Orgs", "subcategory": "outside-collaborators", "subcategoryLabel": "Outside collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List all users who are outside collaborators of an organization.
", "responses": [ @@ -13516,9 +13434,7 @@ "categoryLabel": "Orgs", "subcategory": "outside-collaborators", "subcategoryLabel": "Outside collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\".
", "responses": [ @@ -13609,9 +13525,7 @@ "categoryLabel": "Orgs", "subcategory": "outside-collaborators", "subcategoryLabel": "Outside collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Removing a user from this list will remove them from all the organization's repositories.
", "responses": [ @@ -13704,9 +13618,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "org-pre-receive-hooks", "subcategoryLabel": "Org pre receive hooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.
", "responses": [ @@ -13783,9 +13695,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "org-pre-receive-hooks", "subcategoryLabel": "Org pre receive hooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -13895,9 +13805,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "org-pre-receive-hooks", "subcategoryLabel": "Org pre receive hooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "For pre-receive hooks which are allowed to be configured at the org level, you can set enforcement and allow_downstream_configuration
Removes any overrides for this hook at the org level for this org.
", "responses": [ @@ -14097,9 +14003,7 @@ "slug": "list-organization-projects", "category": "projects", "categoryLabel": "Projects", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the projects in an organization. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Creates an organization project board. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Members of an organization can choose to have their membership publicized or not.
", "responses": [ @@ -14405,9 +14305,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -14696,9 +14594,7 @@ "slug": "list-organization-repositories", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists repositories for the specified organization.
", "responses": [ @@ -14962,9 +14858,7 @@ "slug": "create-an-organization-repository", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.
\nOAuth scope requirements
\nWhen using OAuth, authorizations must include:
\npublic_repo scope or repo scope to create a public repositoryrepo scope to create a private repositoryLists all teams in an organization that are visible to the authenticated user.
", "responses": [ @@ -15388,9 +15280,7 @@ "slug": "create-a-team", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "To create a team, the authenticated user must be a member or owner of {org}. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"Setting team creation permissions.\"
When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of maintainers. For more information, see \"About teams\".
Gets a team using the team's slug. GitHub Enterprise Server generates the slug from the team name.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
To edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}.
List all discussions on a team's page. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.
Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nNote: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.
Get a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
List all comments on a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nNote: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
Get a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
Edits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with a Status: 200 OK means that you already added the reaction type to this team discussion comment.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
Team members will include the members of child teams.
\nTo list members in a team, the team must be visible to the authenticated user.
", "responses": [ @@ -17925,9 +17777,7 @@ "categoryLabel": "Teams", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create a team.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nAdds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
\nNote: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
\nNote: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}.
Lists the organization projects for a team.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects.
Checks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects/{project_id}.
Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.
Note: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}.
Lists a team's repositories visible to the authenticated user.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos.
Lists the child teams of the team specified by {team_slug}.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.
Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key.
Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
Gets a project by its id. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Updates a project board's information. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project admin to list collaborators.
Returns the collaborator's permission level for an organization project. Possible values for the permission key: admin, write, read, none. You must be an organization owner or a project admin to review a user's permission level.
Note: Accessing this endpoint does not count against your REST API rate limit.
\nNote: The rate object is deprecated. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.
When you pass the scarlet-witch-preview media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file.
The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.
Note: To edit a repository's topics, use the Replace all repository topics endpoint.
", "bodyParameters": [ { @@ -22117,9 +21899,7 @@ "slug": "delete-a-repository", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Deleting a repository requires admin access. If OAuth is used, the delete_repo scope is required.
If an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a 403 Forbidden response.
Lists the available assignees for issues in a repository.
", "responses": [ @@ -22305,9 +22083,7 @@ "categoryLabel": "Issues", "subcategory": "assignees", "subcategoryLabel": "Assignees", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -22411,9 +22187,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -22504,9 +22278,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -22603,9 +22375,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "responses": [ @@ -23189,9 +22959,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -23730,9 +23498,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -23816,9 +23582,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "responses": [ @@ -23898,9 +23662,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
", "responses": [ @@ -23980,9 +23742,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -24073,9 +23833,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -24279,9 +24037,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
\nNote: Passing new arrays of users and teams replaces their previous values.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.
Note: You must enable branch protection to require signed commits.
", "responses": [ @@ -24648,9 +24400,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.
", "responses": [ @@ -24742,9 +24492,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -24828,9 +24576,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "responses": [ @@ -24953,9 +24699,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.
", "bodyParameters": [ { @@ -25067,9 +24811,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -25148,9 +24890,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "responses": [ @@ -25267,9 +25007,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "bodyParameters": [ { @@ -25409,9 +25147,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "bodyParameters": [ { @@ -25546,9 +25282,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "bodyParameters": [ { @@ -25651,9 +25385,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists who has access to this protected branch.
\nNote: Users, apps, and teams restrictions are only available for organization-owned repositories.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nGrants the specified apps push access for this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
| Type | Description |
|---|---|
array | The GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
| Type | Description |
|---|---|
array | The GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nRemoves the ability of an app to push to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
| Type | Description |
|---|---|
array | The GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists the teams who have push access to this branch. The list includes child teams.
", "responses": [ @@ -26421,9 +26141,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nGrants the specified teams push access for this branch. You can also give push access to child teams.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | The teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | The teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Teams that should no longer have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists the people who have push access to this branch.
", "responses": [ @@ -26904,9 +26616,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nGrants the specified people push access for this branch.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nRemoves the ability of a user to push to this branch.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames of the people who should no longer have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Creates a new check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to create check runs.
In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
", "responses": [ { @@ -29310,9 +29014,7 @@ "categoryLabel": "Checks", "subcategory": "runs", "subcategoryLabel": "Runs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Updates a check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to edit check runs.
Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"Update repository preferences for check suites\". Your GitHub App must have the checks:write permission to create check suites.
Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually Create a check suite. You must have admin permissions in the repository to set preferences for check suites.
", "responses": [ { @@ -31835,9 +31529,7 @@ "categoryLabel": "Checks", "subcategory": "suites", "subcategoryLabel": "Suites", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
\nTeam members will include the members of child teams.
", "responses": [ @@ -32266,9 +31952,7 @@ "categoryLabel": "Repos", "subcategory": "collaborators", "subcategoryLabel": "Collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -32389,9 +32073,7 @@ "categoryLabel": "Repos", "subcategory": "collaborators", "subcategoryLabel": "Collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nFor more information the permission levels, see \"Repository permission levels for an organization\".
\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.
\nRate limits
\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
", "bodyParameters": [ { @@ -32512,9 +32194,7 @@ "categoryLabel": "Repos", "subcategory": "collaborators", "subcategoryLabel": "Collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -32592,9 +32272,7 @@ "categoryLabel": "Repos", "subcategory": "collaborators", "subcategoryLabel": "Collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Checks the repository permission of a collaborator. The possible repository permissions are admin, write, read, and none.
Commit Comments use these custom media types. You can read more about the use of media types in the API here.
\nComments are ordered by ascending ID.
", "responses": [ @@ -32785,9 +32461,7 @@ "categoryLabel": "Repos", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -32898,9 +32572,7 @@ "categoryLabel": "Repos", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -32995,9 +32667,7 @@ "categoryLabel": "Repos", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -33126,9 +32796,7 @@ "slug": "list-reactions-for-a-commit-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List the reactions to a commit comment.
", "responses": [ @@ -33259,9 +32927,7 @@ "slug": "create-reaction-for-a-commit-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Create a reaction to a commit comment. A response with a Status: 200 OK means that you already added the reaction type to this commit comment.
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.
", "responses": [ @@ -33760,9 +33420,7 @@ "categoryLabel": "Repos", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Use the :commit_sha to specify the commit that will have its comments listed.
Create a comment for a commit using its :commit_sha.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -34055,9 +33711,7 @@ "categoryLabel": "Repos", "subcategory": "commits", "subcategoryLabel": "Commits", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the List pull requests endpoint.
", "responses": [ @@ -34142,9 +33796,7 @@ "categoryLabel": "Repos", "subcategory": "commits", "subcategoryLabel": "Commits", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.
Note: If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
\nYou can pass the appropriate media type to fetch diff and patch formats. Diffs with binary data will have no patch property.
To return only the SHA-1 hash of the commit reference, you can provide the sha custom media type in the Accept header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.
Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.
\nThe most recent status for each context is returned, up to 100. This field paginates if there are over 100 contexts.
\nAdditionally, a combined state is returned. The state is one of:
error or failurependingsuccessUsers with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.
\nThis resource is also available via a legacy route: GET /repos/:owner/:repo/statuses/:ref.
This method returns the contents of the repository's code of conduct file, if one is detected.
", "responses": [ @@ -34797,9 +34439,7 @@ "categoryLabel": "Repos", "subcategory": "commits", "subcategoryLabel": "Commits", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Both :base and :head must be branch names in :repo. To compare branches across other repositories in the same network as :repo, use the format <USERNAME>:branch.
The response from the API is equivalent to running the git log base..head command; however, commits are returned in chronological order. Pass the appropriate media type to fetch diff and patch formats.
The response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.
Working with large comparisons
\nThe response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the List commits to enumerate all commits in the range.
\nFor comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long\nto generate. You can typically resolve this error by using a smaller commit range.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of all files in the repository.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNote:
\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
Creates a new file or replaces an existing file in a repository.
", "responses": [ { @@ -35698,9 +35334,7 @@ "categoryLabel": "Repos", "subcategory": "contents", "subcategoryLabel": "Contents", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Deletes a file in a repository.
\nYou can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.
The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.
You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.
Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.
\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.
", "responses": [ @@ -36114,9 +35746,7 @@ "categoryLabel": "Repos", "subcategory": "deployments", "subcategoryLabel": "Deployments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Simple filtering of deployments is available via query parameters:
", "responses": [ @@ -36330,9 +35960,7 @@ "categoryLabel": "Repos", "subcategory": "deployments", "subcategoryLabel": "Deployments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Deployments offer a few configurable parameters with certain defaults.
\nThe ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.
The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.
The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.
By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.
The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.
The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.
Users with repo or repo_deployment scopes can create a deployment for a given ref.
You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:
\nmaster in the response exampleIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.
\nThis error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.
This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.
Users with pull access can view deployment statuses for a deployment:
", "responses": [ @@ -36967,9 +36589,7 @@ "categoryLabel": "Repos", "subcategory": "deployments", "subcategoryLabel": "Deployments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Users with push access can create deployment statuses for a given deployment.
GitHub Apps require read & write access to \"Deployments\" and read-only access to \"Repo contents\" (for private repos). OAuth Apps require the repo_deployment scope.
Users with pull access can view a deployment status for a deployment:
", "responses": [ @@ -37266,9 +36884,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -37373,9 +36989,7 @@ "categoryLabel": "Repos", "subcategory": "forks", "subcategoryLabel": "Forks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -37470,9 +37084,7 @@ "categoryLabel": "Repos", "subcategory": "forks", "subcategoryLabel": "Forks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Create a fork for the authenticated user.
\nNote: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub Enterprise Server Support or GitHub Enterprise Server Premium Support.
", "bodyParameters": [ { @@ -37609,9 +37221,7 @@ "categoryLabel": "Git", "subcategory": "blobs", "subcategoryLabel": "Blobs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -37730,9 +37340,7 @@ "categoryLabel": "Git", "subcategory": "blobs", "subcategoryLabel": "Blobs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "The content in the response will always be Base64 encoded.
Note: This API supports blobs up to 100 megabytes in size.
", "responses": [ @@ -38030,9 +37638,7 @@ "categoryLabel": "Git", "subcategory": "commits", "subcategoryLabel": "Commits", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates a new Git commit object.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Gets a Git commit object.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.
When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.
Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nIf you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.
Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.
Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
", "responses": [ @@ -38620,9 +38220,7 @@ "categoryLabel": "Git", "subcategory": "refs", "subcategoryLabel": "Refs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.
", "bodyParameters": [ { @@ -38772,9 +38370,7 @@ "categoryLabel": "Git", "subcategory": "refs", "subcategoryLabel": "Refs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -38879,9 +38475,7 @@ "categoryLabel": "Git", "subcategory": "refs", "subcategoryLabel": "Refs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -39097,9 +38691,7 @@ "categoryLabel": "Git", "subcategory": "tags", "subcategoryLabel": "Tags", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary.
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.
\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"Create a commit\" and \"Update a reference.\"
", "responses": [ { @@ -39801,9 +39389,7 @@ "categoryLabel": "Git", "subcategory": "trees", "subcategoryLabel": "Trees", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns a single tree using the SHA1 value for that tree.
\nIf truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.
Repositories can have multiple webhooks installed. Each webhook should have a unique config. Multiple webhooks can\nshare the same config as long as those webhooks do not have any events that overlap.
Returns a webhook configured in a repository. To get only the webhook config properties, see \"Get a webhook configuration for a repository.\"
Updates a webhook configured in a repository. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use \"Update a webhook configuration for a repository.\"
When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.
", "responses": [ @@ -41501,9 +41071,7 @@ "categoryLabel": "Repos", "subcategory": "invitations", "subcategoryLabel": "Invitations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -41600,9 +41168,7 @@ "categoryLabel": "Repos", "subcategory": "invitations", "subcategoryLabel": "Invitations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -41802,9 +41368,7 @@ "slug": "list-repository-issues", "category": "issues", "categoryLabel": "Issues", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List issues in a repository.
\nNote: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.
Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -42243,9 +41805,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "By default, Issue Comments are ordered by ascending ID.
", "responses": [ @@ -42342,9 +41902,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -42455,9 +42013,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -42552,9 +42108,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -42678,9 +42232,7 @@ "slug": "list-reactions-for-an-issue-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List the reactions to an issue comment.
", "responses": [ @@ -42811,9 +42363,7 @@ "slug": "create-reaction-for-an-issue-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Create a reaction to an issue comment. A response with a Status: 200 OK means that you already added the reaction type to this issue comment.
The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.
Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.
Issue owners and users with push access can edit an issue.
", "bodyParameters": [ { @@ -43709,9 +43249,7 @@ "categoryLabel": "Issues", "subcategory": "assignees", "subcategoryLabel": "Assignees", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.
", "bodyParameters": [ { @@ -43833,9 +43371,7 @@ "categoryLabel": "Issues", "subcategory": "assignees", "subcategoryLabel": "Assignees", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Removes one or more assignees from an issue.
", "bodyParameters": [ { @@ -43965,9 +43501,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Issue Comments are ordered by ascending ID.
", "responses": [ @@ -44084,9 +43618,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -44229,9 +43761,7 @@ "categoryLabel": "Issues", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -44336,9 +43866,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -44455,9 +43983,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -44589,9 +44115,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Removes any previous labels and sets the new labels for an issue.
", "bodyParameters": [ { @@ -44694,9 +44218,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -44789,9 +44311,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a 404 Not Found status if the label does not exist.
List the reactions to an issue.
", "responses": [ @@ -45424,9 +44938,7 @@ "slug": "delete-an-issue-reaction", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -45538,9 +45050,7 @@ "categoryLabel": "Issues", "subcategory": "timeline", "subcategoryLabel": "Timeline", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -45645,9 +45155,7 @@ "categoryLabel": "Repos", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -45763,9 +45271,7 @@ "categoryLabel": "Repos", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "You can create a read-only deploy key.
", "bodyParameters": [ { @@ -45878,9 +45384,7 @@ "categoryLabel": "Repos", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -45965,9 +45469,7 @@ "categoryLabel": "Repos", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -46056,9 +45558,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -46179,9 +45679,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -46298,9 +45796,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -46427,9 +45923,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -46536,9 +46030,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -46605,9 +46097,7 @@ "slug": "list-repository-languages", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.
", "responses": [ @@ -46675,9 +46165,7 @@ "slug": "get-the-license-for-a-repository", "category": "licenses", "categoryLabel": "Licenses", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "This method returns the contents of the repository's license file, if one is detected.
\nSimilar to Get repository content, this method also supports custom media types for retrieving the raw license content or rendered license HTML.
", "responses": [ @@ -46794,9 +46282,7 @@ "categoryLabel": "Repos", "subcategory": "merging", "subcategoryLabel": "Merging", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -46988,9 +46474,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -47126,9 +46610,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -47260,9 +46742,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -47405,9 +46885,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -47529,9 +47007,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -47635,9 +47111,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -47938,9 +47412,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -48119,9 +47591,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Configures a GitHub Enterprise Server Pages site. For more information, see \"About GitHub Pages.\"
", "responses": [ { @@ -48344,9 +47814,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -48480,9 +47948,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -48586,9 +48052,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -48658,9 +48122,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.
\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.
", "responses": [ @@ -48730,9 +48192,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -48811,9 +48271,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -48910,9 +48368,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "repo-pre-receive-hooks", "subcategoryLabel": "Repo pre receive hooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.
", "responses": [ @@ -48998,9 +48454,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "repo-pre-receive-hooks", "subcategoryLabel": "Repo pre receive hooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -49109,9 +48563,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "repo-pre-receive-hooks", "subcategoryLabel": "Repo pre receive hooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "For pre-receive hooks which are allowed to be configured at the repo level, you can set enforcement
Deletes any overridden enforcement on this repository for the specified hook.
\nResponds with effective values inherited from owner and/or global level.
", "responses": [ @@ -49320,9 +48770,7 @@ "slug": "list-repository-projects", "category": "projects", "categoryLabel": "Projects", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the projects in a repository. Returns a 404 Not Found status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Creates a repository project board. Returns a 404 Not Found status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team, GitHub Enterprise Server 2.17+, and GitHub Enterprise Cloud.
", "responses": [ @@ -49836,9 +49280,7 @@ "slug": "create-a-pull-request", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team, GitHub Enterprise Server 2.17+, and GitHub Enterprise Cloud. You can create a new pull request. This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.
", "bodyParameters": [ { @@ -50054,9 +49496,7 @@ "categoryLabel": "Pulls", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nProvides details for a review comment.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nEnables you to edit a review comment.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.List the reactions to a pull request review comment.
", "responses": [ @@ -50625,9 +50057,7 @@ "slug": "create-reaction-for-a-pull-request-review-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Create a reaction to a pull request review comment. A response with a Status: 200 OK means that you already added the reaction type to this pull request review comment.
Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nLists details of a pull request by providing its number.
\nWhen you get, create, or edit a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".
The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.
The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:
merge_commit_sha represents the SHA of the merge commit.merge_commit_sha represents the SHA of the squashed commit on the base branch.merge_commit_sha represents the commit that the base branch was updated to.Pass the appropriate media type to fetch diff and patch formats.
", "responses": [ @@ -51001,9 +50427,7 @@ "slug": "update-a-pull-request", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team, GitHub Enterprise Server 2.17+, and GitHub Enterprise Cloud.
", "bodyParameters": [ { @@ -51214,9 +50638,7 @@ "categoryLabel": "Pulls", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.
You can still create a review comment using the position parameter. When you use position, the line, side, start_line, and start_side parameters are not required. For more information, see Multi-line comment summary.
Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the List commits endpoint.
", "responses": [ @@ -51862,9 +51280,7 @@ "slug": "list-pull-requests-files", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
", "responses": [ @@ -51951,9 +51367,7 @@ "slug": "check-if-a-pull-request-has-been-merged", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -52087,9 +51501,7 @@ "slug": "merge-a-pull-request", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -52257,9 +51669,7 @@ "categoryLabel": "Pulls", "subcategory": "review-requests", "subcategoryLabel": "Review requests", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -52384,9 +51794,7 @@ "categoryLabel": "Pulls", "subcategory": "review-requests", "subcategoryLabel": "Review requests", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -52545,9 +51953,7 @@ "categoryLabel": "Pulls", "subcategory": "review-requests", "subcategoryLabel": "Review requests", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -52675,9 +52081,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "The list of reviews returns in chronological order.
", "responses": [ @@ -52964,9 +52368,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nPull request reviews created in the PENDING state do not include the submitted_at property in the response.
Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API v3 offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
Update the review summary comment with new text.
", "bodyParameters": [ { @@ -53478,9 +52876,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -53599,9 +52995,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List comments for a specific pull request review.
", "responses": [ @@ -53727,9 +53121,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
", "bodyParameters": [ { @@ -53884,9 +53276,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -54137,9 +53527,7 @@ "categoryLabel": "Repos", "subcategory": "contents", "subcategoryLabel": "Contents", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Gets the preferred README for a repository.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", "responses": [ @@ -54239,9 +53627,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the Repository Tags API.
\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.
", "responses": [ @@ -54395,9 +53781,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Users with push access to the repository can create a release.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -54539,9 +53923,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.
Users with push access to the repository can edit a release asset.
", "bodyParameters": [ { @@ -54788,9 +54168,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -54859,9 +54237,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "View the latest published full release for the repository.
\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the created_at attribute. The created_at attribute is the date of the commit used for the release, and not the date when the release was drafted or published.
Get a published release with the specified tag.
", "responses": [ @@ -55028,9 +54402,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.
Users with push access to the repository can edit a release.
", "bodyParameters": [ { @@ -55325,9 +54695,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -55426,9 +54794,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -55545,9 +54911,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nLists the people that have starred the repository.
\nYou can also find out when stars were created by passing the following custom media type via the Accept header:
Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
", "responses": [ @@ -55786,9 +55146,7 @@ "categoryLabel": "Repos", "subcategory": "statistics", "subcategoryLabel": "Statistics", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns the last year of commit activity grouped by week. The days array is a group of commits per day, starting on Sunday.
Returns the total number of commits authored by the contributor. In addition, the response includes a Weekly Hash (weeks array) with the following information:
w - Start of the week, given as a Unix timestamp.a - Number of additionsd - Number of deletionsc - Number of commitsReturns the total commit counts for the owner and total commit counts in all. all is everyone combined, including the owner in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract owner from all.
The array order is oldest week (index 0) to most recent week.
", "responses": [ @@ -56007,9 +55361,7 @@ "categoryLabel": "Repos", "subcategory": "statistics", "subcategoryLabel": "Statistics", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Each array contains the day number, hour number, and number of commits:
\n0-6: Sunday - Saturday0-23: Hour of dayFor example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.
Users with push access in a repository can create commit statuses for a given SHA.
\nNote: there is a limit of 1000 statuses per sha and context within a repository. Attempts to create more than 1000 statuses will result in a validation error.
Lists the people watching the specified repository.
", "responses": [ @@ -56644,9 +55992,7 @@ "slug": "list-repository-tags", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -56725,9 +56071,7 @@ "categoryLabel": "Repos", "subcategory": "contents", "subcategoryLabel": "Contents", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "302", @@ -56814,9 +56158,7 @@ "slug": "list-repository-teams", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -56891,9 +56233,7 @@ "slug": "get-all-repository-topics", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -57012,9 +56352,7 @@ "slug": "replace-all-repository-topics", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -57149,9 +56487,7 @@ "slug": "transfer-a-repository", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original owner, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see about repository transfers.
Lists all public repositories in the order that they were created.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.
Searches for query terms inside of a file. This method returns up to 100 results per page.
\nWhen searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:
q=addClass+in:file+language:js+repo:jquery/jquery
This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.
Due to the complexity of searching code, there are a few restrictions on how searches are performed:
\nmaster branch.language:go is not valid, while amazing language:go is.Find commits via various criteria on the default branch (usually master). This method returns up to 100 results per page.
When searching for commits, you can get text match metadata for the message field when you provide the text-match media type. For more details about how to receive highlighted search results, see Text match\nmetadata.
For example, if you want to find commits related to CSS in the octocat/Spoon-Knife repository. Your query would look something like this:
\nq=repo:octocat/Spoon-Knife+css
Find issues by state and keyword. This method returns up to 100 results per page.
\nWhen searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.
For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.
\nq=windows+label:bug+language:python+state:open&sort=created&order=asc
This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.
Note: For user-to-server GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"
Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results per page.
\nWhen searching for labels, you can get text match metadata for the label name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to find labels in the linguist repository that match bug, defect, or enhancement. Your query might look like this:
q=bug+defect+enhancement&repository_id=64778136
The labels that best match the query appear first in the search results.
", "responses": [ @@ -58321,9 +57641,7 @@ "slug": "search-repositories", "category": "search", "categoryLabel": "Search", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Find repositories via various criteria. This method returns up to 100 results per page.
\nWhen searching for repositories, you can get text match metadata for the name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:
\nq=tetris+language:assembly&sort=stars&order=desc
This query searches for repositories with the word tetris in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.
When you include the mercy preview header, you can also search for multiple topics by adding more topic: instances. For example, your query might look like this:
q=topic:ruby+topic:rails
Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results per page. See \"Searching topics\" for a detailed list of qualifiers.
\nWhen searching for topics, you can get text match metadata for the topic's short_description, description, name, or display_name field when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:
\nq=ruby+is:featured
This query searches for topics with the keyword ruby and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.
Find users via various criteria. This method returns up to 100 results per page.
\nWhen searching for users, you can get text match metadata for the issue login, email, and name fields when you pass the text-match media type. For more details about highlighting search results, see Text match metadata. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you're looking for a list of popular users, you might try this query:
\nq=tom+repos:%3E42+followers:%3E1000
This query searches for users with the name tom. The results are restricted to users with more than 42 repositories and over 1,000 followers.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the Get a team by name endpoint.
", "responses": [ @@ -59538,9 +58850,7 @@ "slug": "update-a-team-legacy", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a team endpoint.
\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote: With nested teams, the privacy for parent teams cannot be secret.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.
List all discussions on a team's page. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.
Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -60023,9 +59327,7 @@ "categoryLabel": "Teams", "subcategory": "discussions", "subcategoryLabel": "Discussions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion endpoint.
\nGet a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion endpoint.
\nEdits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion comments endpoint.
\nList all comments on a team discussion. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.
\nCreates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -60557,9 +59851,7 @@ "categoryLabel": "Teams", "subcategory": "discussion-comments", "subcategoryLabel": "Discussion comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion comment endpoint.
\nGet a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.
\nEdits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion comment endpoint.
Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with a Status: 200 OK means that you already added the reaction type to this team discussion comment.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members endpoint.
Team members will include the members of child teams.
", "responses": [ @@ -61477,9 +60757,7 @@ "categoryLabel": "Teams", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -61556,9 +60834,7 @@ "categoryLabel": "Teams", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "The \"Add team member\" endpoint (described below) is deprecated.
\nWe recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.
\nNote: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership for a user endpoint.
\nTeam members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create a team.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.
\nNote: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
", "bodyParameters": [ { @@ -61960,9 +61230,7 @@ "categoryLabel": "Teams", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -62055,9 +61323,7 @@ "slug": "list-team-projects-legacy", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team projects endpoint.
Lists the organization projects for a team.
", "responses": [ @@ -62145,9 +61411,7 @@ "slug": "check-team-permissions-for-a-project-legacy", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a project endpoint.
\nChecks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team project permissions endpoint.
\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team repositories endpoint.
", "responses": [ @@ -62553,9 +61811,7 @@ "slug": "check-team-permissions-for-a-repository-legacy", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -62669,9 +61925,7 @@ "slug": "add-or-update-team-repository-permissions-legacy", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -62775,9 +62029,7 @@ "slug": "remove-a-repository-from-a-team-legacy", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -62858,9 +62110,7 @@ "slug": "list-child-teams-legacy", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List child teams endpoint.
Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
Provides publicly available information about someone with a GitHub account.
\nGitHub Apps with the Plan user permission can use this endpoint to retrieve information about a user's GitHub Enterprise Server plan. The GitHub App must be authenticated as a user. See \"Identifying and authorizing users for GitHub Apps\" for details about authentication. For an example response, see 'Response with GitHub Enterprise Server plan information' below\"
The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.
The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".
", "responses": [ @@ -67579,9 +66823,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -67750,9 +66992,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -67832,9 +67072,7 @@ "categoryLabel": "Users", "subcategory": "followers", "subcategoryLabel": "Followers", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the people following the specified user.
", "responses": [ @@ -67915,9 +67153,7 @@ "categoryLabel": "Users", "subcategory": "followers", "subcategoryLabel": "Followers", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the people who the specified user follows.
", "responses": [ @@ -67987,9 +67223,7 @@ "categoryLabel": "Users", "subcategory": "followers", "subcategoryLabel": "Followers", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -68168,9 +67402,7 @@ "categoryLabel": "Users", "subcategory": "gpg-keys", "subcategoryLabel": "Gpg keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the GPG keys for a user. This information is accessible by anyone.
", "responses": [ @@ -68422,9 +67654,7 @@ "categoryLabel": "Users", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the verified public SSH keys for a user. This is accessible by anyone.
", "responses": [ @@ -68503,9 +67733,7 @@ "slug": "list-organizations-for-a-user", "category": "orgs", "categoryLabel": "Orgs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List public organization memberships for the specified user.
\nThis method only lists public memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the List organizations for the authenticated user API instead.
", "responses": [ @@ -68698,9 +67926,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -68780,9 +68006,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -68914,9 +68138,7 @@ "slug": "list-repositories-for-a-user", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists public repositories for the specified user.
", "responses": [ @@ -69147,9 +68369,7 @@ "categoryLabel": "Activity", "subcategory": "starring", "subcategoryLabel": "Starring", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists repositories a user has starred.
\nYou can also find out when stars were created by passing the following custom media type via the Accept header:
Lists repositories a user is watching.
", "responses": [ @@ -69456,9 +68674,7 @@ "slug": "get-the-zen-of-github", "category": "meta", "categoryLabel": "Meta", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", diff --git a/lib/rest/static/decorated/ghes-2.22.json b/lib/rest/static/decorated/ghes-2.22.json index 4ac7357ca844..6be80977d7e5 100644 --- a/lib/rest/static/decorated/ghes-2.22.json +++ b/lib/rest/static/decorated/ghes-2.22.json @@ -31,9 +31,7 @@ "slug": "github-api-root", "category": "meta", "categoryLabel": "Meta", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -3528,9 +3526,7 @@ "slug": "get-the-authenticated-app", "category": "apps", "categoryLabel": "Apps", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count in the response. For more details about your app's installations, see the \"List installations for the authenticated app\" endpoint.
You must use a JWT to access this endpoint.
", "responses": [ @@ -3688,9 +3684,7 @@ "slug": "list-installations-for-the-authenticated-app", "category": "apps", "categoryLabel": "Apps", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "You must use a JWT to access this endpoint.
\nThe permissions the installation has are included under the permissions key.
Enables an authenticated GitHub App to find an installation's information using the installation id. The installation's account type (target_type) will be either an organization or a user account, depending which account the repository belongs to.
You must use a JWT to access this endpoint.
", "responses": [ @@ -4031,9 +4023,7 @@ "slug": "create-an-installation-access-token-for-an-app", "category": "apps", "categoryLabel": "Apps", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of 401 - Unauthorized, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the repository_ids when creating the token. When you omit repository_ids, the response does not contain the repositories key.
You must use a JWT to access this endpoint.
", "responses": [ { @@ -5194,9 +5184,7 @@ "slug": "get-an-app", "category": "apps", "categoryLabel": "Apps", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: The :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).
If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a personal access token or an installation access token to access this endpoint.
", "responses": [ @@ -6354,9 +6342,7 @@ "slug": "get-all-codes-of-conduct", "category": "codes-of-conduct", "categoryLabel": "Codes of conduct", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -6432,9 +6418,7 @@ "slug": "get-a-code-of-conduct", "category": "codes-of-conduct", "categoryLabel": "Codes of conduct", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -6554,9 +6538,7 @@ "categoryLabel": "Apps", "subcategory": "installations", "subcategoryLabel": "Installations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id of the content reference from the content_reference event to create an attachment.
The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.
\nYou must use an installation access token to access this endpoint.
", "bodyParameters": [ { @@ -6658,9 +6640,7 @@ "slug": "get-emojis", "category": "emojis", "categoryLabel": "Emojis", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -8547,9 +8527,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -8614,9 +8592,7 @@ "categoryLabel": "Activity", "subcategory": "feeds", "subcategoryLabel": "Feeds", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "GitHub Enterprise Server provides several timeline resources in Atom format. The Feeds API lists all the feeds available to the authenticated user:
\nNote: Private feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
", "responses": [ @@ -10547,9 +10523,7 @@ "slug": "get-all-gitignore-templates", "category": "gitignore", "categoryLabel": "Gitignore", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List all templates available to pass as an option when creating a repository.
", "responses": [ @@ -10613,9 +10587,7 @@ "slug": "get-a-gitignore-template", "category": "gitignore", "categoryLabel": "Gitignore", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "The API also allows fetching the source of a single template.\nUse the raw media type to get the raw contents.
", "responses": [ @@ -10699,9 +10671,7 @@ "categoryLabel": "Apps", "subcategory": "installations", "subcategoryLabel": "Installations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List repositories that an app installation can access.
\nYou must use an installation access token to access this endpoint.
", "responses": [ @@ -10767,9 +10737,7 @@ "categoryLabel": "Apps", "subcategory": "installations", "subcategoryLabel": "Installations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -11050,9 +11018,7 @@ "slug": "get-all-commonly-used-licenses", "category": "licenses", "categoryLabel": "Licenses", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -11116,9 +11082,7 @@ "slug": "get-a-license", "category": "licenses", "categoryLabel": "Licenses", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -11229,9 +11193,7 @@ "slug": "render-a-markdown-document", "category": "markdown", "categoryLabel": "Markdown", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -11332,9 +11294,7 @@ "slug": "render-a-markdown-document-in-raw-mode", "category": "markdown", "categoryLabel": "Markdown", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -11387,9 +11347,7 @@ "slug": "get-github-enterprise-server-meta-information", "category": "meta", "categoryLabel": "Meta", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "This endpoint provides a list of GitHub's IP addresses. For more information, see \"About GitHub's IP addresses.\"
", "responses": [ @@ -11484,9 +11442,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -12224,9 +12180,7 @@ "slug": "get-octocat", "category": "meta", "categoryLabel": "Meta", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -12295,9 +12249,7 @@ "slug": "list-organizations", "category": "orgs", "categoryLabel": "Orgs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists all organizations, in the order that they were created on GitHub Enterprise Server.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
To see many of the organization response values, you need to be an authenticated organization owner with the admin:org scope. When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.
GitHub Apps with the Organization plan permission can use this endpoint to retrieve information about an organization's GitHub Enterprise Server plan. See \"Authenticating with GitHub Apps\" for details. For an example response, see 'Response with GitHub Enterprise Server plan information' below.\"
Parameter Deprecation Notice: GitHub Enterprise Server will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.
Enables an authenticated organization owner with the admin:org scope to update the organization's profile and member privileges.
Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see \"GitHub's products.\"
\nCreates a new self-hosted runner group for an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Gets a specific self-hosted runner group for an organization.\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Updates the name and visibility of a self-hosted runner group in an organization.\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see \"GitHub's products.\"
\nLists the repositories with access to a self-hosted runner group configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Lists self-hosted runners that are in a specific organization group.\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Lists all self-hosted runners configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Returns a token that you can pass to the config script. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.
Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\nReturns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.
You must authenticate using an access token with the admin:org scope to use this endpoint.
To remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\nGets a specific self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.
Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.
Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.
Lists all repositories that have been selected when the visibility for repository access to a secret is set to selected. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.
Here's how you can create a hook that posts payloads in JSON format:
", "responses": [ { @@ -16044,9 +15930,7 @@ "categoryLabel": "Orgs", "subcategory": "webhooks", "subcategoryLabel": "Webhooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns a webhook configured in an organization. To get only the webhook config properties, see \"Get a webhook configuration for an organization.\"
Updates a webhook configured in an organization. When you update a webhook, the secret will be overwritten. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use \"Update a webhook configuration for an organization.\"
Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with admin:read scope to use this endpoint.
List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.
", "responses": [ @@ -17089,9 +16963,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -17170,9 +17042,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -17246,9 +17116,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "In order to get a user's membership with an organization, the authenticated user must be an organization member.
", "responses": [ @@ -17365,9 +17233,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Only authenticated organization owners can add a member to the organization or update the member's role.
\npending until they accept the invitation.role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.Rate limits
\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
", "bodyParameters": [ { @@ -17468,9 +17334,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -17575,9 +17439,7 @@ "categoryLabel": "Orgs", "subcategory": "outside-collaborators", "subcategoryLabel": "Outside collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List all users who are outside collaborators of an organization.
", "responses": [ @@ -17647,9 +17509,7 @@ "categoryLabel": "Orgs", "subcategory": "outside-collaborators", "subcategoryLabel": "Outside collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\".
", "responses": [ @@ -17740,9 +17600,7 @@ "categoryLabel": "Orgs", "subcategory": "outside-collaborators", "subcategoryLabel": "Outside collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Removing a user from this list will remove them from all the organization's repositories.
", "responses": [ @@ -17835,9 +17693,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "org-pre-receive-hooks", "subcategoryLabel": "Org pre receive hooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.
", "responses": [ @@ -17914,9 +17770,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "org-pre-receive-hooks", "subcategoryLabel": "Org pre receive hooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -18026,9 +17880,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "org-pre-receive-hooks", "subcategoryLabel": "Org pre receive hooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "For pre-receive hooks which are allowed to be configured at the org level, you can set enforcement and allow_downstream_configuration
Removes any overrides for this hook at the org level for this org.
", "responses": [ @@ -18228,9 +18078,7 @@ "slug": "list-organization-projects", "category": "projects", "categoryLabel": "Projects", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the projects in an organization. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Creates an organization project board. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Members of an organization can choose to have their membership publicized or not.
", "responses": [ @@ -18536,9 +18380,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -18827,9 +18669,7 @@ "slug": "list-organization-repositories", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists repositories for the specified organization.
", "responses": [ @@ -19093,9 +18933,7 @@ "slug": "create-an-organization-repository", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.
\nOAuth scope requirements
\nWhen using OAuth, authorizations must include:
\npublic_repo scope or repo scope to create a public repositoryrepo scope to create a private repositoryLists all teams in an organization that are visible to the authenticated user.
", "responses": [ @@ -19519,9 +19355,7 @@ "slug": "create-a-team", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "To create a team, the authenticated user must be a member or owner of {org}. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"Setting team creation permissions.\"
When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of maintainers. For more information, see \"About teams\".
Gets a team using the team's slug. GitHub Enterprise Server generates the slug from the team name.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
To edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}.
List all discussions on a team's page. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.
Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nNote: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.
Get a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
List all comments on a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nNote: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
Get a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
Edits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with a Status: 200 OK means that you already added the reaction type to this team discussion comment.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
Team members will include the members of child teams.
\nTo list members in a team, the team must be visible to the authenticated user.
", "responses": [ @@ -22056,9 +21852,7 @@ "categoryLabel": "Teams", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create a team.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nAdds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
\nNote: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
\nNote: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}.
Lists the organization projects for a team.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects.
Checks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects/{project_id}.
Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.
Note: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}.
Lists a team's repositories visible to the authenticated user.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos.
Lists the child teams of the team specified by {team_slug}.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.
Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key.
Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
Gets a project by its id. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Updates a project board's information. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project admin to list collaborators.
Returns the collaborator's permission level for an organization project. Possible values for the permission key: admin, write, read, none. You must be an organization owner or a project admin to review a user's permission level.
Note: Accessing this endpoint does not count against your REST API rate limit.
\nNote: The rate object is deprecated. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.
When you pass the scarlet-witch-preview media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file.
The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.
Note: To edit a repository's topics, use the Replace all repository topics endpoint.
", "bodyParameters": [ { @@ -26248,9 +25974,7 @@ "slug": "delete-a-repository", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Deleting a repository requires admin access. If OAuth is used, the delete_repo scope is required.
If an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a 403 Forbidden response.
Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the repo scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo scope to use this endpoint.
Returns a token that you can pass to the config script. The token expires after one hour. You must authenticate\nusing an access token with the repo scope to use this endpoint.
Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN\nReturns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.\nYou must authenticate using an access token with the repo scope to use this endpoint.
To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.
\n./config.sh remove --token TOKEN\nGets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the secrets repository permission to use this endpoint.
Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
Gets a specific workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
List all workflow runs for a workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope.
Lists the available assignees for issues in a repository.
", "responses": [ @@ -29202,9 +28866,7 @@ "categoryLabel": "Issues", "subcategory": "assignees", "subcategoryLabel": "Assignees", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -29308,9 +28970,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -29401,9 +29061,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -29500,9 +29158,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "responses": [ @@ -30086,9 +29742,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -30627,9 +30281,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -30713,9 +30365,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "responses": [ @@ -30795,9 +30445,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
", "responses": [ @@ -30877,9 +30525,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -30970,9 +30616,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -31176,9 +30820,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
\nNote: Passing new arrays of users and teams replaces their previous values.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.
Note: You must enable branch protection to require signed commits.
", "responses": [ @@ -31545,9 +31183,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.
", "responses": [ @@ -31639,9 +31275,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -31725,9 +31359,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "responses": [ @@ -31850,9 +31482,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.
", "bodyParameters": [ { @@ -31964,9 +31594,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -32045,9 +31673,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "responses": [ @@ -32164,9 +31790,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "bodyParameters": [ { @@ -32306,9 +31930,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "bodyParameters": [ { @@ -32443,9 +32065,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "bodyParameters": [ { @@ -32548,9 +32168,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists who has access to this protected branch.
\nNote: Users, apps, and teams restrictions are only available for organization-owned repositories.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nGrants the specified apps push access for this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
| Type | Description |
|---|---|
array | The GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
| Type | Description |
|---|---|
array | The GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nRemoves the ability of an app to push to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
| Type | Description |
|---|---|
array | The GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists the teams who have push access to this branch. The list includes child teams.
", "responses": [ @@ -33318,9 +32924,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nGrants the specified teams push access for this branch. You can also give push access to child teams.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | The teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | The teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Teams that should no longer have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists the people who have push access to this branch.
", "responses": [ @@ -33801,9 +33399,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nGrants the specified people push access for this branch.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nRemoves the ability of a user to push to this branch.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames of the people who should no longer have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Creates a new check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to create check runs.
In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
", "responses": [ { @@ -36207,9 +35797,7 @@ "categoryLabel": "Checks", "subcategory": "runs", "subcategoryLabel": "Runs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Updates a check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to edit check runs.
Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"Update repository preferences for check suites\". Your GitHub App must have the checks:write permission to create check suites.
Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually Create a check suite. You must have admin permissions in the repository to set preferences for check suites.
", "responses": [ { @@ -38732,9 +38312,7 @@ "categoryLabel": "Checks", "subcategory": "suites", "subcategoryLabel": "Suites", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
Lists all open code scanning alerts for the default branch (usually main or master). For private repos, you must use an access token with the repo scope. For public repos, you must use an access token with public_repo and repo:security_events scopes. GitHub Apps must have the security_events read permission to use this endpoint.
Gets a single code scanning alert. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events read permission to use this endpoint.
The security alert_number is found at the end of the security alert's URL. For example, the security alert ID for https://github.com/Octo-org/octo-repo/security/code-scanning/88 is 88.
Updates the status of a single code scanning alert. For private repos, you must use an access token with the repo scope. For public repos, you must use an access token with public_repo and repo:security_events scopes.\nGitHub Apps must have the security_events write permission to use this endpoint.
List the details of recent code scanning analyses for a repository. For private repos, you must use an access token with the repo scope. For public repos, you must use an access token with public_repo and repo:security_events scopes. GitHub Apps must have the security_events read permission to use this endpoint.
For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
\nTeam members will include the members of child teams.
", "responses": [ @@ -39857,9 +39419,7 @@ "categoryLabel": "Repos", "subcategory": "collaborators", "subcategoryLabel": "Collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -39980,9 +39540,7 @@ "categoryLabel": "Repos", "subcategory": "collaborators", "subcategoryLabel": "Collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nFor more information the permission levels, see \"Repository permission levels for an organization\".
\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.
\nRate limits
\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
", "bodyParameters": [ { @@ -40103,9 +39661,7 @@ "categoryLabel": "Repos", "subcategory": "collaborators", "subcategoryLabel": "Collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -40183,9 +39739,7 @@ "categoryLabel": "Repos", "subcategory": "collaborators", "subcategoryLabel": "Collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Checks the repository permission of a collaborator. The possible repository permissions are admin, write, read, and none.
Commit Comments use these custom media types. You can read more about the use of media types in the API here.
\nComments are ordered by ascending ID.
", "responses": [ @@ -40376,9 +39928,7 @@ "categoryLabel": "Repos", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -40489,9 +40039,7 @@ "categoryLabel": "Repos", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -40586,9 +40134,7 @@ "categoryLabel": "Repos", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -40717,9 +40263,7 @@ "slug": "list-reactions-for-a-commit-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List the reactions to a commit comment.
", "responses": [ @@ -40850,9 +40394,7 @@ "slug": "create-reaction-for-a-commit-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Create a reaction to a commit comment. A response with a Status: 200 OK means that you already added the reaction type to this commit comment.
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.
", "responses": [ @@ -41351,9 +40887,7 @@ "categoryLabel": "Repos", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Use the :commit_sha to specify the commit that will have its comments listed.
Create a comment for a commit using its :commit_sha.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -41646,9 +41178,7 @@ "categoryLabel": "Repos", "subcategory": "commits", "subcategoryLabel": "Commits", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the List pull requests endpoint.
", "responses": [ @@ -41733,9 +41263,7 @@ "categoryLabel": "Repos", "subcategory": "commits", "subcategoryLabel": "Commits", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.
Note: If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
\nYou can pass the appropriate media type to fetch diff and patch formats. Diffs with binary data will have no patch property.
To return only the SHA-1 hash of the commit reference, you can provide the sha custom media type in the Accept header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.
Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.
\nThe most recent status for each context is returned, up to 100. This field paginates if there are over 100 contexts.
\nAdditionally, a combined state is returned. The state is one of:
error or failurependingsuccessUsers with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.
\nThis resource is also available via a legacy route: GET /repos/:owner/:repo/statuses/:ref.
This method returns the contents of the repository's code of conduct file, if one is detected.
", "responses": [ @@ -42388,9 +41906,7 @@ "categoryLabel": "Repos", "subcategory": "commits", "subcategoryLabel": "Commits", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Both :base and :head must be branch names in :repo. To compare branches across other repositories in the same network as :repo, use the format <USERNAME>:branch.
The response from the API is equivalent to running the git log base..head command; however, commits are returned in chronological order. Pass the appropriate media type to fetch diff and patch formats.
The response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.
Working with large comparisons
\nThe response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the List commits to enumerate all commits in the range.
\nFor comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long\nto generate. You can typically resolve this error by using a smaller commit range.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of all files in the repository.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNote:
\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
Creates a new file or replaces an existing file in a repository.
", "responses": [ { @@ -43289,9 +42801,7 @@ "categoryLabel": "Repos", "subcategory": "contents", "subcategoryLabel": "Contents", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Deletes a file in a repository.
\nYou can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.
The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.
You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.
Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.
\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.
", "responses": [ @@ -43705,9 +43213,7 @@ "categoryLabel": "Repos", "subcategory": "deployments", "subcategoryLabel": "Deployments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Simple filtering of deployments is available via query parameters:
", "responses": [ @@ -43921,9 +43427,7 @@ "categoryLabel": "Repos", "subcategory": "deployments", "subcategoryLabel": "Deployments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Deployments offer a few configurable parameters with certain defaults.
\nThe ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.
The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.
The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.
By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.
The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.
The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.
Users with repo or repo_deployment scopes can create a deployment for a given ref.
You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:
\nmaster in the response exampleIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.
\nThis error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.
This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.
Users with pull access can view deployment statuses for a deployment:
", "responses": [ @@ -44552,9 +44050,7 @@ "categoryLabel": "Repos", "subcategory": "deployments", "subcategoryLabel": "Deployments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Users with push access can create deployment statuses for a given deployment.
GitHub Apps require read & write access to \"Deployments\" and read-only access to \"Repo contents\" (for private repos). OAuth Apps require the repo_deployment scope.
Users with pull access can view a deployment status for a deployment:
", "responses": [ @@ -44845,9 +44339,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -44952,9 +44444,7 @@ "categoryLabel": "Repos", "subcategory": "forks", "subcategoryLabel": "Forks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -45049,9 +44539,7 @@ "categoryLabel": "Repos", "subcategory": "forks", "subcategoryLabel": "Forks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Create a fork for the authenticated user.
\nNote: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub Enterprise Server Support or GitHub Enterprise Server Premium Support.
", "bodyParameters": [ { @@ -45188,9 +44676,7 @@ "categoryLabel": "Git", "subcategory": "blobs", "subcategoryLabel": "Blobs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -45309,9 +44795,7 @@ "categoryLabel": "Git", "subcategory": "blobs", "subcategoryLabel": "Blobs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "The content in the response will always be Base64 encoded.
Note: This API supports blobs up to 100 megabytes in size.
", "responses": [ @@ -45609,9 +45093,7 @@ "categoryLabel": "Git", "subcategory": "commits", "subcategoryLabel": "Commits", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates a new Git commit object.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Gets a Git commit object.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.
When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.
Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nIf you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.
Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.
Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
", "responses": [ @@ -46199,9 +45675,7 @@ "categoryLabel": "Git", "subcategory": "refs", "subcategoryLabel": "Refs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.
", "bodyParameters": [ { @@ -46351,9 +45825,7 @@ "categoryLabel": "Git", "subcategory": "refs", "subcategoryLabel": "Refs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -46458,9 +45930,7 @@ "categoryLabel": "Git", "subcategory": "refs", "subcategoryLabel": "Refs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -46676,9 +46146,7 @@ "categoryLabel": "Git", "subcategory": "tags", "subcategoryLabel": "Tags", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary.
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.
\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"Create a commit\" and \"Update a reference.\"
", "responses": [ { @@ -47380,9 +46844,7 @@ "categoryLabel": "Git", "subcategory": "trees", "subcategoryLabel": "Trees", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns a single tree using the SHA1 value for that tree.
\nIf truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.
Repositories can have multiple webhooks installed. Each webhook should have a unique config. Multiple webhooks can\nshare the same config as long as those webhooks do not have any events that overlap.
Returns a webhook configured in a repository. To get only the webhook config properties, see \"Get a webhook configuration for a repository.\"
Updates a webhook configured in a repository. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use \"Update a webhook configuration for a repository.\"
When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.
", "responses": [ @@ -49063,9 +48509,7 @@ "categoryLabel": "Repos", "subcategory": "invitations", "subcategoryLabel": "Invitations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -49162,9 +48606,7 @@ "categoryLabel": "Repos", "subcategory": "invitations", "subcategoryLabel": "Invitations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -49365,9 +48807,7 @@ "slug": "list-repository-issues", "category": "issues", "categoryLabel": "Issues", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List issues in a repository.
\nNote: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.
Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -49806,9 +49244,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "By default, Issue Comments are ordered by ascending ID.
", "responses": [ @@ -49905,9 +49341,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -50018,9 +49452,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -50115,9 +49547,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -50241,9 +49671,7 @@ "slug": "list-reactions-for-an-issue-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List the reactions to an issue comment.
", "responses": [ @@ -50374,9 +49802,7 @@ "slug": "create-reaction-for-an-issue-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Create a reaction to an issue comment. A response with a Status: 200 OK means that you already added the reaction type to this issue comment.
The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.
Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.
Issue owners and users with push access can edit an issue.
", "bodyParameters": [ { @@ -51254,9 +50670,7 @@ "categoryLabel": "Issues", "subcategory": "assignees", "subcategoryLabel": "Assignees", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.
", "bodyParameters": [ { @@ -51378,9 +50792,7 @@ "categoryLabel": "Issues", "subcategory": "assignees", "subcategoryLabel": "Assignees", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Removes one or more assignees from an issue.
", "bodyParameters": [ { @@ -51510,9 +50922,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Issue Comments are ordered by ascending ID.
", "responses": [ @@ -51629,9 +51039,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -51768,9 +51176,7 @@ "categoryLabel": "Issues", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -51875,9 +51281,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -51994,9 +51398,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -52128,9 +51530,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Removes any previous labels and sets the new labels for an issue.
", "bodyParameters": [ { @@ -52233,9 +51633,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -52328,9 +51726,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a 404 Not Found status if the label does not exist.
List the reactions to an issue.
", "responses": [ @@ -52957,9 +52347,7 @@ "slug": "delete-an-issue-reaction", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -53071,9 +52459,7 @@ "categoryLabel": "Issues", "subcategory": "timeline", "subcategoryLabel": "Timeline", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -53178,9 +52564,7 @@ "categoryLabel": "Repos", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -53296,9 +52680,7 @@ "categoryLabel": "Repos", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "You can create a read-only deploy key.
", "bodyParameters": [ { @@ -53411,9 +52793,7 @@ "categoryLabel": "Repos", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -53498,9 +52878,7 @@ "categoryLabel": "Repos", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -53589,9 +52967,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -53712,9 +53088,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -53831,9 +53205,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -53960,9 +53332,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -54069,9 +53439,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -54138,9 +53506,7 @@ "slug": "list-repository-languages", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.
", "responses": [ @@ -54208,9 +53574,7 @@ "slug": "get-the-license-for-a-repository", "category": "licenses", "categoryLabel": "Licenses", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "This method returns the contents of the repository's license file, if one is detected.
\nSimilar to Get repository content, this method also supports custom media types for retrieving the raw license content or rendered license HTML.
", "responses": [ @@ -54327,9 +53691,7 @@ "categoryLabel": "Repos", "subcategory": "merging", "subcategoryLabel": "Merging", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -54521,9 +53883,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -54659,9 +54019,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -54793,9 +54151,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -54938,9 +54294,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -55062,9 +54416,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -55168,9 +54520,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -55471,9 +54821,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -55644,9 +54992,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Configures a GitHub Enterprise Server Pages site. For more information, see \"About GitHub Pages.\"
", "responses": [ { @@ -55870,9 +55216,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -56008,9 +55352,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -56114,9 +55456,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -56186,9 +55526,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.
\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.
", "responses": [ @@ -56258,9 +55596,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -56339,9 +55675,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -56438,9 +55772,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "repo-pre-receive-hooks", "subcategoryLabel": "Repo pre receive hooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.
", "responses": [ @@ -56526,9 +55858,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "repo-pre-receive-hooks", "subcategoryLabel": "Repo pre receive hooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -56637,9 +55967,7 @@ "categoryLabel": "Enterprise admin", "subcategory": "repo-pre-receive-hooks", "subcategoryLabel": "Repo pre receive hooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "For pre-receive hooks which are allowed to be configured at the repo level, you can set enforcement
Deletes any overridden enforcement on this repository for the specified hook.
\nResponds with effective values inherited from owner and/or global level.
", "responses": [ @@ -56848,9 +56174,7 @@ "slug": "list-repository-projects", "category": "projects", "categoryLabel": "Projects", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the projects in a repository. Returns a 404 Not Found status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Creates a repository project board. Returns a 404 Not Found status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
", "responses": [ @@ -57352,9 +56672,7 @@ "slug": "create-a-pull-request", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
\nYou can create a new pull request.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -57570,9 +56888,7 @@ "categoryLabel": "Pulls", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nProvides details for a review comment.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nEnables you to edit a review comment.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.List the reactions to a pull request review comment.
", "responses": [ @@ -58141,9 +57449,7 @@ "slug": "create-reaction-for-a-pull-request-review-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Create a reaction to a pull request review comment. A response with a Status: 200 OK means that you already added the reaction type to this pull request review comment.
Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nLists details of a pull request by providing its number.
\nWhen you get, create, or edit a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".
The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.
The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:
merge_commit_sha represents the SHA of the merge commit.merge_commit_sha represents the SHA of the squashed commit on the base branch.merge_commit_sha represents the commit that the base branch was updated to.Pass the appropriate media type to fetch diff and patch formats.
", "responses": [ @@ -58511,9 +57813,7 @@ "slug": "update-a-pull-request", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
", "bodyParameters": [ { @@ -58724,9 +58024,7 @@ "categoryLabel": "Pulls", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.
You can still create a review comment using the position parameter. When you use position, the line, side, start_line, and start_side parameters are not required. For more information, see Multi-line comment summary.
Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the List commits endpoint.
", "responses": [ @@ -59372,9 +58666,7 @@ "slug": "list-pull-requests-files", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
", "responses": [ @@ -59461,9 +58753,7 @@ "slug": "check-if-a-pull-request-has-been-merged", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -59597,9 +58887,7 @@ "slug": "merge-a-pull-request", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -59767,9 +59055,7 @@ "categoryLabel": "Pulls", "subcategory": "review-requests", "subcategoryLabel": "Review requests", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -59894,9 +59180,7 @@ "categoryLabel": "Pulls", "subcategory": "review-requests", "subcategoryLabel": "Review requests", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -60055,9 +59339,7 @@ "categoryLabel": "Pulls", "subcategory": "review-requests", "subcategoryLabel": "Review requests", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -60185,9 +59467,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "The list of reviews returns in chronological order.
", "responses": [ @@ -60474,9 +59754,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nPull request reviews created in the PENDING state do not include the submitted_at property in the response.
Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API v3 offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
Update the review summary comment with new text.
", "bodyParameters": [ { @@ -60988,9 +60262,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -61109,9 +60381,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List comments for a specific pull request review.
", "responses": [ @@ -61237,9 +60507,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
", "bodyParameters": [ { @@ -61394,9 +60662,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -61647,9 +60913,7 @@ "categoryLabel": "Repos", "subcategory": "contents", "subcategoryLabel": "Contents", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Gets the preferred README for a repository.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", "responses": [ @@ -61749,9 +61013,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the Repository Tags API.
\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.
", "responses": [ @@ -61905,9 +61167,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Users with push access to the repository can create a release.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -62049,9 +61309,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.
Users with push access to the repository can edit a release asset.
", "bodyParameters": [ { @@ -62298,9 +61554,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -62369,9 +61623,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "View the latest published full release for the repository.
\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the created_at attribute. The created_at attribute is the date of the commit used for the release, and not the date when the release was drafted or published.
Get a published release with the specified tag.
", "responses": [ @@ -62538,9 +61788,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.
Users with push access to the repository can edit a release.
", "bodyParameters": [ { @@ -62835,9 +62081,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -62936,9 +62180,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -63055,9 +62297,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nLists the people that have starred the repository.
\nYou can also find out when stars were created by passing the following custom media type via the Accept header:
Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
", "responses": [ @@ -63296,9 +62532,7 @@ "categoryLabel": "Repos", "subcategory": "statistics", "subcategoryLabel": "Statistics", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns the last year of commit activity grouped by week. The days array is a group of commits per day, starting on Sunday.
Returns the total number of commits authored by the contributor. In addition, the response includes a Weekly Hash (weeks array) with the following information:
w - Start of the week, given as a Unix timestamp.a - Number of additionsd - Number of deletionsc - Number of commitsReturns the total commit counts for the owner and total commit counts in all. all is everyone combined, including the owner in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract owner from all.
The array order is oldest week (index 0) to most recent week.
", "responses": [ @@ -63517,9 +62747,7 @@ "categoryLabel": "Repos", "subcategory": "statistics", "subcategoryLabel": "Statistics", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Each array contains the day number, hour number, and number of commits:
\n0-6: Sunday - Saturday0-23: Hour of dayFor example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.
Users with push access in a repository can create commit statuses for a given SHA.
\nNote: there is a limit of 1000 statuses per sha and context within a repository. Attempts to create more than 1000 statuses will result in a validation error.
Lists the people watching the specified repository.
", "responses": [ @@ -64154,9 +63378,7 @@ "slug": "list-repository-tags", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -64235,9 +63457,7 @@ "categoryLabel": "Repos", "subcategory": "contents", "subcategoryLabel": "Contents", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "302", @@ -64324,9 +63544,7 @@ "slug": "list-repository-teams", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -64401,9 +63619,7 @@ "slug": "get-all-repository-topics", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -64522,9 +63738,7 @@ "slug": "replace-all-repository-topics", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -64659,9 +63873,7 @@ "slug": "transfer-a-repository", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original owner, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see about repository transfers.
Lists all public repositories in the order that they were created.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.
Searches for query terms inside of a file. This method returns up to 100 results per page.
\nWhen searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:
q=addClass+in:file+language:js+repo:jquery/jquery
This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.
Due to the complexity of searching code, there are a few restrictions on how searches are performed:
\nmaster branch.language:go is not valid, while amazing language:go is.Find commits via various criteria on the default branch (usually master). This method returns up to 100 results per page.
When searching for commits, you can get text match metadata for the message field when you provide the text-match media type. For more details about how to receive highlighted search results, see Text match\nmetadata.
For example, if you want to find commits related to CSS in the octocat/Spoon-Knife repository. Your query would look something like this:
\nq=repo:octocat/Spoon-Knife+css
Find issues by state and keyword. This method returns up to 100 results per page.
\nWhen searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.
For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.
\nq=windows+label:bug+language:python+state:open&sort=created&order=asc
This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.
Note: For user-to-server GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"
Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results per page.
\nWhen searching for labels, you can get text match metadata for the label name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to find labels in the linguist repository that match bug, defect, or enhancement. Your query might look like this:
q=bug+defect+enhancement&repository_id=64778136
The labels that best match the query appear first in the search results.
", "responses": [ @@ -65831,9 +65027,7 @@ "slug": "search-repositories", "category": "search", "categoryLabel": "Search", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Find repositories via various criteria. This method returns up to 100 results per page.
\nWhen searching for repositories, you can get text match metadata for the name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:
\nq=tetris+language:assembly&sort=stars&order=desc
This query searches for repositories with the word tetris in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.
When you include the mercy preview header, you can also search for multiple topics by adding more topic: instances. For example, your query might look like this:
q=topic:ruby+topic:rails
Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results per page. See \"Searching topics\" for a detailed list of qualifiers.
\nWhen searching for topics, you can get text match metadata for the topic's short_description, description, name, or display_name field when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:
\nq=ruby+is:featured
This query searches for topics with the keyword ruby and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.
Find users via various criteria. This method returns up to 100 results per page.
\nWhen searching for users, you can get text match metadata for the issue login, email, and name fields when you pass the text-match media type. For more details about highlighting search results, see Text match metadata. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you're looking for a list of popular users, you might try this query:
\nq=tom+repos:%3E42+followers:%3E1000
This query searches for users with the name tom. The results are restricted to users with more than 42 repositories and over 1,000 followers.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the Get a team by name endpoint.
", "responses": [ @@ -67048,9 +66236,7 @@ "slug": "update-a-team-legacy", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a team endpoint.
\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote: With nested teams, the privacy for parent teams cannot be secret.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.
List all discussions on a team's page. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.
Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -67533,9 +66713,7 @@ "categoryLabel": "Teams", "subcategory": "discussions", "subcategoryLabel": "Discussions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion endpoint.
\nGet a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion endpoint.
\nEdits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion comments endpoint.
\nList all comments on a team discussion. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.
\nCreates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -68067,9 +67237,7 @@ "categoryLabel": "Teams", "subcategory": "discussion-comments", "subcategoryLabel": "Discussion comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion comment endpoint.
\nGet a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.
\nEdits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion comment endpoint.
Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with a Status: 200 OK means that you already added the reaction type to this team discussion comment.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members endpoint.
Team members will include the members of child teams.
", "responses": [ @@ -68987,9 +68143,7 @@ "categoryLabel": "Teams", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -69066,9 +68220,7 @@ "categoryLabel": "Teams", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "The \"Add team member\" endpoint (described below) is deprecated.
\nWe recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.
\nNote: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership for a user endpoint.
\nTeam members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create a team.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.
\nNote: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
", "bodyParameters": [ { @@ -69470,9 +68616,7 @@ "categoryLabel": "Teams", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -69565,9 +68709,7 @@ "slug": "list-team-projects-legacy", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team projects endpoint.
Lists the organization projects for a team.
", "responses": [ @@ -69655,9 +68797,7 @@ "slug": "check-team-permissions-for-a-project-legacy", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a project endpoint.
\nChecks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team project permissions endpoint.
\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team repositories endpoint.
", "responses": [ @@ -70063,9 +69197,7 @@ "slug": "check-team-permissions-for-a-repository-legacy", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -70179,9 +69311,7 @@ "slug": "add-or-update-team-repository-permissions-legacy", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -70285,9 +69415,7 @@ "slug": "remove-a-repository-from-a-team-legacy", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -70368,9 +69496,7 @@ "slug": "list-child-teams-legacy", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List child teams endpoint.
Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
Provides publicly available information about someone with a GitHub account.
\nGitHub Apps with the Plan user permission can use this endpoint to retrieve information about a user's GitHub Enterprise Server plan. The GitHub App must be authenticated as a user. See \"Identifying and authorizing users for GitHub Apps\" for details about authentication. For an example response, see 'Response with GitHub Enterprise Server plan information' below\"
The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.
The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".
", "responses": [ @@ -75041,9 +74161,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -75212,9 +74330,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -75294,9 +74410,7 @@ "categoryLabel": "Users", "subcategory": "followers", "subcategoryLabel": "Followers", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the people following the specified user.
", "responses": [ @@ -75377,9 +74491,7 @@ "categoryLabel": "Users", "subcategory": "followers", "subcategoryLabel": "Followers", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the people who the specified user follows.
", "responses": [ @@ -75449,9 +74561,7 @@ "categoryLabel": "Users", "subcategory": "followers", "subcategoryLabel": "Followers", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -75630,9 +74740,7 @@ "categoryLabel": "Users", "subcategory": "gpg-keys", "subcategoryLabel": "Gpg keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the GPG keys for a user. This information is accessible by anyone.
", "responses": [ @@ -75867,9 +74975,7 @@ "categoryLabel": "Users", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the verified public SSH keys for a user. This is accessible by anyone.
", "responses": [ @@ -75948,9 +75054,7 @@ "slug": "list-organizations-for-a-user", "category": "orgs", "categoryLabel": "Orgs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List public organization memberships for the specified user.
\nThis method only lists public memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the List organizations for the authenticated user API instead.
", "responses": [ @@ -76143,9 +75247,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -76225,9 +75327,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -76359,9 +75459,7 @@ "slug": "list-repositories-for-a-user", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists public repositories for the specified user.
", "responses": [ @@ -76592,9 +75690,7 @@ "categoryLabel": "Activity", "subcategory": "starring", "subcategoryLabel": "Starring", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists repositories a user has starred.
\nYou can also find out when stars were created by passing the following custom media type via the Accept header:
Lists repositories a user is watching.
", "responses": [ @@ -76901,9 +75995,7 @@ "slug": "get-the-zen-of-github", "category": "meta", "categoryLabel": "Meta", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 29e20ce1f3da..8344458abf70 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -31,9 +31,7 @@ "slug": "github-api-root", "category": "meta", "categoryLabel": "Meta", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -2387,9 +2385,7 @@ "slug": "get-the-authenticated-app", "category": "apps", "categoryLabel": "Apps", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count in the response. For more details about your app's installations, see the \"List installations for the authenticated app\" endpoint.
You must use a JWT to access this endpoint.
", "responses": [ @@ -2749,9 +2745,7 @@ "slug": "list-installations-for-the-authenticated-app", "category": "apps", "categoryLabel": "Apps", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "You must use a JWT to access this endpoint.
\nThe permissions the installation has are included under the permissions key.
Enables an authenticated GitHub App to find an installation's information using the installation id. The installation's account type (target_type) will be either an organization or a user account, depending which account the repository belongs to.
You must use a JWT to access this endpoint.
", "responses": [ @@ -3092,9 +3084,7 @@ "slug": "create-an-installation-access-token-for-an-app", "category": "apps", "categoryLabel": "Apps", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of 401 - Unauthorized, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the repository_ids when creating the token. When you omit repository_ids, the response does not contain the repositories key.
You must use a JWT to access this endpoint.
", "responses": [ { @@ -4007,9 +3997,7 @@ "slug": "get-an-app", "category": "apps", "categoryLabel": "Apps", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: The :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).
If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a personal access token or an installation access token to access this endpoint.
", "responses": [ @@ -4080,9 +4068,7 @@ "slug": "get-all-codes-of-conduct", "category": "codes-of-conduct", "categoryLabel": "Codes of conduct", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -4158,9 +4144,7 @@ "slug": "get-a-code-of-conduct", "category": "codes-of-conduct", "categoryLabel": "Codes of conduct", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -4280,9 +4264,7 @@ "categoryLabel": "Apps", "subcategory": "installations", "subcategoryLabel": "Installations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id of the content reference from the content_reference event to create an attachment.
The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.
\nYou must use an installation access token to access this endpoint.
", "bodyParameters": [ { @@ -4384,9 +4366,7 @@ "slug": "get-emojis", "category": "emojis", "categoryLabel": "Emojis", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -5041,9 +5021,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -5108,9 +5086,7 @@ "categoryLabel": "Activity", "subcategory": "feeds", "subcategoryLabel": "Feeds", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "GitHub AE provides several timeline resources in Atom format. The Feeds API lists all the feeds available to the authenticated user:
\nNote: Private feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
", "responses": [ @@ -7041,9 +7017,7 @@ "slug": "get-all-gitignore-templates", "category": "gitignore", "categoryLabel": "Gitignore", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List all templates available to pass as an option when creating a repository.
", "responses": [ @@ -7107,9 +7081,7 @@ "slug": "get-a-gitignore-template", "category": "gitignore", "categoryLabel": "Gitignore", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "The API also allows fetching the source of a single template.\nUse the raw media type to get the raw contents.
", "responses": [ @@ -7193,9 +7165,7 @@ "categoryLabel": "Apps", "subcategory": "installations", "subcategoryLabel": "Installations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List repositories that an app installation can access.
\nYou must use an installation access token to access this endpoint.
", "responses": [ @@ -7261,9 +7231,7 @@ "categoryLabel": "Apps", "subcategory": "installations", "subcategoryLabel": "Installations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -7544,9 +7512,7 @@ "slug": "get-all-commonly-used-licenses", "category": "licenses", "categoryLabel": "Licenses", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -7610,9 +7576,7 @@ "slug": "get-a-license", "category": "licenses", "categoryLabel": "Licenses", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -7723,9 +7687,7 @@ "slug": "render-a-markdown-document", "category": "markdown", "categoryLabel": "Markdown", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -7826,9 +7788,7 @@ "slug": "render-a-markdown-document-in-raw-mode", "category": "markdown", "categoryLabel": "Markdown", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -7881,9 +7841,7 @@ "slug": "get-github-ae-meta-information", "category": "meta", "categoryLabel": "Meta", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "This endpoint provides a list of GitHub's IP addresses. For more information, see \"About GitHub's IP addresses.\"
", "responses": [ @@ -7978,9 +7936,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -8718,9 +8674,7 @@ "slug": "get-octocat", "category": "meta", "categoryLabel": "Meta", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -8789,9 +8743,7 @@ "slug": "list-organizations", "category": "orgs", "categoryLabel": "Orgs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists all organizations, in the order that they were created on GitHub AE.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
To see many of the organization response values, you need to be an authenticated organization owner with the admin:org scope. When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.
GitHub Apps with the Organization plan permission can use this endpoint to retrieve information about an organization's GitHub AE plan. See \"Authenticating with GitHub Apps\" for details. For an example response, see 'Response with GitHub AE plan information' below.\"
Parameter Deprecation Notice: GitHub AE will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.
Enables an authenticated organization owner with the admin:org scope to update the organization's profile and member privileges.
Here's how you can create a hook that posts payloads in JSON format:
", "responses": [ { @@ -10003,9 +9945,7 @@ "categoryLabel": "Orgs", "subcategory": "webhooks", "subcategoryLabel": "Webhooks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns a webhook configured in an organization. To get only the webhook config properties, see \"Get a webhook configuration for an organization.\"
Updates a webhook configured in an organization. When you update a webhook, the secret will be overwritten. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use \"Update a webhook configuration for an organization.\"
Returns the webhook configuration for an organization. To get more information about the webhook, including the active state and events, use \"Get an organization webhook .\"
Access tokens must have the admin:org_hook scope, and GitHub Apps must have the organization_hooks:read permission.
Updates the webhook configuration for an organization. To update more information about the webhook, including the active state and events, use \"Update an organization webhook .\"
Access tokens must have the admin:org_hook scope, and GitHub Apps must have the organization_hooks:write permission.
Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with admin:read scope to use this endpoint.
List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.
", "responses": [ @@ -11292,9 +11218,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -11373,9 +11297,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -11449,9 +11371,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "In order to get a user's membership with an organization, the authenticated user must be an organization member.
", "responses": [ @@ -11568,9 +11488,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Only authenticated organization owners can add a member to the organization or update the member's role.
\npending until they accept the invitation.role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.Rate limits
\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
", "bodyParameters": [ { @@ -11671,9 +11589,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -11778,9 +11694,7 @@ "categoryLabel": "Orgs", "subcategory": "outside-collaborators", "subcategoryLabel": "Outside collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List all users who are outside collaborators of an organization.
", "responses": [ @@ -11850,9 +11764,7 @@ "categoryLabel": "Orgs", "subcategory": "outside-collaborators", "subcategoryLabel": "Outside collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\".
", "responses": [ @@ -11943,9 +11855,7 @@ "categoryLabel": "Orgs", "subcategory": "outside-collaborators", "subcategoryLabel": "Outside collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Removing a user from this list will remove them from all the organization's repositories.
", "responses": [ @@ -12052,9 +11962,7 @@ "slug": "list-organization-projects", "category": "projects", "categoryLabel": "Projects", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the projects in an organization. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Creates an organization project board. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Members of an organization can choose to have their membership publicized or not.
", "responses": [ @@ -12360,9 +12264,7 @@ "categoryLabel": "Orgs", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -12651,9 +12553,7 @@ "slug": "list-organization-repositories", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists repositories for the specified organization.
", "responses": [ @@ -12917,9 +12817,7 @@ "slug": "create-an-organization-repository", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.
\nOAuth scope requirements
\nWhen using OAuth, authorizations must include:
\npublic_repo scope or repo scope to create a public repositoryrepo scope to create a private repositoryLists all teams in an organization that are visible to the authenticated user.
", "responses": [ @@ -13343,9 +13239,7 @@ "slug": "create-a-team", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "To create a team, the authenticated user must be a member or owner of {org}. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"Setting team creation permissions.\"
When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of maintainers. For more information, see \"About teams\".
Gets a team using the team's slug. GitHub AE generates the slug from the team name.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
To edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}.
List all discussions on a team's page. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.
Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nNote: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.
Get a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
List all comments on a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nNote: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
Get a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
Edits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with a Status: 200 OK means that you already added the reaction type to this team discussion comment.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
Team members will include the members of child teams.
\nTo list members in a team, the team must be visible to the authenticated user.
", "responses": [ @@ -15880,9 +15736,7 @@ "categoryLabel": "Teams", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create a team.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nAdds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
\nNote: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub AE team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub AE.\"
\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
\nNote: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}.
Lists the organization projects for a team.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects.
Checks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects/{project_id}.
Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.
Note: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}.
Lists a team's repositories visible to the authenticated user.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos.
Lists the child teams of the team specified by {team_slug}.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.
Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key.
Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
Gets a project by its id. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Updates a project board's information. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project admin to list collaborators.
Returns the collaborator's permission level for an organization project. Possible values for the permission key: admin, write, read, none. You must be an organization owner or a project admin to review a user's permission level.
Note: Accessing this endpoint does not count against your REST API rate limit.
\nNote: The rate object is deprecated. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.
When you pass the scarlet-witch-preview media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file.
The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.
Note: To edit a repository's topics, use the Replace all repository topics endpoint.
", "bodyParameters": [ { @@ -20072,9 +19858,7 @@ "slug": "delete-a-repository", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Deleting a repository requires admin access. If OAuth is used, the delete_repo scope is required.
If an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a 403 Forbidden response.
Lists the available assignees for issues in a repository.
", "responses": [ @@ -20260,9 +20042,7 @@ "categoryLabel": "Issues", "subcategory": "assignees", "subcategoryLabel": "Assignees", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -20366,9 +20146,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -20459,9 +20237,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -20558,9 +20334,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "responses": [ @@ -21144,9 +20918,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -21685,9 +21457,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -21771,9 +21541,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "responses": [ @@ -21853,9 +21621,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
", "responses": [ @@ -21935,9 +21701,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -22028,9 +21792,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -22234,9 +21996,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
\nNote: Passing new arrays of users and teams replaces their previous values.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.
Note: You must enable branch protection to require signed commits.
", "responses": [ @@ -22603,9 +22359,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.
", "responses": [ @@ -22697,9 +22451,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -22783,9 +22535,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "responses": [ @@ -22908,9 +22658,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.
", "bodyParameters": [ { @@ -23022,9 +22770,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -23103,9 +22849,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "responses": [ @@ -23222,9 +22966,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "bodyParameters": [ { @@ -23364,9 +23106,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "bodyParameters": [ { @@ -23501,9 +23241,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "bodyParameters": [ { @@ -23606,9 +23344,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists who has access to this protected branch.
\nNote: Users, apps, and teams restrictions are only available for organization-owned repositories.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nGrants the specified apps push access for this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
| Type | Description |
|---|---|
array | The GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
| Type | Description |
|---|---|
array | The GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nRemoves the ability of an app to push to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
| Type | Description |
|---|---|
array | The GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists the teams who have push access to this branch. The list includes child teams.
", "responses": [ @@ -24376,9 +24100,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nGrants the specified teams push access for this branch. You can also give push access to child teams.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | The teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | The teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Teams that should no longer have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists the people who have push access to this branch.
", "responses": [ @@ -24859,9 +24575,7 @@ "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nGrants the specified people push access for this branch.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nRemoves the ability of a user to push to this branch.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames of the people who should no longer have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Creates a new check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to create check runs.
In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
", "responses": [ { @@ -27251,9 +26959,7 @@ "categoryLabel": "Checks", "subcategory": "runs", "subcategoryLabel": "Runs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Updates a check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to edit check runs.
Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"Update repository preferences for check suites\". Your GitHub App must have the checks:write permission to create check suites.
Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually Create a check suite. You must have admin permissions in the repository to set preferences for check suites.
", "responses": [ { @@ -29741,9 +29439,7 @@ "categoryLabel": "Checks", "subcategory": "suites", "subcategoryLabel": "Suites", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
\nTeam members will include the members of child teams.
", "responses": [ @@ -30158,9 +29848,7 @@ "categoryLabel": "Repos", "subcategory": "collaborators", "subcategoryLabel": "Collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -30281,9 +29969,7 @@ "categoryLabel": "Repos", "subcategory": "collaborators", "subcategoryLabel": "Collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nFor more information the permission levels, see \"Repository permission levels for an organization\".
\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.
\nRate limits
\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
", "bodyParameters": [ { @@ -30404,9 +30090,7 @@ "categoryLabel": "Repos", "subcategory": "collaborators", "subcategoryLabel": "Collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -30484,9 +30168,7 @@ "categoryLabel": "Repos", "subcategory": "collaborators", "subcategoryLabel": "Collaborators", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Checks the repository permission of a collaborator. The possible repository permissions are admin, write, read, and none.
Commit Comments use these custom media types. You can read more about the use of media types in the API here.
\nComments are ordered by ascending ID.
", "responses": [ @@ -30677,9 +30357,7 @@ "categoryLabel": "Repos", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -30790,9 +30468,7 @@ "categoryLabel": "Repos", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -30887,9 +30563,7 @@ "categoryLabel": "Repos", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -31018,9 +30692,7 @@ "slug": "list-reactions-for-a-commit-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List the reactions to a commit comment.
", "responses": [ @@ -31151,9 +30823,7 @@ "slug": "create-reaction-for-a-commit-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Create a reaction to a commit comment. A response with a Status: 200 OK means that you already added the reaction type to this commit comment.
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.
", "responses": [ @@ -31652,9 +31316,7 @@ "categoryLabel": "Repos", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Use the :commit_sha to specify the commit that will have its comments listed.
Create a comment for a commit using its :commit_sha.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -31947,9 +31607,7 @@ "categoryLabel": "Repos", "subcategory": "commits", "subcategoryLabel": "Commits", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the List pull requests endpoint.
", "responses": [ @@ -32034,9 +31692,7 @@ "categoryLabel": "Repos", "subcategory": "commits", "subcategoryLabel": "Commits", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.
Note: If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
\nYou can pass the appropriate media type to fetch diff and patch formats. Diffs with binary data will have no patch property.
To return only the SHA-1 hash of the commit reference, you can provide the sha custom media type in the Accept header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.
Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.
\nThe most recent status for each context is returned, up to 100. This field paginates if there are over 100 contexts.
\nAdditionally, a combined state is returned. The state is one of:
error or failurependingsuccessUsers with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.
\nThis resource is also available via a legacy route: GET /repos/:owner/:repo/statuses/:ref.
This method returns the contents of the repository's code of conduct file, if one is detected.
", "responses": [ @@ -32675,9 +32321,7 @@ "categoryLabel": "Repos", "subcategory": "commits", "subcategoryLabel": "Commits", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Both :base and :head must be branch names in :repo. To compare branches across other repositories in the same network as :repo, use the format <USERNAME>:branch.
The response from the API is equivalent to running the git log base..head command; however, commits are returned in chronological order. Pass the appropriate media type to fetch diff and patch formats.
The response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.
Working with large comparisons
\nThe response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the List commits to enumerate all commits in the range.
\nFor comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long\nto generate. You can typically resolve this error by using a smaller commit range.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of all files in the repository.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNote:
\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
Creates a new file or replaces an existing file in a repository.
", "responses": [ { @@ -33576,9 +33216,7 @@ "categoryLabel": "Repos", "subcategory": "contents", "subcategoryLabel": "Contents", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Deletes a file in a repository.
\nYou can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.
The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.
You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.
Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.
\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.
", "responses": [ @@ -33992,9 +33628,7 @@ "categoryLabel": "Repos", "subcategory": "deployments", "subcategoryLabel": "Deployments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Simple filtering of deployments is available via query parameters:
", "responses": [ @@ -34208,9 +33842,7 @@ "categoryLabel": "Repos", "subcategory": "deployments", "subcategoryLabel": "Deployments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Deployments offer a few configurable parameters with certain defaults.
\nThe ref parameter can be any named branch, tag, or SHA. At GitHub AE we often deploy branches and verify them\nbefore we merge a pull request.
The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.
The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.
By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.
The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.
The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.
Users with repo or repo_deployment scopes can create a deployment for a given ref.
You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:
\nmaster in the response exampleIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.
\nThis error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.
This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.
Users with pull access can view deployment statuses for a deployment:
", "responses": [ @@ -34839,9 +34465,7 @@ "categoryLabel": "Repos", "subcategory": "deployments", "subcategoryLabel": "Deployments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Users with push access can create deployment statuses for a given deployment.
GitHub Apps require read & write access to \"Deployments\" and read-only access to \"Repo contents\" (for private repos). OAuth Apps require the repo_deployment scope.
Users with pull access can view a deployment status for a deployment:
", "responses": [ @@ -35132,9 +34754,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -35239,9 +34859,7 @@ "categoryLabel": "Repos", "subcategory": "forks", "subcategoryLabel": "Forks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -35336,9 +34954,7 @@ "categoryLabel": "Repos", "subcategory": "forks", "subcategoryLabel": "Forks", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Create a fork for the authenticated user.
\nNote: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub AE Support or GitHub AE Premium Support.
", "bodyParameters": [ { @@ -35475,9 +35091,7 @@ "categoryLabel": "Git", "subcategory": "blobs", "subcategoryLabel": "Blobs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -35596,9 +35210,7 @@ "categoryLabel": "Git", "subcategory": "blobs", "subcategoryLabel": "Blobs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "The content in the response will always be Base64 encoded.
Note: This API supports blobs up to 100 megabytes in size.
", "responses": [ @@ -35896,9 +35508,7 @@ "categoryLabel": "Git", "subcategory": "commits", "subcategoryLabel": "Commits", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates a new Git commit object.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Gets a Git commit object.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.
When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.
Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nIf you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.
Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.
Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
", "responses": [ @@ -36486,9 +36090,7 @@ "categoryLabel": "Git", "subcategory": "refs", "subcategoryLabel": "Refs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.
", "bodyParameters": [ { @@ -36638,9 +36240,7 @@ "categoryLabel": "Git", "subcategory": "refs", "subcategoryLabel": "Refs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -36745,9 +36345,7 @@ "categoryLabel": "Git", "subcategory": "refs", "subcategoryLabel": "Refs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -36963,9 +36561,7 @@ "categoryLabel": "Git", "subcategory": "tags", "subcategoryLabel": "Tags", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary.
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.
\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"Create a commit\" and \"Update a reference.\"
", "responses": [ { @@ -37667,9 +37259,7 @@ "categoryLabel": "Git", "subcategory": "trees", "subcategoryLabel": "Trees", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns a single tree using the SHA1 value for that tree.
\nIf truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.
Repositories can have multiple webhooks installed. Each webhook should have a unique config. Multiple webhooks can\nshare the same config as long as those webhooks do not have any events that overlap.
Returns a webhook configured in a repository. To get only the webhook config properties, see \"Get a webhook configuration for a repository.\"
Updates a webhook configured in a repository. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use \"Update a webhook configuration for a repository.\"
Returns the webhook configuration for a repository. To get more information about the webhook, including the active state and events, use \"Get a repository webhook.\"
Access tokens must have the read:repo_hook or repo scope, and GitHub Apps must have the repository_hooks:read permission.
Updates the webhook configuration for a repository. To update more information about the webhook, including the active state and events, use \"Update a repository webhook.\"
Access tokens must have the write:repo_hook or repo scope, and GitHub Apps must have the repository_hooks:write permission.
When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.
", "responses": [ @@ -39612,9 +39182,7 @@ "categoryLabel": "Repos", "subcategory": "invitations", "subcategoryLabel": "Invitations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -39711,9 +39279,7 @@ "categoryLabel": "Repos", "subcategory": "invitations", "subcategoryLabel": "Invitations", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -39914,9 +39480,7 @@ "slug": "list-repository-issues", "category": "issues", "categoryLabel": "Issues", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List issues in a repository.
\nNote: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.
Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -40355,9 +39917,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "By default, Issue Comments are ordered by ascending ID.
", "responses": [ @@ -40454,9 +40014,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -40567,9 +40125,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -40664,9 +40220,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -40790,9 +40344,7 @@ "slug": "list-reactions-for-an-issue-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List the reactions to an issue comment.
", "responses": [ @@ -40923,9 +40475,7 @@ "slug": "create-reaction-for-an-issue-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Create a reaction to an issue comment. A response with a Status: 200 OK means that you already added the reaction type to this issue comment.
The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.
Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.
Issue owners and users with push access can edit an issue.
", "bodyParameters": [ { @@ -41803,9 +41343,7 @@ "categoryLabel": "Issues", "subcategory": "assignees", "subcategoryLabel": "Assignees", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.
", "bodyParameters": [ { @@ -41927,9 +41465,7 @@ "categoryLabel": "Issues", "subcategory": "assignees", "subcategoryLabel": "Assignees", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Removes one or more assignees from an issue.
", "bodyParameters": [ { @@ -42059,9 +41595,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Issue Comments are ordered by ascending ID.
", "responses": [ @@ -42178,9 +41712,7 @@ "categoryLabel": "Issues", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -42317,9 +41849,7 @@ "categoryLabel": "Issues", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -42424,9 +41954,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -42543,9 +42071,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -42677,9 +42203,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Removes any previous labels and sets the new labels for an issue.
", "bodyParameters": [ { @@ -42782,9 +42306,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -42877,9 +42399,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a 404 Not Found status if the label does not exist.
List the reactions to an issue.
", "responses": [ @@ -43506,9 +43020,7 @@ "slug": "delete-an-issue-reaction", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -43620,9 +43132,7 @@ "categoryLabel": "Issues", "subcategory": "timeline", "subcategoryLabel": "Timeline", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -43727,9 +43237,7 @@ "categoryLabel": "Repos", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -43845,9 +43353,7 @@ "categoryLabel": "Repos", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "You can create a read-only deploy key.
", "bodyParameters": [ { @@ -43960,9 +43466,7 @@ "categoryLabel": "Repos", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -44047,9 +43551,7 @@ "categoryLabel": "Repos", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -44138,9 +43640,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -44261,9 +43761,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -44380,9 +43878,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -44509,9 +44005,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -44618,9 +44112,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -44687,9 +44179,7 @@ "slug": "list-repository-languages", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.
", "responses": [ @@ -44757,9 +44247,7 @@ "slug": "get-the-license-for-a-repository", "category": "licenses", "categoryLabel": "Licenses", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "This method returns the contents of the repository's license file, if one is detected.
\nSimilar to Get repository content, this method also supports custom media types for retrieving the raw license content or rendered license HTML.
", "responses": [ @@ -44876,9 +44364,7 @@ "categoryLabel": "Repos", "subcategory": "merging", "subcategoryLabel": "Merging", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -45070,9 +44556,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -45208,9 +44692,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -45342,9 +44824,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -45487,9 +44967,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -45611,9 +45089,7 @@ "categoryLabel": "Issues", "subcategory": "milestones", "subcategoryLabel": "Milestones", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -45717,9 +45193,7 @@ "categoryLabel": "Issues", "subcategory": "labels", "subcategoryLabel": "Labels", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -46020,9 +45494,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -46193,9 +45665,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Configures a GitHub AE Pages site. For more information, see \"About GitHub Pages.\"
", "responses": [ { @@ -46419,9 +45889,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -46557,9 +46025,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -46663,9 +46129,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -46735,9 +46199,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.
\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.
", "responses": [ @@ -46807,9 +46269,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -46888,9 +46348,7 @@ "categoryLabel": "Repos", "subcategory": "pages", "subcategoryLabel": "Pages", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -47001,9 +46459,7 @@ "slug": "list-repository-projects", "category": "projects", "categoryLabel": "Projects", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the projects in a repository. Returns a 404 Not Found status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Creates a repository project board. Returns a 404 Not Found status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
", "responses": [ @@ -47505,9 +46957,7 @@ "slug": "create-a-pull-request", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
\nYou can create a new pull request.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -47723,9 +47173,7 @@ "categoryLabel": "Pulls", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nProvides details for a review comment.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nEnables you to edit a review comment.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.List the reactions to a pull request review comment.
", "responses": [ @@ -48294,9 +47734,7 @@ "slug": "create-reaction-for-a-pull-request-review-comment", "category": "reactions", "categoryLabel": "Reactions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Create a reaction to a pull request review comment. A response with a Status: 200 OK means that you already added the reaction type to this pull request review comment.
Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nLists details of a pull request by providing its number.
\nWhen you get, create, or edit a pull request, GitHub AE creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".
The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub AE has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.
The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:
merge_commit_sha represents the SHA of the merge commit.merge_commit_sha represents the SHA of the squashed commit on the base branch.merge_commit_sha represents the commit that the base branch was updated to.Pass the appropriate media type to fetch diff and patch formats.
", "responses": [ @@ -48664,9 +48098,7 @@ "slug": "update-a-pull-request", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
", "bodyParameters": [ { @@ -48877,9 +48309,7 @@ "categoryLabel": "Pulls", "subcategory": "comments", "subcategoryLabel": "Comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.
You can still create a review comment using the position parameter. When you use position, the line, side, start_line, and start_side parameters are not required. For more information, see Multi-line comment summary.
Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the List commits endpoint.
", "responses": [ @@ -49525,9 +48951,7 @@ "slug": "list-pull-requests-files", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
", "responses": [ @@ -49614,9 +49038,7 @@ "slug": "check-if-a-pull-request-has-been-merged", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -49750,9 +49172,7 @@ "slug": "merge-a-pull-request", "category": "pulls", "categoryLabel": "Pulls", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -49920,9 +49340,7 @@ "categoryLabel": "Pulls", "subcategory": "review-requests", "subcategoryLabel": "Review requests", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -50047,9 +49465,7 @@ "categoryLabel": "Pulls", "subcategory": "review-requests", "subcategoryLabel": "Review requests", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -50208,9 +49624,7 @@ "categoryLabel": "Pulls", "subcategory": "review-requests", "subcategoryLabel": "Review requests", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -50338,9 +49752,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "The list of reviews returns in chronological order.
", "responses": [ @@ -50627,9 +50039,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nPull request reviews created in the PENDING state do not include the submitted_at property in the response.
Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API v3 offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
Update the review summary comment with new text.
", "bodyParameters": [ { @@ -51141,9 +50547,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -51262,9 +50666,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List comments for a specific pull request review.
", "responses": [ @@ -51390,9 +50792,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
", "bodyParameters": [ { @@ -51547,9 +50947,7 @@ "categoryLabel": "Pulls", "subcategory": "reviews", "subcategoryLabel": "Reviews", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -51800,9 +51198,7 @@ "categoryLabel": "Repos", "subcategory": "contents", "subcategoryLabel": "Contents", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Gets the preferred README for a repository.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", "responses": [ @@ -51902,9 +51298,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the Repository Tags API.
\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.
", "responses": [ @@ -52058,9 +51452,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Users with push access to the repository can create a release.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -52202,9 +51594,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.
Users with push access to the repository can edit a release asset.
", "bodyParameters": [ { @@ -52451,9 +51839,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -52522,9 +51908,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "View the latest published full release for the repository.
\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the created_at attribute. The created_at attribute is the date of the commit used for the release, and not the date when the release was drafted or published.
Get a published release with the specified tag.
", "responses": [ @@ -52691,9 +52073,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.
Users with push access to the repository can edit a release.
", "bodyParameters": [ { @@ -52988,9 +52366,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -53089,9 +52465,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -53208,9 +52582,7 @@ "categoryLabel": "Repos", "subcategory": "releases", "subcategoryLabel": "Releases", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub AE expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nLists the people that have starred the repository.
\nYou can also find out when stars were created by passing the following custom media type via the Accept header:
Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
", "responses": [ @@ -53449,9 +52817,7 @@ "categoryLabel": "Repos", "subcategory": "statistics", "subcategoryLabel": "Statistics", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Returns the last year of commit activity grouped by week. The days array is a group of commits per day, starting on Sunday.
Returns the total number of commits authored by the contributor. In addition, the response includes a Weekly Hash (weeks array) with the following information:
w - Start of the week, given as a Unix timestamp.a - Number of additionsd - Number of deletionsc - Number of commitsReturns the total commit counts for the owner and total commit counts in all. all is everyone combined, including the owner in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract owner from all.
The array order is oldest week (index 0) to most recent week.
", "responses": [ @@ -53670,9 +53032,7 @@ "categoryLabel": "Repos", "subcategory": "statistics", "subcategoryLabel": "Statistics", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Each array contains the day number, hour number, and number of commits:
\n0-6: Sunday - Saturday0-23: Hour of dayFor example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.
Users with push access in a repository can create commit statuses for a given SHA.
\nNote: there is a limit of 1000 statuses per sha and context within a repository. Attempts to create more than 1000 statuses will result in a validation error.
Lists the people watching the specified repository.
", "responses": [ @@ -54307,9 +53663,7 @@ "slug": "list-repository-tags", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -54388,9 +53742,7 @@ "categoryLabel": "Repos", "subcategory": "contents", "subcategoryLabel": "Contents", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "302", @@ -54477,9 +53829,7 @@ "slug": "list-repository-teams", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -54554,9 +53904,7 @@ "slug": "get-all-repository-topics", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "", "responses": [ @@ -54675,9 +54023,7 @@ "slug": "replace-all-repository-topics", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "", "bodyParameters": [ { @@ -54812,9 +54158,7 @@ "slug": "transfer-a-repository", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original owner, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see about repository transfers.
Lists all public repositories in the order that they were created.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.
Searches for query terms inside of a file. This method returns up to 100 results per page.
\nWhen searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:
q=addClass+in:file+language:js+repo:jquery/jquery
This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.
Due to the complexity of searching code, there are a few restrictions on how searches are performed:
\nmaster branch.language:go is not valid, while amazing language:go is.Find commits via various criteria on the default branch (usually master). This method returns up to 100 results per page.
When searching for commits, you can get text match metadata for the message field when you provide the text-match media type. For more details about how to receive highlighted search results, see Text match\nmetadata.
For example, if you want to find commits related to CSS in the octocat/Spoon-Knife repository. Your query would look something like this:
\nq=repo:octocat/Spoon-Knife+css
Find issues by state and keyword. This method returns up to 100 results per page.
\nWhen searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.
For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.
\nq=windows+label:bug+language:python+state:open&sort=created&order=asc
This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.
Note: For user-to-server GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"
Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results per page.
\nWhen searching for labels, you can get text match metadata for the label name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to find labels in the linguist repository that match bug, defect, or enhancement. Your query might look like this:
q=bug+defect+enhancement&repository_id=64778136
The labels that best match the query appear first in the search results.
", "responses": [ @@ -55968,9 +55296,7 @@ "slug": "search-repositories", "category": "search", "categoryLabel": "Search", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Find repositories via various criteria. This method returns up to 100 results per page.
\nWhen searching for repositories, you can get text match metadata for the name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:
\nq=tetris+language:assembly&sort=stars&order=desc
This query searches for repositories with the word tetris in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.
When you include the mercy preview header, you can also search for multiple topics by adding more topic: instances. For example, your query might look like this:
q=topic:ruby+topic:rails
Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results per page. See \"Searching topics\" for a detailed list of qualifiers.
\nWhen searching for topics, you can get text match metadata for the topic's short_description, description, name, or display_name field when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:
\nq=ruby+is:featured
This query searches for topics with the keyword ruby and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.
Find users via various criteria. This method returns up to 100 results per page.
\nWhen searching for users, you can get text match metadata for the issue login, email, and name fields when you pass the text-match media type. For more details about highlighting search results, see Text match metadata. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you're looking for a list of popular users, you might try this query:
\nq=tom+repos:%3E42+followers:%3E1000
This query searches for users with the name tom. The results are restricted to users with more than 42 repositories and over 1,000 followers.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the Get a team by name endpoint.
", "responses": [ @@ -56397,9 +55717,7 @@ "slug": "update-a-team-legacy", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a team endpoint.
\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote: With nested teams, the privacy for parent teams cannot be secret.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.
List all discussions on a team's page. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.
Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -56882,9 +56194,7 @@ "categoryLabel": "Teams", "subcategory": "discussions", "subcategoryLabel": "Discussions", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion endpoint.
\nGet a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion endpoint.
\nEdits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion comments endpoint.
\nList all comments on a team discussion. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.
\nCreates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { @@ -57416,9 +56718,7 @@ "categoryLabel": "Teams", "subcategory": "discussion-comments", "subcategoryLabel": "Discussion comments", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion comment endpoint.
\nGet a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.
\nEdits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion comment endpoint.
Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with a Status: 200 OK means that you already added the reaction type to this team discussion comment.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members endpoint.
Team members will include the members of child teams.
", "responses": [ @@ -58336,9 +57624,7 @@ "categoryLabel": "Teams", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -58415,9 +57701,7 @@ "categoryLabel": "Teams", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "The \"Add team member\" endpoint (described below) is deprecated.
\nWe recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.
\nNote: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub AE team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub AE.\"
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership for a user endpoint.
\nTeam members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create a team.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.
\nNote: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub AE team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub AE.\"
\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
", "bodyParameters": [ { @@ -58819,9 +58097,7 @@ "categoryLabel": "Teams", "subcategory": "members", "subcategoryLabel": "Members", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -58914,9 +58190,7 @@ "slug": "list-team-projects-legacy", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team projects endpoint.
Lists the organization projects for a team.
", "responses": [ @@ -59004,9 +58278,7 @@ "slug": "check-team-permissions-for-a-project-legacy", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a project endpoint.
\nChecks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team project permissions endpoint.
\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team repositories endpoint.
", "responses": [ @@ -59412,9 +58678,7 @@ "slug": "check-team-permissions-for-a-repository-legacy", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -59528,9 +58792,7 @@ "slug": "add-or-update-team-repository-permissions-legacy", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -59634,9 +58896,7 @@ "slug": "remove-a-repository-from-a-team-legacy", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -59717,9 +58977,7 @@ "slug": "list-child-teams-legacy", "category": "teams", "categoryLabel": "Teams", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List child teams endpoint.
Lists all users, in the order that they signed up on GitHub AE. This list includes personal user accounts and organization accounts.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
Provides publicly available information about someone with a GitHub account.
\nGitHub Apps with the Plan user permission can use this endpoint to retrieve information about a user's GitHub AE plan. The GitHub App must be authenticated as a user. See \"Identifying and authorizing users for GitHub Apps\" for details about authentication. For an example response, see 'Response with GitHub AE plan information' below\"
The email key in the following response is the publicly visible email address from your GitHub AE profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub AE. For more information, see Authentication.
The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".
", "responses": [ @@ -63965,9 +63217,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -64136,9 +63386,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -64218,9 +63466,7 @@ "categoryLabel": "Users", "subcategory": "followers", "subcategoryLabel": "Followers", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the people following the specified user.
", "responses": [ @@ -64301,9 +63547,7 @@ "categoryLabel": "Users", "subcategory": "followers", "subcategoryLabel": "Followers", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the people who the specified user follows.
", "responses": [ @@ -64373,9 +63617,7 @@ "categoryLabel": "Users", "subcategory": "followers", "subcategoryLabel": "Followers", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "204", @@ -64554,9 +63796,7 @@ "categoryLabel": "Users", "subcategory": "gpg-keys", "subcategoryLabel": "Gpg keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the GPG keys for a user. This information is accessible by anyone.
", "responses": [ @@ -64791,9 +64031,7 @@ "categoryLabel": "Users", "subcategory": "keys", "subcategoryLabel": "Keys", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists the verified public SSH keys for a user. This is accessible by anyone.
", "responses": [ @@ -64872,9 +64110,7 @@ "slug": "list-organizations-for-a-user", "category": "orgs", "categoryLabel": "Orgs", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "List public organization memberships for the specified user.
\nThis method only lists public memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the List organizations for the authenticated user API instead.
", "responses": [ @@ -65067,9 +64303,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -65149,9 +64383,7 @@ "categoryLabel": "Activity", "subcategory": "events", "subcategoryLabel": "Events", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", @@ -65283,9 +64515,7 @@ "slug": "list-repositories-for-a-user", "category": "repos", "categoryLabel": "Repos", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists public repositories for the specified user.
", "responses": [ @@ -65396,9 +64626,7 @@ "categoryLabel": "Activity", "subcategory": "starring", "subcategoryLabel": "Starring", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "bodyParameters": [], "descriptionHTML": "Lists repositories a user has starred.
\nYou can also find out when stars were created by passing the following custom media type via the Accept header:
Lists repositories a user is watching.
", "responses": [ @@ -65705,9 +64931,7 @@ "slug": "get-the-zen-of-github", "category": "meta", "categoryLabel": "Meta", - "notes": [ - "Works with GitHub Apps" - ], + "notes": [], "responses": [ { "httpStatusCode": "200", diff --git a/script/rest/utils/operation.js b/script/rest/utils/operation.js index 2e58e82e591c..0593e7808b06 100644 --- a/script/rest/utils/operation.js +++ b/script/rest/utils/operation.js @@ -177,10 +177,6 @@ module.exports = class Operation { async renderNotes () { this.notes = [] - if (this['x-github'].enabledForGitHubApps) { - this.notes.push('Works with GitHub Apps') - } - return Promise.all(this.notes.map(async (note) => renderContent(note))) } }