Skip to content

repo sync #17579

New issue

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

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

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
May 3, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions content/rest/apps/apps.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Apps
intro: 'The GitHub Apps API enables you to retrieve the information about the installation as well as specific information about GitHub Apps.'
title: GitHub Apps
allowTitleToDifferFromFilename: true
intro: 'The {% data variables.product.prodname_github_apps %} API enables you to retrieve information about {% data variables.product.prodname_github_apps %}.'
topics:
- API
miniTocMaxHeadingLevel: 3
Expand All @@ -11,12 +12,14 @@ versions:
ghec: '*'
---

## About the {% data variables.product.prodname_github_apps %} API

{% data reusables.apps.general-apps-restrictions %}

This page lists endpoints that you can access while authenticated as a GitHub App. See "[Authenticating as a GitHub App](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app)" to learn more.

When authenticated as a GitHub App, the GitHub Apps API enables you to get high-level information about a GitHub App as well as specific information about installations of an app.

You can access REST API v3 endpoints while authenticated as a GitHub App. These endpoints have a "Notes" section that contains a bullet point that says "Works with GitHub Apps." You can also access these endpoints while authenticated as a user.
You can access REST API v3 endpoints while authenticated as a GitHub App. These endpoints have text that says "Works with GitHub Apps." You can also access these endpoints while authenticated as a user.

A subset of REST API v3 endpoints requires authenticating as a GitHub App installation. See [Installations](/rest/reference/apps#installations) for a list of these endpoints.
8 changes: 6 additions & 2 deletions content/rest/apps/installations.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Installations
intro: 'The Installations API enables you to get information about installations of your GitHub App and perform actions within those installations.'
title: GitHub App installations
allowTitleToDifferFromFilename: true
shortTitle: Installations
intro: 'The {% data variables.product.prodname_github_app %} installations API enables you to get information about installations of your {% data variables.product.prodname_github_app %} and perform actions within those installations.'
topics:
- API
miniTocMaxHeadingLevel: 3
Expand All @@ -11,6 +13,8 @@ versions:
ghec: '*'
---

## About the {% data variables.product.prodname_github_app %} installations API

An _installation_ refers to any user or organization account that has installed the app. For information on how to authenticate as an installation and limit access to specific repositories, see "[Authenticating as an installation](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)."

To list all GitHub App installations for an organization, see "[List app installations for an organization](/rest/reference/orgs#list-app-installations-for-an-organization)."
6 changes: 5 additions & 1 deletion content/rest/apps/marketplace.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Marketplace
title: GitHub Marketplace
allowTitleToDifferFromFilename: true
shortTitle: Marketplace
intro: ''
topics:
- API
Expand All @@ -9,6 +11,8 @@ versions:
ghec: '*'
---

## About the {% data variables.product.prodname_marketplace %} API

For more information about {% data variables.product.prodname_marketplace %}, see "[GitHub Marketplace](/marketplace/)."

The {% data variables.product.prodname_marketplace %} API allows you to see which customers are using a pricing plan, see a customer's purchases, and see if an account has an active subscription.
Expand Down
7 changes: 5 additions & 2 deletions content/rest/apps/oauth-applications.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: OAuth Applications
title: OAuth Apps
allowTitleToDifferFromFilename: true
intro: ''
topics:
- API
Expand All @@ -11,4 +12,6 @@ versions:
ghec: '*'
---

You can use this API to manage the OAuth tokens an OAuth application uses to access people's accounts on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}.
## About the {% data variables.product.prodname_oauth_app %} API

You can use this API to manage the OAuth tokens an {% data variables.product.prodname_oauth_app %} uses to access people's accounts on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}.
6 changes: 5 additions & 1 deletion content/rest/apps/webhooks.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Webhooks
title: GitHub App webhooks
allowTitleToDifferFromFilename: true
shortTitle: Webhooks
intro: ''
topics:
- API
Expand All @@ -11,4 +13,6 @@ versions:
ghec: '*'
---

## About the {% data variables.product.prodname_github_app %} webhooks API

A {% data variables.product.prodname_github_app %}'s webhook allows you to receive HTTP `POST` payloads whenever certain events happen for an app. {% data reusables.webhooks.webhooks-rest-api-links %}
2 changes: 2 additions & 0 deletions content/rest/codespaces/codespaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,6 @@ miniTocMaxHeadingLevel: 3

{% data reusables.codespaces.codespaces-api-beta-note %}

## About the Codespaces API

The {% data variables.product.prodname_codespaces %} API enables you to manage {% data variables.product.prodname_codespaces %} using the REST API. This API is available for authenticated users and OAuth Apps, but not GitHub Apps. For more information, see "[{% data variables.product.prodname_codespaces %}](/codespaces)."
10 changes: 7 additions & 3 deletions content/rest/codespaces/machines.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Machines
intro: 'The Machines API allows a user to determine which machine types are available to create a codespace, either on a given repository or as an authenticated user.'
title: Codespaces machines
allowTitleToDifferFromFilename: true
shortTitle: Machines
intro: 'The Codespaces machines API allows a user to determine which machine types are available to create a codespace, either on a given repository or as an authenticated user.'
versions:
fpt: '*'
ghec: '*'
Expand All @@ -9,6 +11,8 @@ topics:
miniTocMaxHeadingLevel: 3
---

For more information, see "[About machine types](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace#about-machine-types)."
## About the Codespaces machines API

The Codespaces machines API allows a user to determine which machine types are available to create a codespace, either on a given repository or as an authenticated user. For more information, see "[About machine types](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace#about-machine-types)."

You can also use this information when changing the machine of an existing codespace by updating its `machine` property. The machine update will take place the next time the codespace is restarted. For more information, see "[Changing the machine type for your codespace](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace)."
10 changes: 6 additions & 4 deletions content/rest/codespaces/repository-secrets.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Repository Secrets
intro: 'The Repository Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) for repositories that the user has access to.'
title: Codespaces repository secrets
allowTitleToDifferFromFilename: true
shortTitle: Repository secrets
intro: 'The Codespaces repository secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) for repositories that the user has access to in a codespace.'
versions:
fpt: '*'
ghec: '*'
Expand All @@ -10,6 +12,6 @@ topics:
miniTocMaxHeadingLevel: 3
---

## Repository Secrets
## About the Codespaces repository secrets API

The Repository Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) for repositories that the user has access to. These secrets are made available to the codespace at runtime. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."
The Codespaces repository secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) for repositories that the user has access to. These secrets are made available to the codespace at runtime. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."
11 changes: 6 additions & 5 deletions content/rest/codespaces/secrets.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
---
title: User Secrets
intro: 'The User Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) as well as assign secrets to repositories that the user has access to.'
title: Codespaces user secrets
allowTitleToDifferFromFilename: true
shortTitle: User secrets
intro: 'The Codespaces user secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) as well as assign secrets to repositories that the user has access to in a codespace.'
versions:
fpt: '*'
ghec: '*'
topics:
- API
miniTocMaxHeadingLevel: 3
allowTitleToDifferFromFilename: true
---

## User Secrets
## About the Codespaces user secrets API

The User Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) as well as assign secrets to repositories that the user has access to. These secrets are made available to the codespace at runtime. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."
The Codespaces user secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) as well as assign secrets to repositories that the user has access to. These secrets are made available to the codespace at runtime. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."
2 changes: 2 additions & 0 deletions content/rest/deployments/deployments.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ topics:
miniTocMaxHeadingLevel: 3
---

## About the deployments API

Deployments are requests to deploy a specific ref (branch, SHA, tag). GitHub dispatches a [`deployment` event](/developers/webhooks-and-events/webhook-events-and-payloads#deployment) that external services can listen for and act on when new deployments are created. Deployments enable developers and organizations to build loosely coupled tooling around deployments, without having to worry about the implementation details of delivering different types of applications (e.g., web, native).

Deployment statuses allow external services to mark deployments with an `error`, `failure`, `pending`, `in_progress`, `queued`, or `success` state that systems listening to [`deployment_status` events](/developers/webhooks-and-events/webhook-events-and-payloads#deployment_status) can consume.
Expand Down
8 changes: 6 additions & 2 deletions content/rest/deployments/environments.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Environments
intro: 'The Environments API allows you to create, configure, and delete environments.'
title: Deployment environments
allowTitleToDifferFromFilename: true
shortTitle: Environments
intro: 'The Deployment environments API allows you to create, configure, and delete deployment environments.'
versions:
fpt: '*'
ghes: '>=3.2'
Expand All @@ -11,6 +13,8 @@ topics:
miniTocMaxHeadingLevel: 3
---

## About the Deployment environments API

For more information about environments, see "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)." To manage environment secrets, see "[Secrets](/rest/reference/actions#secrets)."

{% data reusables.gated-features.environments %}
4 changes: 3 additions & 1 deletion content/rest/orgs/members.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Members
title: Organization members
allowTitleToDifferFromFilename: true
shortTitle: Members
intro: ''
versions:
fpt: '*'
Expand Down
8 changes: 6 additions & 2 deletions content/rest/orgs/webhooks.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Webhooks
title: Organization webhooks
allowTitleToDifferFromFilename: true
shortTitle: Webhooks
intro: ''
versions:
fpt: '*'
Expand All @@ -11,11 +13,13 @@ topics:
miniTocMaxHeadingLevel: 3
---

## About the Organization webhooks API

Organization webhooks allow you to receive HTTP `POST` payloads whenever certain events happen in an organization. {% data reusables.webhooks.webhooks-rest-api-links %}

For more information on actions you can subscribe to, see "[{% data variables.product.prodname_dotcom %} event types](/developers/webhooks-and-events/github-event-types)."

### Scopes & Restrictions
### Scopes and restrictions

All actions against organization webhooks require the authenticated user to be an admin of the organization being managed. Additionally, OAuth tokens require the `admin:org_hook` scope. For more information, see "[Scopes for OAuth Apps](/developers/apps/scopes-for-oauth-apps)."

Expand Down
8 changes: 6 additions & 2 deletions content/rest/projects/cards.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Cards
intro: ''
title: Project board cards
shortTitle: Cards
allowTitleToDifferFromFilename: true
intro: 'The Project board cards API lets you create and manage cards on a project board.'
versions:
fpt: '*'
ghes: '*'
Expand All @@ -10,3 +12,5 @@ topics:
- API
miniTocMaxHeadingLevel: 3
---

{% data reusables.projects.projects-api %}
7 changes: 5 additions & 2 deletions content/rest/projects/collaborators.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Collaborators
intro: "This API allows you to interact with an organization's projects."
title: Project board collaborators
shortTitle: Collaborators
allowTitleToDifferFromFilename: true
intro: 'The Project board collaborators API lets you manage collaborators on a project board.'
versions:
fpt: '*'
ghes: '*'
Expand All @@ -11,3 +13,4 @@ topics:
miniTocMaxHeadingLevel: 3
---

{% data reusables.projects.projects-api %}
8 changes: 6 additions & 2 deletions content/rest/projects/columns.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Columns
intro: ''
title: Project board columns
shortTitle: Columns
allowTitleToDifferFromFilename: true
intro: 'The Project board columns API lets you create and manage columns on a project board.'
versions:
fpt: '*'
ghes: '*'
Expand All @@ -10,3 +12,5 @@ topics:
- API
miniTocMaxHeadingLevel: 3
---

{% data reusables.projects.projects-api %}
10 changes: 7 additions & 3 deletions content/rest/projects/projects.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Projects
intro: 'The Projects API lets you create, list, update, delete and customize projects in a repository.'
title: Project boards
shortTitle: Boards
allowTitleToDifferFromFilename: true
intro: 'The Project boards API lets you create and manage projects in a repository.'
versions:
fpt: '*'
ghes: '*'
Expand All @@ -9,4 +11,6 @@ versions:
topics:
- API
miniTocMaxHeadingLevel: 3
---
---

{% data reusables.projects.projects-api %}
10 changes: 8 additions & 2 deletions content/rest/teams/discussion-comments.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Discussion Comments
title: Team discussion comments
allowTitleToDifferFromFilename: true
shortTitle: Discussion comments
intro: 'The team discussion comments API allows you to get, create, edit, and delete discussion comments on a [team discussion](/rest/reference/teams#discussions) post.'
versions:
fpt: '*'
Expand All @@ -11,4 +13,8 @@ topics:
miniTocMaxHeadingLevel: 3
---

Any member of the team's [organization](/rest/reference/orgs) can create and read comments on a public discussion. For more details, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions/)." This API is only available to authenticated members of the team's organization.
## About the Team discussion comments API

Any member of the team's [organization](/rest/reference/orgs) can create and read comments on a public discussion. For more details, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions/)."

{% data reusables.organizations.team-api %}
12 changes: 9 additions & 3 deletions content/rest/teams/discussions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Discussions
intro: "The Team Discussions API allows you to get, create, edit, and delete discussion posts on a team's page."
title: Team discussions
allowTitleToDifferFromFilename: true
shortTitle: Discussions
intro: "The Team discussions API allows you to get, create, edit, and delete discussion posts on a team's page."
versions:
fpt: '*'
ghes: '*'
Expand All @@ -11,4 +13,8 @@ topics:
miniTocMaxHeadingLevel: 3
---

You can use team discussions to have conversations that are not specific to a repository or project. Any member of the team's [organization](/rest/reference/orgs) can create and read public discussion posts. For more details, see "[About team discussions](//organizations/collaborating-with-your-team/about-team-discussions/)." To learn more about commenting on a discussion post, see the [team discussion comments API](/rest/reference/teams#discussion-comments). This API is only available to authenticated members of the team's organization.
## About the Team discussions API

You can use team discussions to have conversations that are not specific to a repository or project. Any member of the team's [organization](/rest/reference/orgs) can create and read public discussion posts. For more details, see "[About team discussions](//organizations/collaborating-with-your-team/about-team-discussions/)." To learn more about commenting on a discussion post, see the [team discussion comments API](/rest/reference/teams#discussion-comments).

{% data reusables.organizations.team-api %}
6 changes: 4 additions & 2 deletions content/rest/teams/external-groups.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: External Groups
intro: 'The external groups API allows you to view the external identity provider groups that are available to your organization and manage the connection between external groups and teams in your organization.'
title: External groups
intro: 'The External groups API allows you to view the external identity provider groups that are available to your organization and manage the connection between external groups and teams in your organization.'
versions:
fpt: '*'
ghae: '*'
Expand All @@ -10,6 +10,8 @@ topics:
miniTocMaxHeadingLevel: 3
---

## About the External groups API

To use this API, the authenticated user must be a team maintainer or an owner of the organization associated with the team.

{% ifversion ghec %}
Expand Down
8 changes: 6 additions & 2 deletions content/rest/teams/members.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Members
title: Team members
allowTitleToDifferFromFilename: true
shortTitle: Members
intro: ''
versions:
fpt: '*'
Expand All @@ -11,7 +13,9 @@ topics:
miniTocMaxHeadingLevel: 3
---

This API is only available to authenticated members of the team's organization. OAuth access tokens require the `read:org` [scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
## About the Team members API

{% data reusables.organizations.team-api %}

{% ifversion fpt or ghes or ghec %}
{% note %}
Expand Down
Loading