jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-08 12:01:53 -05:00
Code Issues Projects Releases Wiki Activity

Merge branch 'main' into patch-2

Browse Source
This commit is contained in:
Ramya Parimi
2021-10-06 12:55:42 -05:00
committed by GitHub
parent 443d202412 58b9f9e749
commit f834bb1eab
145 changed files with 2016 additions and 1539 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@@ -25,7 +25,7 @@ Closes [issue link]
### Check off the following:
- [ ] I have reviewed my changes in staging (look for the latest deployment event in your pull request's timeline, then click **View deployment**).
- [ ] For content changes, I have completed the [self-review checklist](https://github.com/github/docs/blob/main/CONTRIBUTING.md#self-review).
- [ ] For content changes, I have completed the [self-review checklist](https://github.com/github/docs/blob/main/contributing/self-review.md#self-review).
### Writer impact (This section is for GitHub staff members only):

2
.github/workflows/prod-build-deploy.yml vendored
View File

@@ -247,7 +247,7 @@ jobs:
throw error
}
- name: Send Slack notification if workflow fails
- name: Send Slack notification if workflow failed
uses: someimportantcompany/github-actions-slack-message@0b470c14b39da4260ed9e3f9a4f1298a74ccdefd
if: ${{ failure() }}
with:

9
.github/workflows/staging-build-pr.yml vendored
View File

@@ -14,6 +14,11 @@ on:
permissions:
contents: read
# This allows one Build workflow run to interrupt another
concurrency:
group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label }}'
cancel-in-progress: true
jobs:
debug:
runs-on: ubuntu-latest
@@ -27,8 +32,10 @@ jobs:
if: ${{ github.repository == 'github/docs-internal' || github.repository == 'github/docs' }}
runs-on: ubuntu-latest
timeout-minutes: 5
# This interrupts Build, Deploy, and pre-write Undeploy workflow runs in
# progress for this PR branch.
concurrency:
group: staging_${{ github.head_ref }}
group: 'PR Staging @ ${{ github.event.pull_request.head.label }}'
cancel-in-progress: true
steps:
- name: Check out repo

64
.github/workflows/staging-deploy-pr.yml vendored
View File

@@ -18,6 +18,15 @@ permissions:
pull-requests: read
statuses: write
# IMPORTANT: Intentionally OMIT a `concurrency` configuration from this workflow's
# top-level as we do not have any guarantee of identifying values being available
# within the `github.event` context for PRs from forked repos!
#
# The implication of this shortcoming is that we may have multiple workflow runs
# of this running at the same time for different commits within the same PR.
# However, once they reach the `concurrency` configurations deeper down within
# this workflow's jobs, then we can expect concurrent short-circuiting to begin.
env:
CONTEXT_NAME: '${{ github.workflow }} / deploy (${{ github.event.workflow_run.event }})'
ACTIONS_RUN_LOG: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}
@@ -183,9 +192,12 @@ jobs:
(github.repository == 'github/docs-internal' || github.repository == 'github/docs')
}}
runs-on: ubuntu-latest
timeout-minutes: 1
# This timeout should match or exceed the value of the timeout for Undeploy
timeout-minutes: 5
# This interrupts Build, Deploy, and pre-write Undeploy workflow runs in
# progress for this PR branch.
concurrency:
group: 'staging_${{ needs.pr-metadata.outputs.head_ref }}'
group: 'PR Staging @ ${{ needs.pr-metadata.outputs.head_label }}'
cancel-in-progress: true
outputs:
pull_request_state: ${{ steps.check-pr.outputs.state }}
@@ -197,12 +209,34 @@ jobs:
PR_NUMBER: ${{ needs.pr-metadata.outputs.number }}
with:
script: |
// Equivalent of the 'await-sleep' module without the install
const sleep = ms => new Promise(resolve => setTimeout(resolve, ms))
const blockingLabel = 'automated-block-deploy'
const { owner, repo } = context.repo
const { data: pullRequest } = await github.pulls.get({
owner,
repo,
pull_number: process.env.PR_NUMBER
})
const startTime = Date.now()
let pullRequest = {}
let blocked = true
// Keep polling the PR until the blocking label has been removed
while (blocked) {
const { data: pr } = await github.pulls.get({
owner,
repo,
pull_number: process.env.PR_NUMBER
})
blocked = pr.labels.some(({ name }) => name === blockingLabel)
if (blocked) {
console.warn(`WARNING! PR currently has blocking label "${blockingLabel}" (after ${Date.now() - startTime} ms). Will check again soon...`)
await sleep(15000) // Wait 15 seconds and check again
} else {
console.log(`PR was unblocked (after ${Date.now() - startTime} ms)!`)
pullRequest = pr
}
}
core.setOutput('state', pullRequest.state)
prepare-for-deploy:
@@ -210,8 +244,10 @@ jobs:
if: ${{ needs.check-pr-before-prepare.outputs.pull_request_state == 'open' }}
runs-on: ubuntu-latest
timeout-minutes: 5
# This interrupts Build, Deploy, and pre-write Undeploy workflow runs in
# progress for this PR branch.
concurrency:
group: 'staging_${{ needs.pr-metadata.outputs.head_ref }}'
group: 'PR Staging @ ${{ needs.pr-metadata.outputs.head_label }}'
cancel-in-progress: true
outputs:
source_blob_url: ${{ steps.build-source.outputs.download_url }}
@@ -361,7 +397,7 @@ jobs:
target_url: ACTIONS_RUN_LOG
})
- name: Send Slack notification if workflow fails
- name: Send Slack notification if deployment preparation job failed
uses: someimportantcompany/github-actions-slack-message@0b470c14b39da4260ed9e3f9a4f1298a74ccdefd
if: ${{ failure() }}
with:
@@ -374,8 +410,10 @@ jobs:
needs: [pr-metadata, prepare-for-deploy]
runs-on: ubuntu-latest
timeout-minutes: 1
# This interrupts Build, Deploy, and pre-write Undeploy workflow runs in
# progress for this PR branch.
concurrency:
group: 'staging_${{ needs.pr-metadata.outputs.head_ref }}'
group: 'PR Staging @ ${{ needs.pr-metadata.outputs.head_label }}'
cancel-in-progress: true
outputs:
pull_request_state: ${{ steps.check-pr.outputs.state }}
@@ -400,8 +438,10 @@ jobs:
if: ${{ needs.check-pr-before-deploy.outputs.pull_request_state == 'open' }}
runs-on: ubuntu-latest
timeout-minutes: 10
# This interrupts Build, Deploy, and pre-write Undeploy workflow runs in
# progress for this PR branch.
concurrency:
group: 'staging_${{ needs.pr-metadata.outputs.head_ref }}'
group: 'PR Staging @ ${{ needs.pr-metadata.outputs.head_label }}'
cancel-in-progress: true
steps:
- name: Check out repo's default branch
@@ -548,7 +588,7 @@ jobs:
target_url: ACTIONS_RUN_LOG
})
- name: Send Slack notification if workflow fails
- name: Send Slack notification if deployment job failed
uses: someimportantcompany/github-actions-slack-message@0b470c14b39da4260ed9e3f9a4f1298a74ccdefd
if: ${{ failure() }}
with:

66
.github/workflows/staging-undeploy-pr.yml vendored
View File

@@ -12,6 +12,12 @@ on:
permissions:
contents: read
deployments: write
pull-requests: write
# This prevents one Undeploy workflow run from interrupting another
concurrency:
group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label }}'
cancel-in-progress: false
jobs:
debug:
@@ -22,15 +28,42 @@ jobs:
GITHUB_CONTEXT: ${{ toJSON(github) }}
run: echo "$GITHUB_CONTEXT"
undeploy:
cancel-jobs-before-undeploy:
if: ${{ github.repository == 'github/docs-internal' || github.repository == 'github/docs' }}
name: Undeploy
runs-on: ubuntu-latest
timeout-minutes: 2
# This interrupts Build and Deploy workflow runs in progress for this PR
# branch. However, it does so with an intentionally short, independent job
# so that the following `undeploy` job cannot be cancelled once started!
concurrency:
group: staging_${{ github.head_ref }}
group: 'PR Staging @ ${{ github.event.pull_request.head.label }}'
cancel-in-progress: true
steps:
- name: Cancelling other deployments via concurrency configuration
run: |
echo 'Cancelling other deployment runs (if any)...'
undeploy:
needs: cancel-jobs-before-undeploy
if: ${{ github.repository == 'github/docs-internal' || github.repository == 'github/docs' }}
runs-on: ubuntu-latest
timeout-minutes: 5
# IMPORTANT: Intentionally OMIT a `concurrency` configuration from this job!
steps:
- name: Add a label to the PR to block deployment during undeployment
uses: actions/github-script@2b34a689ec86a68d8ab9478298f91d5401337b7d
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PR_NUMBER: ${{ github.event.pull_request.number }}
with:
script: |
const { owner, repo } = context.repo
await github.issues.addLabels({
owner,
repo,
issue_number: process.env.PR_NUMBER,
labels: ['automated-block-deploy']
})
- name: Check out repo's default branch
uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
with:
@@ -91,3 +124,28 @@ jobs:
console.error(error)
throw error
}
- if: ${{ always() }}
name: Remove the label from the PR to unblock deployment
uses: actions/github-script@2b34a689ec86a68d8ab9478298f91d5401337b7d
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PR_NUMBER: ${{ github.event.pull_request.number }}
with:
script: |
const { owner, repo } = context.repo
await github.issues.removeLabel({
owner,
repo,
issue_number: process.env.PR_NUMBER,
name: 'automated-block-deploy'
})
- name: Send Slack notification if workflow failed
uses: someimportantcompany/github-actions-slack-message@0b470c14b39da4260ed9e3f9a4f1298a74ccdefd
if: ${{ failure() }}
with:
channel: ${{ secrets.DOCS_STAGING_DEPLOYMENT_FAILURES_SLACK_CHANNEL_ID }}
bot-token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }}
color: failure
text: Staging undeployment failed for PR ${{ github.event.pull_request.html_url }} at commit ${{ github.head_sha }}. See https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}.

BIN
assets/images/help/images/deploy-graph.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 58 KiB

12
components/article/ArticlePage.tsx
View File

@@ -2,7 +2,7 @@ import { useRouter } from 'next/router'
import cx from 'classnames'
import { Heading } from '@primer/components'
import { ZapIcon, InfoIcon } from '@primer/octicons-react'
import { ZapIcon, InfoIcon, ShieldLockIcon } from '@primer/octicons-react'
import { Callout } from 'components/ui/Callout'
import { Link } from 'components/Link'
@@ -79,10 +79,12 @@ export const ArticlePage = () => {
{intro && <Lead data-testid="lead">{intro}</Lead>}
{permissions && (
<div
className="permissions-statement"
dangerouslySetInnerHTML={{ __html: permissions }}
/>
<div className="permissions-statement d-table">
<div className="d-table-cell pr-2">
<ShieldLockIcon size={16} />
</div>
<div className="d-table-cell" dangerouslySetInnerHTML={{ __html: permissions }} />
</div>
)}
{includesPlatformSpecificContent && (

38
content/actions/automating-builds-and-tests/about-continuous-integration.md
View File

@@ -1,6 +1,6 @@
---
title: About continuous integration
intro: 'You can create custom continuous integration (CI) and continuous deployment (CD) workflows directly in your {% data variables.product.prodname_dotcom %} repository with {% data variables.product.prodname_actions %}.'
intro: 'You can create custom continuous integration (CI) workflows directly in your {% data variables.product.prodname_dotcom %} repository with {% data variables.product.prodname_actions %}.'
product: '{% data reusables.gated-features.actions %}'
redirect_from:
- /articles/about-continuous-integration
@@ -15,7 +15,6 @@ versions:
type: overview
topics:
- CI
- CD
shortTitle: Continuous integration
---
@@ -48,45 +47,12 @@ In addition to helping you set up CI workflows for your project, you can use {%
For a definition of common terms, see "[Core concepts for {% data variables.product.prodname_actions %}](/github/automating-your-workflow-with-github-actions/core-concepts-for-github-actions)."
## Supported languages
<!-- If you make changes to this feature, update /getting-started-with-github/github-language-support to reflect any changes to supported languages. -->
## Workflow templates
{% data variables.product.product_name %} offers CI workflow templates for a variety of languages and frameworks.
Browse the complete list of CI workflow templates offered by {% data variables.product.product_name %} in the {% ifversion fpt %}[actions/starter-workflows](https://github.com/actions/starter-workflows/tree/main/ci) repository{% else %} `actions/starter-workflows` repository on {% data variables.product.product_location %}{% endif %}.
{% ifversion fpt or ghes > 3.0 or ghae-next %}
## Skipping workflow runs
If you want to temporarily prevent a workflow from being triggered, you can add a skip instruction to the commit message. Workflows that would otherwise be triggered `on: push` or `on: pull_request`, won't be triggered if you add any of the following strings to the commit message in a push, or the HEAD commit of a pull request:
* `[skip ci]`
* `[ci skip]`
* `[no ci]`
* `[skip actions]`
* `[actions skip]`
Alternatively, you can end the commit message with two empty lines followed by either `skip-checks: true` or `skip-checks:true`.
You won't be able to merge the pull request if your repository is configured to require specific checks to pass first. To allow the pull request to be merged you can push a new commit to the pull request without the skip instruction in the commit message.
{% note %}
**Note:** Skip instructions only apply to the `push` and `pull_request` events. For example, adding `[skip ci]` to a commit message won't stop a workflow that's triggered `on: pull_request_target` from running.
{% endnote %}
{% endif %}
## Notifications for workflow runs
{% data reusables.repositories.workflow-notifications %}
## Status badges for workflow runs
{% data reusables.repositories.actions-workflow-status-badge-intro %}
For more information, see "[Adding a workflow status badge](/actions/managing-workflow-runs/adding-a-workflow-status-badge)."
## Further reading
{% ifversion fpt %}

41
content/actions/deployment/about-continuous-deployment.md Normal file
View File

@@ -0,0 +1,41 @@
---
title: About continuous deployment
intro: 'You can create custom continuous deployment (CD) workflows directly in your {% data variables.product.prodname_dotcom %} repository with {% data variables.product.prodname_actions %}.'
product: '{% data reusables.gated-features.actions %}'
versions:
fpt: '*'
ghes: '*'
ghae: '*'
type: overview
topics:
- CD
shortTitle: Continuous deployment
---
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
## About continuous deployment
_Continuous deployment_ (CD) is the practice of using automation to publish and deploy software updates. As part of the typical CD process, the code is automatically built and tested before deployment.
Continuous deployment is often coupled with continuous integration. For more information about continuous integration, see "[About continuous integration](/actions/guides/about-continuous-integration)".
## About continuous deployment using {% data variables.product.prodname_actions %}
You can set up a {% data variables.product.prodname_actions %} workflow to deploy your software product. To verify that your product works as expected, your workflow can build the code in your repository and run your tests before deploying.
You can configure your CD workflow to run when a {% data variables.product.product_name %} event occurs (for example, when new code is pushed to the default branch of your repository), on a set schedule, manually, or when an external event occurs using the repository dispatch webhook. For more information about when your workflow can run, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)."
{% data variables.product.prodname_actions %} provides features that give you more control over deployments. For example, you can use environments to require approval for a job to proceed, restrict which branches can trigger a workflow, or limit access to secrets. You can use concurrency to limit your CD pipeline to a maximum of one in-progress deployment and one pending deployment. For more information about these features, see "[Deploying with GitHub Actions](/actions/deployment/deploying-with-github-actions)" and "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)."
## Workflow templates and third party actions
{% data reusables.actions.cd-templates-actions %}
## Further reading
- [Deploying with GitHub Actions](/actions/deployment/deploying-with-github-actions)
- [Using environments for deployment](/actions/deployment/using-environments-for-deployment){% ifversion fpt %}
- "[Managing billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions)"
{% endif %}

19
content/actions/deployment/deploying-to-amazon-elastic-container-service.md
View File

@@ -21,7 +21,7 @@ shortTitle: Deploy to Amazon ECS
## Introduction
This guide explains how to use {% data variables.product.prodname_actions %} to build a containerized application, push it to [Amazon Elastic Container Registry (ECR)](https://aws.amazon.com/ecr/), and deploy it to [Amazon Elastic Container Service (ECS)](https://aws.amazon.com/ecs/).
This guide explains how to use {% data variables.product.prodname_actions %} to build a containerized application, push it to [Amazon Elastic Container Registry (ECR)](https://aws.amazon.com/ecr/), and deploy it to [Amazon Elastic Container Service (ECS)](https://aws.amazon.com/ecs/) when a release is created.
On every new release in your {% data variables.product.company_short %} repository, the {% data variables.product.prodname_actions %} workflow builds and pushes a new container image to Amazon ECR, and then deploys a new task definition to Amazon ECS.
@@ -67,6 +67,8 @@ Before creating your {% data variables.product.prodname_actions %} workflow, you
See the documentation for each action used below for the recommended IAM policies for the IAM user, and methods for handling the access key credentials.
5. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %}
## Creating the workflow
Once you've completed the prerequisites, you can proceed with creating the workflow.
@@ -75,6 +77,8 @@ The following example workflow demonstrates how to build a container image and p
Ensure that you provide your own values for all the variables in the `env` key of the workflow.
{% data reusables.actions.delete-env-key %}
```yaml{:copy}
{% data reusables.actions.actions-not-certified-by-github-comment %}
@@ -94,17 +98,11 @@ env:
CONTAINER_NAME: MY_CONTAINER_NAME # set this to the name of the container in the
# containerDefinitions section of your task definition
defaults:
run:
shell: bash
jobs:
deploy:
name: Deploy
runs-on: ubuntu-latest{% ifversion fpt or ghes > 3.1 or ghae-next %}
permissions:
packages: write
contents: read{% endif %}
runs-on: ubuntu-latest
environment: production
{% raw %}steps:
- name: Checkout
@@ -151,9 +149,10 @@ jobs:
wait-for-service-stability: true{% endraw %}
```
## Additional resources
For the original starter workflow, see [`aws.yml`](https://github.com/actions/starter-workflows/blob/main/deployments/aws.yml) in the {% data variables.product.prodname_actions %} `starter-workflows` repository.
For more information on the services used in these examples, see the following documentation:
* "[Security best practices in IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html)" in the Amazon AWS documentation.

14
content/actions/deployment/deploying-to-azure-app-service.md
View File

@@ -67,13 +67,19 @@ Before creating your {% data variables.product.prodname_actions %} workflow, you
In your {% data variables.product.prodname_dotcom %} repository, create a secret named `AZURE_WEBAPP_PUBLISH_PROFILE` that contains the contents of the publish profile. For more information on creating secrets, see "[Encrypted secrets](/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository)."
4. For Linux apps, add an app setting called `WEBSITE_WEBDEPLOY_USE_SCM` and set it to true in your app. For more information, see "[Configure apps in the portal](https://docs.microsoft.com/en-us/azure/app-service/configure-common#configure-app-settings)" in the Azure documentation.
5. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %}
## Creating the workflow
Once you've completed the prerequisites, you can proceed with creating the workflow.
The following example workflow demonstrates how to build, test, and deploy the Node.js project to Azure App Service.
The following example workflow demonstrates how to build, test, and deploy the Node.js project to Azure App Service when a release is created.
Ensure that you set `AZURE_WEBAPP_NAME` in the workflow `env` key to the name of the web app you created.
Ensure that you set `AZURE_WEBAPP_NAME` in the workflow `env` key to the name of the web app you created. You can also change `AZURE_WEBAPP_PACKAGE_PATH` if the path to your project is not the repository root and `NODE_VERSION` if you want to use a node version other than `10.x`.
{% data reusables.actions.delete-env-key %}
```yaml{:copy}
{% data reusables.actions.actions-not-certified-by-github-comment %}
@@ -91,6 +97,8 @@ jobs:
build-and-deploy:
name: Build and Deploy
runs-on: ubuntu-latest
environment: production
steps:
- uses: actions/checkout@v2
@@ -121,4 +129,6 @@ The following resources may also be useful:
* For the original starter workflow, see [`azure.yml`](https://github.com/actions/starter-workflows/blob/main/deployments/azure.yml) in the {% data variables.product.prodname_actions %} `starter-workflows` repository.
* The action used to deploy the web app is the official Azure [`Azure/webapps-deploy`](https://github.com/Azure/webapps-deploy) action.
* For more examples of GitHub Action workflows that deploy to Azure, see the
[actions-workflow-samples](https://github.com/Azure/actions-workflow-samples) repository.
* The "[Create a Node.js web app in Azure](https://docs.microsoft.com/en-us/azure/app-service/quickstart-nodejs)" quickstart in the Azure web app documentation demonstrates using VS Code with the [Azure App Service extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azureappservice).

27
content/actions/deployment/deploying-to-google-kubernetes-engine.md
View File

@@ -13,7 +13,7 @@ topics:
- CD
- Containers
- Google Kubernetes Engine
shortTitle: Deploy to Kubernetes (GKE)
shortTitle: Deploy to Google Kubernetes Engine
---
{% data reusables.actions.enterprise-beta %}
@@ -21,7 +21,7 @@ shortTitle: Deploy to Kubernetes (GKE)
## Introduction
This guide explains how to use {% data variables.product.prodname_actions %} to build a containerized application, push it to Google Container Registry (GCR), and deploy it to Google Kubernetes Engine (GKE).
This guide explains how to use {% data variables.product.prodname_actions %} to build a containerized application, push it to Google Container Registry (GCR), and deploy it to Google Kubernetes Engine (GKE) when a release is created.
GKE is a managed Kubernetes cluster service from Google Cloud that can host your containerized workloads in the cloud or in your own datacenter. For more information, see [Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine).
@@ -60,7 +60,7 @@ $ gcloud services enable \
### Configuring a service account and storing its credentials
This procedure demonstrates how to create the service account for your GKE integration. It explains how to create the account, add roles to it, retrieve its keys, and store them as a base64-encoded [encrypted repository secret](/actions/reference/encrypted-secrets) named `GKE_SA_KEY`.
This procedure demonstrates how to create the service account for your GKE integration. It explains how to create the account, add roles to it, retrieve its keys, and store them as a base64-encoded encrypted repository secret named `GKE_SA_KEY`.
1. Create a new service account:
{% raw %}
@@ -96,16 +96,29 @@ This procedure demonstrates how to create the service account for your GKE integ
$ export GKE_SA_KEY=$(cat key.json | base64)
```
{% endraw %}
For more information about how to store a secret, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)."
### Storing your project name
Store the name of your project as a secret named `GKE_PROJECT`. For more information about how to store a secret, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)."
### (Optional) Configuring kustomize
Kustomize is an optional tool used for managing YAML specs. After creating a _kustomization_ file, the workflow below can be used to dynamically set fields of the image and pipe in the result to `kubectl`. For more information, see [kustomize usage](https://github.com/kubernetes-sigs/kustomize#usage).
### (Optional) Configure a deployment environment
{% data reusables.actions.about-environments %}
## Creating the workflow
Once you've completed the prerequisites, you can proceed with creating the workflow.
The following example workflow demonstrates how to build a container image and push it to GCR. It then uses the Kubernetes tools (such as `kubectl` and `kustomize`) to pull the image into the cluster deployment.
Under the `env` key, change the value of `GKE_CLUSTER` to the name of your cluster, `GKE_ZONE` to your cluster zone, `DEPLOYMENT_NAME` to the name of your deployment, and `IMAGE` to the name of your image.
{% data reusables.actions.delete-env-key %}
```yaml{:copy}
{% data reusables.actions.actions-not-certified-by-github-comment %}
@@ -126,8 +139,9 @@ jobs:
setup-build-publish-deploy:
name: Setup, Build, Publish, and Deploy
runs-on: ubuntu-latest
steps:
environment: production
steps:
- name: Checkout
uses: actions/checkout@v2
@@ -137,7 +151,8 @@ jobs:
service_account_key: {% raw %}${{ secrets.GKE_SA_KEY }}{% endraw %}
project_id: {% raw %}${{ secrets.GKE_PROJECT }}{% endraw %}
# Configure docker to use the gcloud command-line tool as a credential helper
# Configure Docker to use the gcloud command-line tool as a credential
# helper for authentication
- run: |-
gcloud --quiet auth configure-docker
@@ -165,7 +180,7 @@ jobs:
# Set up kustomize
- name: Set up Kustomize
run: |-
curl --location https://github.com/kubernetes-sigs/kustomize/releases/download/kustomize%2Fv4.2.0/kustomize_v4.2.0_linux_amd64.tar.gz | tar xz
curl -sfLo kustomize https://github.com/kubernetes-sigs/kustomize/releases/download/v3.1.0/kustomize_3.1.0_linux_amd64
chmod u+x ./kustomize
# Deploy the Docker image to the GKE cluster

173
content/actions/deployment/deploying-with-github-actions.md Normal file
View File

@@ -0,0 +1,173 @@
---
title: Deploying with GitHub Actions
intro: Learn how to control deployments with features like environments and concurrency.
product: '{% data reusables.gated-features.actions %}'
versions:
fpt: '*'
ghes: '>=3.1'
ghae: '*'
type: overview
topics:
- CD
shortTitle: Deploy with GitHub Actions
---
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
## Introduction
{% data variables.product.prodname_actions %} offers features that let you control deployments. You can:
- Trigger workflows with a variety of events.
- Configure environments to set rules before a job can proceed and to limit access to secrets.
- Use concurrency to control the number of deployments running at a time.
For more information about continuous deployment, see "[About continuous deployment](/actions/deployment/about-continuous-deployment)."
## Prerequisites
You should be familiar with the syntax for {% data variables.product.prodname_actions %}. For more information, see "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)."
## Triggering your deployment
You can use a variety of events to trigger your deployment workflow. Some of the most common are: `pull_request`, `push`, `release`, and `workflow_dispatch`.
For example, a workflow with the following triggers runs whenever:
- There is a push to the `main` branch.
- A pull request targeting the `main` branch is opened, synchronized, or reopened.
- A release is created.
- Someone manually triggers it.
```yaml
on:
push:
branches:
- main
pull_request:
branches:
- main
release:
types:
- created
workflow_dispatch:
```
For more information, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)."
## Using environments
{% data reusables.actions.about-environments %}
## Using concurrency
Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. You can use concurrency so that an environment has a maximum of one deployment in progress and one deployment pending at a time.
{% note %}
**Note:** `concurrency` and `environment` are not connected. The concurrency value can be any string; it does not need to be an environment name. Additionally, if another workflow uses the same environment but does not specify concurrency, that workflow will not be subject to any concurrency rules.
{% endnote %}
For example, when the following workflow runs, it will be paused with the status `pending` if any job or workflow that uses the `production` concurrency group is in progress. It will also cancel any job or workflow that uses the `production` concurrency group and has the status `pending`. This means that there will be a maximum of one running and one pending job or workflow in that uses the `production` concurrency group.
```yaml
name: Deployment
concurrency: production
on:
push:
branches:
- main
jobs:
deployment:
runs-on: ubuntu-latest
environment: production
steps:
- name: deploy
# ...deployment-specific steps
```
You can also specify concurrency at the job level. This will allow other jobs in the workflow to proceed even if the concurrent job is `pending`.
```yaml
name: Deployment
on:
push:
branches:
- main
jobs:
deployment:
runs-on: ubuntu-latest
environment: production
concurrency: production
steps:
- name: deploy
# ...deployment-specific steps
```
You can also use `cancel-in-progress` to cancel any currently running job or workflow in the same concurrency group.
```yaml
name: Deployment
concurrency:
group: production
cancel-in-progress: true
on:
push:
branches:
- main
jobs:
deployment:
runs-on: ubuntu-latest
environment: production
steps:
- name: deploy
# ...deployment-specific steps
```
## Viewing deployment history
When a {% data variables.product.prodname_actions %} workflow deploys to an environment, the environment is displayed on the main page of the repository. For more information about viewing deployments to environments, see "[Viewing deployment history](/developers/overview/viewing-deployment-history)."
## Monitoring workflow runs
Every workflow run generates a real-time graph that illustrates the run progress. You can use this graph to monitor and debug deployments. For more information see, "[Using the visualization graph](/actions/monitoring-and-troubleshooting-workflows/using-the-visualization-graph)."
You can also view the logs of each workflow run and the history of workflow runs. For more information, see "[Viewing workflow run history](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)."
## Tracking deployments through apps
{% ifversion fpt %}
If your {% data variables.product.product_name %} personal account or organization is integrated with Microsoft Teams or Slack, you can track deployments that use environments through Microsoft Teams or Slack. For example, you can receive notifications through the app when a deployment is pending approval, when a deployment is approved, or when the deployment status changes. For more information about integrating Microsoft Teams or Slack, see "[GitHub extensions and integrations](/github/customizing-your-github-workflow/exploring-integrations/github-extensions-and-integrations#team-communication-tools)."
{% endif %}
You can also build an app that uses deployment and deployment status webhooks to track deployments. {% data reusables.actions.environment-deployment-event %} For more information, see "[Apps](/developers/apps)" and "[Webhook events and payloads](/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment)."
{% ifversion fpt or ghes %}
## Choosing a runner
You can run your deployment workflow on {% data variables.product.product_name %}-hosted runners or on self-hosted runners. Traffic from {% data variables.product.product_name %}-hosted runners can come from a [wide range of network addresses](/rest/reference/meta#get-github-meta-information). If you are deploying to an internal environment and your company restricts external traffic into private networks, {% data variables.product.prodname_actions %} workflows running on {% data variables.product.product_name %}-hosted runners may not be communicate with your internal services or resources. To overcome this, you can host your own runners. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)" and "[About GitHub-hosted runners](/actions/using-github-hosted-runners/about-github-hosted-runners)."
{% endif %}
## Displaying a status badge
You can use a status badge to display the status of your deployment workflow. {% data reusables.repositories.actions-workflow-status-badge-intro %}
For more information, see "[Adding a workflow status badge](/actions/managing-workflow-runs/adding-a-workflow-status-badge)."
## Next steps
This article demonstrated features of {% data variables.product.prodname_actions %} that you can add to your deployment workflows.
{% data reusables.actions.cd-templates-actions %}

5
content/actions/deployment/index.md
View File

@@ -7,10 +7,13 @@ versions:
ghes: '*'
ghae: '*'
children:
- /about-continuous-deployment
- /deploying-with-github-actions
- /using-environments-for-deployment
- /viewing-deployment-history
- /deploying-to-amazon-elastic-container-service
- /deploying-to-azure-app-service
- /deploying-to-google-kubernetes-engine
- /installing-an-apple-certificate-on-macos-runners-for-xcode-development
- /environments
---

68
content/actions/deployment/environments.md → content/actions/deployment/using-environments-for-deployment.md
View File

@@ -1,9 +1,12 @@
---
title: Environments
intro: You can configure environments with protection rules and secrets. A workflow job can reference an environment to use the environment's protection rules and secrets.
title: Using environments for deployment
shortTitle: Use environments for deployment
intro: You can configure environments with protection rules and secrets. A workflow job that references an environment must follow any protection rules for the environment before running or accessing the environment's secrets.
product: '{% data reusables.gated-features.environments %}'
miniTocMaxHeadingLevel: 3
redirect_from:
- /actions/reference/environments
- /actions/deployment/environments
versions:
fpt: '*'
ghes: '>=3.1'
@@ -13,30 +16,34 @@ versions:
## About environments
Environments are used to describe a general deployment target like `production`, `staging`, or `development`. When a {% data variables.product.prodname_actions %} workflow deploys to an environment, the environment is displayed on the main page of the repository. For more information about viewing deployments to environments, see "[Viewing deployment history](/developers/overview/viewing-deployment-history)."
You can configure environments with protection rules and secrets. When a workflow job references an environment, the job won't start until all of the environment's protection rules pass. A job also cannot access secrets that are defined in an environment until all the environment protection rules pass.
{% ifversion fpt %}
Environment protection rules and environment secrets are only available on private repositories with {% data variables.product.prodname_ghe_cloud %}. {% data reusables.enterprise.link-to-ghec-trial %}
{% note %}
If you don't use {% data variables.product.prodname_ghe_cloud %} and convert a repository from public to private, any configured protection rules or environment secrets will be ignored, and you will not be able to configure any environments. If you convert your repository back to public, you will have access to any previously configured protection rules and environment secrets.
**Note:** If you don't use {% data variables.product.prodname_ghe_cloud %} and convert a repository from public to private, any configured protection rules or environment secrets will be ignored, and you will not be able to configure any environments. If you convert your repository back to public, you will have access to any previously configured protection rules and environment secrets. {% data reusables.enterprise.link-to-ghec-trial %}
{% endnote %}
{% endif %}
### Environment protection rules
## Environment protection rules
Environment protection rules require specific conditions to pass before a job referencing the environment can proceed. {% ifversion fpt or ghae-next or ghes > 3.1 %}You can use environment protection rules to require a manual approval, delay a job, or restrict the environment to certain branches.{% else %}You can use environment protection rules to require a manual approval or delay a job.{% endif %}
#### Required reviewers
### Required reviewers
Use required reviewers to require a specific person or team to approve workflow jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.
For more information on reviewing jobs that reference an environment with required reviewers, see "[Reviewing deployments](/actions/managing-workflow-runs/reviewing-deployments)."
#### Wait timer
### Wait timer
Use a wait timer to delay a job for a specific amount of time after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).
{% ifversion fpt or ghae-next or ghes > 3.1 %}
#### Deployment branches
### Deployment branches
Use deployment branches to restrict which branches can deploy to the environment. Below are the options for deployment branches for an environment:
@@ -46,13 +53,13 @@ Use deployment branches to restrict which branches can deploy to the environment
For example, if you specify `releases/*` as a deployment branch rule, only branches whose name begins with `releases/` can deploy to the environment. (Wildcard characters will not match `/`. To match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.) If you add `main` as a deployment branch rule, a branch named `main` can also deploy to the environment. For more information about syntax options for deployment branches, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).
{% endif %}
### Environment secrets
## Environment secrets
Secrets stored in an environment are only available to workflow jobs that reference the environment. If the environment requires approval, a job cannot access environment secrets until one of the required reviewers approves it. For more information about secrets, see "[Encrypted secrets](/actions/reference/encrypted-secrets)."
{% note %}
**Note:** Workflows that run on self-hosted runners are not run in an isolated container, even if they use environments. Environment secrets should be treated with the same level as security as repository and organization secrets. For more information, see "[Security hardening for GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#hardening-for-self-hosted-runners)."
**Note:** Workflows that run on self-hosted runners are not run in an isolated container, even if they use environments. Environment secrets should be treated with the same level of security as repository and organization secrets. For more information, see "[Security hardening for GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#hardening-for-self-hosted-runners)."
{% endnote %}
@@ -63,25 +70,36 @@ Secrets stored in an environment are only available to workflow jobs that refere
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}
{% data reusables.github-actions.sidebar-environment %}
1. Click **New environment**.
1. Enter a name for the environment, then click **Configure environment**. Environment names are not case sensitive. An environment name may not exceed 255 characters and must be unique within the repository.
1. Configure any environment protection rules or environment secrets.
{% data reusables.github-actions.new-environment %}
{% data reusables.github-actions.name-environment %}
1. Optionally, specify people or teams that must approve workflow jobs that use this environment.
1. Select **Required reviewers**.
1. Enter up to 6 people or teams. Only one of the required reviewers needs to approve the job for it to proceed.
1. Click **Save protection rules**.
2. Optionally, specify the amount of time to wait before allowing workflow jobs that use this environment to proceed.
1. Select **Wait timer**.
1. Enter the number of minutes to wait.
1. Click **Save protection rules**.
3. Optionally, specify what branches can deploy to this environment. For more information about the possible values, see "[Deployment branches](#deployment-branches)."
1. Select the desired option in the **Deployment branches** dropdown.
1. If you chose **Selected branches**, enter the branch name patterns that you want to allow.
4. Optionally, add environment secrets. These secrets are only available to workflow jobs that use the environment. Additionally, workflow jobs that use this environment can only access these secrets after any configured rules (for example, required reviewers) pass. For more information about secrets, see "[Encrypted secrets](/actions/reference/encrypted-secrets)."
1. Under **Environment secrets**, click **Add Secret**.
1. Enter the secret name.
1. Enter the secret value.
1. Click **Add secret**.
{% ifversion fpt or ghae-next or ghes > 3.1 %}You can also create and configure environments through the REST API. For more information, see "[Environments](/rest/reference/repos#environments)" and "[Secrets](/rest/reference/actions#secrets)."{% endif %}
Running a workflow that references an environment that does not exist will create an environment with the referenced name. The newly created environment will not have any protection rules or secrets configured. Anyone that can edit workflows in the repository can create environments via a workflow file, but only repository admins can configure the environment.
## Referencing an environment
## Using an environment
Each job in a workflow can reference a single environment. Any protection rules configured for the environment must pass before a job referencing the environment is sent to a runner. When the job is sent to the runner, the job can access the environment's secrets.
For more information on syntax to reference environments in workflows, see "[Workflow syntax for GitHub Actions](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idenvironment)." For more information on reviewing jobs that reference an environment with required reviewers, see "[Reviewing deployments](/actions/managing-workflow-runs/reviewing-deployments)."
Each job in a workflow can reference a single environment. Any protection rules configured for the environment must pass before a job referencing the environment is sent to a runner. The job can access the environment's secrets only after the job is sent to a runner.
When a workflow references an environment, the environment will appear in the repository's deployments. For more information about viewing current and previous deployments, see "[Viewing deployment history](/developers/overview/viewing-deployment-history)."
{% ifversion fpt or ghae-next or ghes > 3.1 %}
## Using concurrency to serialize deployments in an environment
You can use concurrency so that an environment has a maximum of one deployment in progress and one deployment pending at a time. For more information, see "[Workflow syntax for GitHub Actions](/actions/reference/workflow-syntax-for-github-actions#concurrency)."{% endif %}
{% data reusables.actions.environment-example %}
## Deleting an environment
@@ -96,3 +114,13 @@ Deleting an environment will delete all secrets and protection rules associated
2. Click **I understand, delete this environment**.
{% ifversion fpt or ghae-next or ghes > 3.1 %}You can also delete environments through the REST API. For more information, see "[Environments](/rest/reference/repos#environments)."{% endif %}
## How environments relate to deployments
{% data reusables.actions.environment-deployment-event %}
You can access these objects through the REST API or GraphQL API. You can also subscribe to these webhook events. For more information, see "[Repositories](/rest/reference/repos#deployments)" (REST API), "[Objects](/graphql/reference/objects#deployment)" (GraphQL API), or "[Webhook events and payloads](/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment)."
## Next steps
{% data variables.product.prodname_actions %} provides several features for managing your deployments. For more information, see "[Deploying with GitHub Actions](/actions/deployment/deploying-with-github-actions)."

6
content/developers/overview/viewing-deployment-history.md → content/actions/deployment/viewing-deployment-history.md
View File

@@ -8,17 +8,19 @@ versions:
topics:
- API
shortTitle: View deployment history
redirect_from:
- /developers/overview/viewing-deployment-history
---
You can deliver deployments through {% ifversion fpt or ghes > 3.0 %}{% data variables.product.prodname_actions %} and environments or with {% endif %}the REST API and third party apps. {% ifversion fpt or ghes > 3.0 %}For more information about {% data variables.product.prodname_actions %}, see "[{% data variables.product.prodname_actions %}](/actions)." {% endif %}For more information about deployments with the REST API, see "[Repositories](/rest/reference/repos#deployments)."
You can deliver deployments through {% ifversion fpt or ghae or ghes > 3.0 %}{% data variables.product.prodname_actions %} and environments or with {% endif %}the REST API and third party apps. {% ifversion fpt or ghae ghes > 3.0 %}For more information about using environments to deploy with {% data variables.product.prodname_actions %}, see "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)." {% endif %}For more information about deployments with the REST API, see "[Repositories](/rest/reference/repos#deployments)."
To view current and past deployments, click **Environments** on the home page of your repository.
{% ifversion ghae or ghes < 3.0 %}
![Environments](/assets/images/enterprise/2.22/environments-sidebar.png){% else %}
![Environments](/assets/images/environments-sidebar.png){% endif %}
The deployments page displays the last active deployment of each environment for your repository. If the deployment includes an environment URL, a "View deployment" button that links to the URL is shown next to the deployment.
The deployments page displays the last active deployment of each environment for your repository. If the deployment includes an environment URL, a **View deployment** button that links to the URL is shown next to the deployment.
The activity log shows the deployment history for your environments. By default, only the most recent deployment for an environment has an `Active` status; all previously active deployments have an `Inactive` status. For more information on automatic inactivation of deployments, see "[Inactive deployments](/rest/reference/repos#inactive-deployments)."

1
content/actions/index.md
View File

@@ -9,6 +9,7 @@ featuredLinks:
guides:
- /actions/learn-github-actions
- /actions/guides/about-continuous-integration
- /actions/deployment/deploying-with-github-actions
- /actions/guides/about-packaging-with-github-actions
- /actions/monitoring-and-troubleshooting-workflows/about-monitoring-and-troubleshooting
guideCards:

2
content/actions/learn-github-actions/creating-workflow-templates.md
View File

@@ -23,7 +23,7 @@ topics:
## Creating a workflow template
Workflow templates can be created by users with write access to the organization's `.github` repository. The templates can then be used by organization members who have permission to create workflows.
Workflow templates can be created by users with write access to the organization's `.github` repository. The templates can then be used by organization members who have permission to create workflows. You can share workflow templates if your organization's repository is public or if the repository is private and on an Enterprise plan.
{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 %}
{% note %}

2
content/actions/learn-github-actions/managing-complex-workflows.md
View File

@@ -175,7 +175,7 @@ To learn more about {% data variables.product.prodname_dotcom %}-hosted runner l
## Using environments
You can configure environments with protection rules and secrets. Each job in a workflow can reference a single environment. Any protection rules configured for the environment must pass before a job referencing the environment is sent to a runner. For more information, see "[Environments](/actions/reference/environments)."
You can configure environments with protection rules and secrets. Each job in a workflow can reference a single environment. Any protection rules configured for the environment must pass before a job referencing the environment is sent to a runner. For more information, see "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)."
{% endif %}
## Using a workflow template

36
content/actions/learn-github-actions/using-workflow-templates.md
View File

@@ -1,7 +1,7 @@
---
title: Using workflow templates
shortTitle: Using templates
intro: You can set up CI using a workflow template that matches the language and tooling you want to use.
intro: '{% data variables.product.product_name %} provides workflow templates for a variety of languages and tooling.'
product: '{% data reusables.gated-features.actions %}'
redirect_from:
- /articles/setting-up-continuous-integration-using-github-actions
@@ -17,39 +17,37 @@ type: tutorial
topics:
- Workflows
- CI
- CD
---
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
Anyone with write permission to a repository can set up continuous integration (CI) using {% data variables.product.prodname_actions %}.
## About workflow templates
You can use workflow templates to create new workflows in an organization's public repository. To use templates to create workflows in private repositories, the organization must be part of an enterprise plan.
{% data variables.product.product_name %} offers workflow templates for a variety of languages and tooling. When you set up workflows in your repository, {% data variables.product.product_name %} analyzes the code in your repository and recommends workflows based on the language and framework in your repository. For example, if you use [Node.js](https://nodejs.org/en/), {% data variables.product.product_name %} will suggest a template file that installs your Node.js packages and runs your tests.
After you set up CI, you can customize the workflow to meet your needs.
You can also create your own workflow templates to share with your organization. For more information, see "[Creating workflow templates](/actions/learn-github-actions/creating-workflow-templates)."
## Using workflow templates
Anyone with write permission to a repository can set up {% data variables.product.prodname_actions %} workflows for CI/CD or other automation.
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.actions-tab %}
1. If your repository already has existing workflows: In the upper-left corner, click **New workflow**.
![Create a new workflow](/assets/images/help/repository/actions-new-workflow.png)
2. Find the template that matches the language and tooling you want to use, then click **Set up this workflow**.
![Setup workflow button](/assets/images/help/repository/setup-workflow-button.png)
1. If you already have a workflow in your repository, click **New workflow**.
1. Find the template that you want to use, then click **Set up this workflow**.
1. If the workflow template contains comments detailing additional setup steps, follow these steps.
1. Some workflow templates use secrets. For example, {% raw %}`${{ secrets.npm_token }}`{% endraw %}. If the workflow template uses a secret, store the value described in the secret name as a secret in your repository. For more information, see "[Encrypted secrets](/actions/reference/encrypted-secrets)."
1. Optionally, make additional changes. For example, you might want to change the value of `on` to change when the workflow runs.
1. Click **Start commit**.
![Start commit button](/assets/images/help/repository/start-commit.png)
{% data reusables.files.write_commit_message %}
{% data reusables.files.choose_commit_branch %}
{% data reusables.files.propose_new_file %}
Once a push is made to your repository, you can follow the status and detailed logs of your continuous integration workflow run on {% data variables.product.prodname_dotcom %} and receive customized notifications. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#github-actions-notification-options)" and "[Managing a workflow run](/articles/managing-a-workflow-run)."
{% data reusables.repositories.actions-workflow-status-badge-intro %}
For more information, see "[Adding a workflow status badge](/actions/managing-workflow-runs/adding-a-workflow-status-badge)."
1. Write a commit message and decide whether to commit directly to the default branch or to open a pull request.
## Further reading
- "[About continuous integration](/articles/about-continuous-integration)"
- "[Managing a workflow run](/articles/managing-a-workflow-run)"
- "[Managing workflow runs](/actions/managing-workflow-runs)"
- "[About monitoring and troubleshooting](/actions/monitoring-and-troubleshooting-workflows/about-monitoring-and-troubleshooting)"
- "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)"
{% ifversion fpt %}
- "[Managing billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions)"

6
content/actions/learn-github-actions/workflow-syntax-for-github-actions.md
View File

@@ -353,8 +353,6 @@ defaults:
{% ifversion fpt or ghae-next or ghes > 3.1 %}
## `concurrency`
{% data reusables.actions.concurrency-beta %}
Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can only use the [`github` context](/actions/learn-github-actions/contexts#github-context). For more information about expressions, see "[Expressions](/actions/learn-github-actions/expressions)."
You can also specify `concurrency` at the job level. For more information, see [`jobs.<job_id>.concurrency`](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idconcurrency).
@@ -509,7 +507,7 @@ jobs:
{% ifversion fpt or ghes > 3.0 or ghae %}
## `jobs.<job_id>.environment`
The environment that the job references. All environment protection rules must pass before a job referencing the environment is sent to a runner. For more information, see "[Environments](/actions/reference/environments)."
The environment that the job references. All environment protection rules must pass before a job referencing the environment is sent to a runner. For more information, see "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)."
You can provide the environment as only the environment `name`, or as an environment object with the `name` and `url`. The URL maps to `environment_url` in the deployments API. For more information about the deployments API, see "[Deployments](/rest/reference/repos#deployments)."
@@ -544,8 +542,6 @@ environment:
{% ifversion fpt or ghae-next or ghes > 3.1 %}
## `jobs.<job_id>.concurrency`
{% data reusables.actions.concurrency-beta %}
{% note %}
**Note:** When concurrency is specified at the job level, order is not guaranteed for jobs or runs that queue within 5 minutes of each other.

1
content/actions/managing-workflow-runs/index.md
View File

@@ -19,6 +19,7 @@ children:
- /approving-workflow-runs-from-public-forks
- /reviewing-deployments
- /disabling-and-enabling-a-workflow
- /skipping-workflow-runs
- /deleting-a-workflow-run
- /downloading-workflow-artifacts
- /removing-workflow-artifacts

2
content/actions/managing-workflow-runs/reviewing-deployments.md
View File

@@ -13,7 +13,7 @@ versions:
Jobs that reference an environment configured with required reviewers will wait for an approval before starting. While a job is awaiting approval, it has a status of "Waiting". If a job is not approved within 30 days, the workflow run will be automatically canceled.
For more information about environments and required approvals, see "[Environments](/actions/reference/environments)."{% ifversion fpt or ghae-next or ghes > 3.1 %} For information about how to review deployments with the REST API, see "[Workflow Runs](/rest/reference/actions#workflow-runs)."{% endif %}
For more information about environments and required approvals, see "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)."{% ifversion fpt or ghae-next or ghes > 3.1 %} For information about how to review deployments with the REST API, see "[Workflow Runs](/rest/reference/actions#workflow-runs)."{% endif %}
## Approving or rejecting a job

33
content/actions/managing-workflow-runs/skipping-workflow-runs.md Normal file
View File

@@ -0,0 +1,33 @@
---
title: Skipping workflow runs
intro: 'You can skip workflow runs triggered by the `push` and `pull_request` events by including a command in your commit message.'
product: '{% data reusables.gated-features.actions %}'
versions:
fpt: '*'
ghes: '>=3.0'
ghae: 'ghae-next'
shortTitle: Skip workflow runs
---
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
Workflows that would otherwise be triggered using `on: push` or `on: pull_request` won't be triggered if you add any of the following strings to the commit message in a push, or the HEAD commit of a pull request:
* `[skip ci]`
* `[ci skip]`
* `[no ci]`
* `[skip actions]`
* `[actions skip]`
Alternatively, you can end the commit message with two empty lines followed by either `skip-checks: true` or `skip-checks:true`.
You won't be able to merge the pull request if your repository is configured to require specific checks to pass first. To allow the pull request to be merged you can push a new commit to the pull request without the skip instruction in the commit message.
{% note %}
**Note:** Skip instructions only apply to the `push` and `pull_request` events. For example, adding `[skip ci]` to a commit message won't stop a workflow that's triggered `on: pull_request_target` from running.
{% endnote %}
Skip instructions only apply to the workflow run(s) that would be triggered by the commit that contains the skip instructions. You can also disable a workflow from running. For more information, see "[Disabling and enabling a workflow](/actions/managing-workflow-runs/disabling-and-enabling-a-workflow)."

1
content/actions/monitoring-and-troubleshooting-workflows/index.md
View File

@@ -17,6 +17,7 @@ children:
- /viewing-job-execution-time
- /using-workflow-run-logs
- /enabling-debug-logging
- /notifications-for-workflow-runs
---
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}

15
content/actions/monitoring-and-troubleshooting-workflows/notifications-for-workflow-runs.md Normal file
View File

@@ -0,0 +1,15 @@
---
title: Notifications for workflow runs
intro: 'You can subscribe to notifications about workflow runs that you trigger.'
product: '{% data reusables.gated-features.actions %}'
versions:
fpt: '*'
ghes: '*'
ghae: '*'
shortTitle: Notifications
---
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
{% data reusables.repositories.workflow-notifications %}

2
content/actions/security-guides/security-hardening-for-github-actions.md
View File

@@ -47,7 +47,7 @@ To help prevent accidental disclosure, {% data variables.product.product_name %}
- Rotate secrets periodically to reduce the window of time during which a compromised secret is valid.
{% ifversion fpt or ghes > 3.0 or ghae %}
- **Consider requiring review for access to secrets**
- You can use required reviewers to protect environment secrets. A workflow job cannot access environment secrets until approval is granted by a reviewer. For more information about storing secrets in environments or requiring reviews for environments, see "[Encrypted secrets](/actions/reference/encrypted-secrets)" and "[Environments](/actions/reference/environments)."
- You can use required reviewers to protect environment secrets. A workflow job cannot access environment secrets until approval is granted by a reviewer. For more information about storing secrets in environments or requiring reviews for environments, see "[Encrypted secrets](/actions/reference/encrypted-secrets)" and "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)."
{% endif %}
## Using `CODEOWNERS` to monitor changes

38
content/admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/enabling-unified-search-between-github-enterprise-server-and-githubcom.md
View File

@@ -1,38 +0,0 @@
---
title: Enabling unified search between GitHub Enterprise Server and GitHub.com
intro: 'After enabling {% data variables.product.prodname_github_connect %}, you can allow search of {% data variables.product.prodname_dotcom_the_website %} from {% data variables.product.product_location_enterprise %}.'
redirect_from:
- /enterprise/admin/guides/developer-workflow/enabling-unified-search-between-github-enterprise-and-github-com/
- /enterprise/admin/guides/developer-workflow/enabling-unified-search-between-github-enterprise-server-and-github-com/
- /enterprise/admin/developer-workflow/enabling-unified-search-between-github-enterprise-server-and-githubcom/
- /enterprise/admin/installation/enabling-unified-search-between-github-enterprise-server-and-githubcom
- /enterprise/admin/configuration/enabling-unified-search-between-github-enterprise-server-and-githubcom
- /admin/configuration/enabling-unified-search-between-github-enterprise-server-and-githubcom
permissions: 'Site administrators for {% data variables.product.prodname_ghe_server %} who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable unified search between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_dotcom_the_website %}.'
versions:
ghes: '*'
topics:
- Enterprise
- GitHub Connect
- GitHub search
shortTitle: Enable unified search
---
When you enable unified search, users can view search results from public and private content on {% data variables.product.prodname_dotcom_the_website %} when searching from {% data variables.product.product_location_enterprise %}.
Users will not be able to search {% data variables.product.product_location_enterprise %} from {% data variables.product.prodname_dotcom_the_website %}, even if they have access to both environments. Users can only search private repositories you've enabled {% data variables.product.prodname_unified_search %} for and that they have access to in the connected {% data variables.product.prodname_ghe_cloud %} organizations. For more information, see "[About searching on {% data variables.product.prodname_dotcom %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github/#searching-across-github-enterprise-and-githubcom-simultaneously)" and "[Enabling private {% data variables.product.prodname_dotcom_the_website %} repository search in your {% data variables.product.prodname_ghe_server %} account](/articles/enabling-private-github-com-repository-search-in-your-github-enterprise-server-account)."
Searching via the REST and GraphQL APIs does not include {% data variables.product.prodname_dotcom_the_website %} search results. Advanced search and searching for wikis in {% data variables.product.prodname_dotcom_the_website %} are not supported.
{% data reusables.github-connect.access-dotcom-and-enterprise %}
{% data reusables.enterprise_site_admin_settings.access-settings %}
{% data reusables.enterprise_site_admin_settings.business %}
{% ifversion ghes < 3.1 %}{% data reusables.enterprise-accounts.settings-tab %}{% endif %}
{% data reusables.enterprise-accounts.github-connect-tab %}
5. Under "Users can search {% data variables.product.prodname_dotcom_the_website %}", use the drop-down menu and click **Enabled**.
![Enable search option in the search GitHub.com drop-down menu](/assets/images/enterprise/site-admin-settings/github-dotcom-enable-search.png)
6. Optionally, under "Users can search private repositories on {% data variables.product.prodname_dotcom_the_website %}", use the drop-down menu and click **Enabled**.
![Enable private repositories search option in the search GitHub.com drop-down menu](/assets/images/enterprise/site-admin-settings/enable-private-search.png)
## Further reading
- "[Connecting {% data variables.product.prodname_ghe_server %} to {% data variables.product.prodname_dotcom_the_website %}](/enterprise/admin/guides/developer-workflow/connecting-github-enterprise-server-to-github-com)"

2
content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md
View File

@@ -108,7 +108,7 @@ You can filter the alerts shown in the {% data variables.product.prodname_code_s
The benefit of using keyword filters is that only values with results are shown in the drop-down lists. This makes it easy to avoid setting filters that find no results.
If you enter multiple filters, the view will show alerts matching _all_ these filters. For example, `is:closed severity:high branch:main` will only display closed high-severity alerts that are present on the `main` branch.
If you enter multiple filters, the view will show alerts matching _all_ these filters. For example, `is:closed severity:high branch:main` will only display closed high-severity alerts that are present on the `main` branch. The exception is filters relating to refs (`ref`, `branch` and `pr`): `is:open branch:main branch:next` will show you open alerts from both the `main` branch and the `next` branch.
### Restricting results to application code only

2
content/codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces.md
View File

@@ -31,6 +31,6 @@ Once you enable GPG verification, it will immediately take effect for all your c
{% note %}
**Note:** Once you have enabled GPG verification for {% data variables.product.prodname_codespaces %}, you also must append `-s` to each commit in order for it to be signed. To do this in {% data variables.product.prodname_vscode %}, ensure the "Git: Enable Commit Signing" option is enabled from the Settings.
**Note:** Once you have enabled GPG verification for {% data variables.product.prodname_codespaces %}, you also must append `-S` to each commit in order for it to be signed. To do this in {% data variables.product.prodname_vscode %}, ensure the "Git: Enable Commit Signing" option is enabled from the Settings.
{% endnote %}

3
content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md
View File

@@ -41,6 +41,7 @@ Using the web application flow, the process to identify users on your site is:
If you select **Request user authorization (OAuth) during installation** when creating or modifying your app, step 1 will be completed during app installation. For more information, see "[Authorizing users during installation](/apps/installing-github-apps/#authorizing-users-during-installation)."
### 1. Request a user's GitHub identity
Direct the user to the following URL in their browser:
GET {% data variables.product.oauth_host_code %}/login/oauth/authorize
@@ -76,6 +77,8 @@ Exchange this `code` for an access token. When expiring tokens are enabled, the
Expiring user tokens are currently an optional feature and subject to change. To opt-in to the user-to-server token expiration feature, see "[Activating optional features for apps](/developers/apps/activating-optional-features-for-apps)."
Make a request to the following endpoint to receive an access token:
POST {% data variables.product.oauth_host_code %}/login/oauth/access_token
#### Parameters

1
content/developers/overview/index.md
View File

@@ -8,7 +8,6 @@ versions:
children:
- /about-githubs-apis
- /managing-deploy-keys
- /viewing-deployment-history
- /using-ssh-agent-forwarding
- /secret-scanning-partner-program
- /replacing-github-services

6
content/github/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks.md
View File

@@ -40,6 +40,12 @@ When _checks_ are set up in a repository, pull requests have a **Checks** tab wh
![Status checks within a pull request](/assets/images/help/pull_requests/checks.png)
{% note %}
**Note:** The **Checks** tab only gets populated for pull requests if you set up _checks_, not _statuses_, for the repository.
{% endnote %}
When a specific line in a commit causes a check to fail, you will see details about the failure, warning, or notice next to the relevant code in the **Files** tab of the pull request.
![Details of a status check](/assets/images/help/pull_requests/checks-detailed.png)

2
content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md
View File

@@ -183,7 +183,7 @@ In this example, you could add a nested list item under the list item `100. Firs
![List with a nested list item](/assets/images/help/writing/nested-list-example-3.png)
You can create multiple levels of nested lists using the same method. For example, because the first nested list item has seven spaces (`␣␣␣␣␣-␣`) before the nested list content `First nested list item`, you would need to indent the second nested list item by seven spaces.
You can create multiple levels of nested lists using the same method. For example, because the first nested list item has seven characters (`␣␣␣␣␣-␣`) before the nested list content `First nested list item`, you would need to indent the second nested list item by seven spaces.
```markdown
100. First list item

7
content/graphql/guides/managing-enterprise-accounts.md
View File

@@ -58,10 +58,11 @@ For some example queries, see "[An example query using the Enterprise Accounts A
- `admin:enterprise`
The enterprise account specific scopes are:
- `admin:enterprise`: Gives full control of enterprises (includes `manage_billing:enterprise` and `read:enterprise`)
- `manage_billing:enterprise`: Read and write enterprise billing data.
- `admin:enterprise`: Gives full control of enterprises (includes {% ifversion ghes < 3.3 %}`manage_runners:enteprise`, {% endif %}`manage_billing:enterprise` and `read:enterprise`)
- `manage_billing:enterprise`: Read and write enterprise billing data.{% ifversion ghes < 3.3 %}
- `manage_runners:enteprise`: Access to manage GitHub Actions enterprise runners and runner-groups.{% endif %}
- `read:enterprise`: Read enterprise profile data.
4. Copy your personal access token and keep it in a secure place until you add it to your GraphQL client.
### 2. Choose a GraphQL client

3
content/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization.md
View File

@@ -67,7 +67,8 @@ Some of the features listed below are limited to organizations using {% data var
| Submit reviews on pull requests | **X** | **X** | **X** | **X** | **X** |
| View published releases | **X** | **X** | **X** | **X** | **X** |{% ifversion fpt %}
| View [GitHub Actions workflow runs](/actions/automating-your-workflow-with-github-actions/managing-a-workflow-run) | **X** | **X** | **X** | **X** | **X** |{% endif %}
| Edit wikis | **X** | **X** | **X** | **X** | **X** |{% ifversion fpt %}
| Edit wikis in public repositories | **X** | **X** | **X** | **X** | **X** |
| Edit wikis in private repositories | | | **X** | **X** | **X** |{% ifversion fpt %}
| [Report abusive or spammy content](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam) | **X** | **X** | **X** | **X** | **X** |{% endif %}
| Apply/dismiss labels | | **X** | **X** | **X** | **X** |
| Create, edit, delete labels | | | **X** | **X** | **X** |

6
content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md
View File

@@ -22,6 +22,12 @@ All {% data variables.product.prodname_pages %} sites, including sites that are
{% data reusables.pages.private_pages_are_public_warning %}
{% note %}
**Note:** RFC3280 states that the maximum length of the common name should be 64 characters. Therefore, the entire domain name of your {% data variables.product.prodname_pages %} site must be less than 64 characters long for a certificate to be successfully created.
{% endnote %}
## Enforcing HTTPS for your {% data variables.product.prodname_pages %} site
{% data reusables.pages.navigate-site-repo %}

19
content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files.md
View File

@@ -45,18 +45,19 @@ Lisa, M., & Bot, H. (2017). My Research Software (Version 2.0.4) [Computer softw
{% raw %}
```
@misc{Lisa_My_Research_Software_2017,
@software{Lisa_My_Research_Software_2017,
author = {Lisa, Mona and Bot, Hew},
doi = {10.5281/zenodo.1234},
month = {12},
title = {{My Research Software}},
url = {https://github.com/github/linguist},
version = {2.0.4},
year = {2017}
}
```
{% endraw %}
Note the example above produces a _software_ citation (i.e., `@misc` type in BibTeX rather than `@article`).
Note the example above produces a _software_ citation (i.e., `@software` type in BibTeX rather than `@article`).
For more information, see the [Citation File Format](https://citation-file-format.github.io/) website.
@@ -66,9 +67,15 @@ When you add a `CITATION.cff` file to the default branch of your repository, it
## Citing something other than software
If you would prefer the GitHub citation information to link to another resource such as a research paper then you can use the `preferred-citation` override in CFF.
If you would prefer the {% data variables.product.prodname_dotcom %} citation information to link to another resource such as a research article, then you can use the `preferred-citation` override in CFF with the following types.
Extended CITATION.cff file describing the software, but linking to a research paper as the preferred citation:
Resource | Type
--------- | -----
Research article | `article`
Conference paper | `conference-paper`
Book | `book`
Extended CITATION.cff file describing the software, but linking to a research article as the preferred citation:
```
cff-version: 1.2.0
@@ -131,6 +138,10 @@ Lisa, M., & Bot, H. (2021). My awesome research software. Journal Title, 1(1), 1
```
{% endraw %}
## Citing a dataset
If your repository contains a dataset, you can set `type: dataset` in your `CITATION.cff` file to produce a data citation string output in the {% data variables.product.prodname_dotcom %} citation prompt.
## Other citation files
The GitHub citation feature will also detect a small number of additional files that are often used by communities and projects to describe how they would like their work to be cited.

22
content/repositories/releasing-projects-on-github/automatically-generated-release-notes.md
View File

@@ -74,17 +74,17 @@ changelog:
authors:
- octocat
categories:
- title: Breaking Changes 🛠
labels:
- Semver-Major
- breaking-change
- title: Exciting New Features 🎉
labels:
- Semver-Minor
- enhancement
- title: Other Changes
labels:
- "*"
- title: Breaking Changes 🛠
labels:
- Semver-Major
- breaking-change
- title: Exciting New Features 🎉
labels:
- Semver-Minor
- enhancement
- title: Other Changes
labels:
- "*"
```
{% endraw %}

4
content/rest/guides/getting-started-with-the-rest-api.md
View File

@@ -136,10 +136,10 @@ $ curl -i -u <em>your_username</em> {% data variables.product.api_url_pre %}/use
When prompted, you can enter your OAuth token, but we recommend you set up a variable for it:
You can use `-u "username:$token"` and set up a variable for `token` to avoid leaving your token in shell history, which should be avoided.
You can use `-u "your_username:$token"` and set up a variable for `token` to avoid leaving your token in shell history, which should be avoided.
```shell
$ curl -i -u <em>username:$token</em> {% data variables.product.api_url_pre %}/users/octocat
$ curl -i -u <em>your_username:$token</em> {% data variables.product.api_url_pre %}/users/octocat
```

4
content/rest/overview/api-previews.md
View File

@@ -193,6 +193,8 @@ You can now provide more information in GitHub for URLs that link to registered
**Custom media types:** `corsair-preview`
**Announced:** [2018-12-10](https://developer.github.com/changes/2018-12-10-content-attachments-api/)
{% ifversion ghes < 3.3 %}
## Enable and disable Pages
You can use the new endpoints in the [Pages API](/rest/reference/repos#pages) to enable or disable Pages. To learn more about Pages, see "[GitHub Pages Basics](/categories/github-pages-basics)".
@@ -200,6 +202,8 @@ You can use the new endpoints in the [Pages API](/rest/reference/repos#pages) to
**Custom media types:** `switcheroo-preview`
**Announced:** [2019-03-14](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/)
{% endif %}
{% ifversion ghes < 3.3 %}
## List branches or pull requests for a commit

2
content/rest/reference/repos.md
View File

@@ -178,7 +178,7 @@ You can communicate that a transient environment no longer exists by setting its
{% ifversion fpt or ghes > 3.1 or ghae-next %}
## Environments
The Environments API allows you to create, configure, and delete environments. For more information about environments, see "[Environments](/actions/reference/environments)." To manage environment secrets, see "[Secrets](/rest/reference/actions#secrets)."
The Environments API allows you to create, configure, and delete environments. 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)."
{% for operation in currentRestOperations %}
{% if operation.subcategory == 'environments' %}{% include rest_operation %}{% endif %}

4
content/search-github/searching-on-github/searching-code.md
View File

@@ -63,8 +63,8 @@ You can use the `path` qualifier to search for source code that appears at a spe
| Qualifier | Example
| ------------- | -------------
| <code>path:/</code> | [**octocat filename:readme path:/**](https://github.com/search?utf8=%E2%9C%93&q=octocat+filename%3Areadme+path%3A%2F&type=Code) matches _readme_ files with the word "octocat" that are located at the root level of a repository.
| <code>path:<em>DIRECTORY</em></code> | [**form path:cgi-bin language:perl**](https://github.com/search?q=form+path%3Acgi-bin+language%3Aperl&type=Code) matches Perl files with the word "form" in a <em>cgi-bin</em> directory, or in any of its subdirectories.
| <code>path:<em>PATH/TO/DIRECTORY</em></code> | [**console path:app/public language:javascript**](https://github.com/search?q=console+path%3A%22app%2Fpublic%22+language%3Ajavascript&type=Code) matches JavaScript files with the word "console" in an <em>app/public</em> directory, or in any of its subdirectories (even if they reside in <em>app/public/js/form-validators</em>).
| <code>path:<em>DIRECTORY</em></code> | [**form path:cgi-bin language:perl**](https://github.com/search?q=form+path%3Acgi-bin+language%3Aperl&type=Code) matches Perl files with the word "form" in the <em>cgi-bin</em> directory, or in any of its subdirectories.
| <code>path:<em>PATH/TO/DIRECTORY</em></code> | [**console path:app/public language:javascript**](https://github.com/search?q=console+path%3A%22app%2Fpublic%22+language%3Ajavascript&type=Code) matches JavaScript files with the word "console" in the <em>app/public</em> directory, or in any of its subdirectories (even if they reside in <em>app/public/js/form-validators</em>).
## Search by language
<!-- If you make changes to this feature, update /getting-started-with-github/github-language-support to reflect any changes. -->

12
content/sponsors/receiving-sponsorships-through-github-sponsors/tax-information-for-github-sponsors.md
View File

@@ -58,6 +58,18 @@ If you are a taxpayer in the United States and earn more than 600 US dollars in
{% data reusables.sponsors.sponsorships-not-tax-deductible %}
## Sales tax
GitHub is providing information to assist you in calculating your sales tax obligations. This information is not personalized to your country or tax situation and we recommend you talk to a professional to understand your specific obligations. However, we'd like to provide some high-level information to help you understand the general principles of digital sales tax.
In most countries around the world, sales tax for digital transactions is based on the location of the recipient, not on the seller. For example, if you are a maintainer in the United States and you provide a taxable benefit to a Sponsor in Germany, German sales tax would apply.
Sales tax is generally only applicable when a good or service of value is being provided. Goodwill/general support/undying appreciation is not normally taxable.
In the US, both B2B (business-to-business) and B2C (business-to-consumer) are subject to sales tax.
In the EU and most other countries and regions, B2C sales are subject to sales tax. B2B sales are not subject to tax. C2C and C2B sales where a consumer is not registered for VAT are not taxable.
## Further reading
- [Viewing your sponsors and sponsorships](/sponsors/receiving-sponsorships-through-github-sponsors/viewing-your-sponsors-and-sponsorships)

4
contributing/content-style-guide.md
View File

@@ -125,9 +125,7 @@ Be descriptive when naming image files: include the name, action, and UI element
### Screenshots
When you take a screenshot, avoid overly wide images. If you're trying to bring attention to a button, don't take a shot of the entire page. Focus on the area around the button instead and crop near the focal point of the image. Leave enough of a margin around the focal point so that some other elements of the page are visible, helping the viewer find the area of the screenshot when looking at the user interface.
Do not include your username or avatar in any images. If a screenshot must include a username or avatar, use the Inspect function in your browser to add the [Octocat](https://github.com/octocat)'s username or avatar instead.
To learn about creating and versioning images, see "[Creating and updating screenshots](./images-and-versioning.md)."
## Inclusive language

1
data/reusables/actions/about-environments.md Normal file
View File

@@ -0,0 +1 @@
Environments are used to describe a general deployment target like `production`, `staging`, or `development`. When a {% data variables.product.prodname_actions %} workflow deploys to an environment, the environment is displayed on the main page of the repository. You can use environments to require approval for a job to proceed, restrict which branches can trigger a workflow, or limit access to secrets. For more information about creating environments, see "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)."

2
data/reusables/actions/ae-hosted-runners-beta.md
View File

@@ -1,4 +1,4 @@
ss{% ifversion ghae %}
{% ifversion ghae %}
{% note %}
**Note:** {% data variables.actions.hosted_runner %}s are currently in beta and subject to change.

3
data/reusables/actions/cd-templates-actions.md Normal file
View File

@@ -0,0 +1,3 @@
{% data variables.product.product_name %} offers CD workflow templates for several popular services, such as Azure Web App. To learn how to get started using a workflow template, see "[Using workflow templates](/actions/learn-github-actions/using-workflow-templates)" or [browse the full list of deployment workflow templates](https://github.com/actions/starter-workflows/tree/main/deployments). You can also check out our more detailed guides for specific deployment workflows, such as "[Deploying to Azure App Service](/actions/deployment/deploying-to-azure-app-service)."
Many service providers also offer actions on {% data variables.product.prodname_marketplace %} for deploying to their service. For the full list, see [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace?category=deployment&type=actions).

5
data/reusables/actions/concurrency-beta.md
View File

@@ -1,5 +0,0 @@
{% note %}
**Note:** Concurrency is currently in beta and subject to change.
{% endnote %}

1
data/reusables/actions/delete-env-key.md Normal file
View File

@@ -0,0 +1 @@
If you configured a deployment environment, change the value of `environment` to be the name of your environment. If you did not configure an environment{% ifversion fpt %} or if your workflow is in a private repository and you do not use {% data variables.product.prodname_ghe_cloud %}{% endif %}, delete the `environment` key.

1
data/reusables/actions/environment-deployment-event.md Normal file
View File

@@ -0,0 +1 @@
When a workflow job that references an environment runs, it creates a deployment object with the `environment` property set to the name of your environment. As the workflow progresses, it also creates deployment status objects with the `environment` property set to the name of your environment, the `environment_url` property set to the URL for environment (if specified in the workflow), and the `state` property set to the status of the job.

45
data/reusables/actions/environment-example.md Normal file
View File

@@ -0,0 +1,45 @@
You can specify an environment for each job in your workflow. To do so, add a `jobs.<job_id>.environment` key followed by the name of the environment.
For example, this workflow will use an environment called `production`.
```yaml
name: Deployment
on:
push:
branches:
- main
jobs:
deployment:
runs-on: ubuntu-latest
environment: production
steps:
- name: deploy
# ...deployment-specific steps
```
When the above workflow runs, the `deployment` job will be subject to any rules configured for the `production` environment. For example, if the environment requires reviewers, the job will pause until one of the reviewers approves the job.
You can also specify a URL for the environment. The specified URL will appear on the deployments page for the repository (accessed by clicking **Environments** on the home page of your repository) and in the visualization graph for the workflow run. If a pull request triggered the workflow, the URL is also displayed as a **View deployment** button in the pull request timeline.
```yaml
name: Deployment
on:
push:
branches:
- main
jobs:
deployment:
runs-on: ubuntu-latest
environment:
name: production
url: https://github.com
steps:
- name: deploy
# ...deployment-specific steps
```
![Workflow graph with URL](/assets/images/help/images/deploy-graph.png)

5
data/reusables/code-scanning/upload-sarif-alert-limit.md
View File

@@ -1,5 +1,8 @@
{% note %}
**Note:** SARIF upload supports a maximum of {% ifversion ghae-next or fpt or ghes > 3.0 %}5000{% else %}1000{% endif %} results per upload. Any results over this limit are ignored. If a tool generates too many results, you should update the configuration to focus on results for the most important rules or queries.
**Notes:**
- SARIF upload supports a maximum of {% ifversion ghae-next or fpt or ghes > 3.0 %}5000{% else %}1000{% endif %} results per upload. Any results over this limit are ignored. If a tool generates too many results, you should update the configuration to focus on results for the most important rules or queries.
- For each upload, SARIF upload supports a maximum size of 10 MB for the `gzip`-compressed SARIF file. Any uploads over this limit will be rejected. If your SARIF file is too large because it contains too many results, you should update the configuration to focus on results for the most important rules or queries.
{% endnote %}

1
data/reusables/github-actions/name-environment.md Normal file
View File

@@ -0,0 +1 @@
1. Enter a name for the environment, then click **Configure environment**. Environment names are not case sensitive. An environment name may not exceed 255 characters and must be unique within the repository.

1
data/reusables/github-actions/new-environment.md Normal file
View File

@@ -0,0 +1 @@
1. Click **New environment**.

2
data/reusables/repositories/workflow-notifications.md
View File

@@ -1,4 +1,4 @@
If you enable email or web notifications for {% data variables.product.prodname_actions %}, you'll receive a notification when any workflow runs that you've triggered have completed. The notification will include the workflow run's status (including successful, failed, neutral, and canceled runs). You can also choose to receive a notification only when a workflow run has failed.
If you enable email or web notifications for {% data variables.product.prodname_actions %}, you'll receive a notification when any workflow runs that you've triggered have completed. The notification will include the workflow run's status (including successful, failed, neutral, and canceled runs). You can also choose to receive a notification only when a workflow run has failed. For more information about enabling or disabling notifications, see "[About notifications](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)."
Notifications for scheduled workflows are sent to the user who initially created the workflow. If a different user updates the cron syntax in the workflow file, subsequent notifications will be sent to that user instead.{% ifversion fpt or ghes > 2.22 %} If a scheduled workflow is disabled and then re-enabled, notifications will be sent to the user who re-enabled the workflow rather than the user who last modified the cron syntax.{% endif %}

291
data/reusables/secret-scanning/partner-secret-list-private-repo.md
View File

@@ -1,256 +1,181 @@
Provider | Supported secret | API slug
--- | --- | ---
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
{%- ifversion fpt or ghes > 2.22 or ghae %}
Adafruit IO | Adafruit IO Key | adafruit_io_key{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
Adobe | Adobe Device Token | adobe_device_token{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
Adobe | Adobe Service Token | adobe_service_token{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
Adobe | Adobe Short-Lived Access Token | adobe_short_lived_access_token{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
Adobe | Adobe Device Token | adobe_device_token
Adobe | Adobe Service Token | adobe_service_token
Adobe | Adobe Short-Lived Access Token | adobe_short_lived_access_token
Adobe | Adobe JSON Web Token | adobe_jwt{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
Alibaba Cloud | Alibaba Cloud Access Key ID | alibaba_cloud_access_key_id{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
Alibaba Cloud | Alibaba Cloud Access Key Secret | alibaba_cloud_access_key_secret{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
Amazon Web Services (AWS) | Amazon AWS Access Key ID | aws_access_key_id{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
{%- ifversion fpt or ghes > 2.22 or ghae %}
Alibaba Cloud | Alibaba Cloud Access Key ID | alibaba_cloud_access_key_id
Alibaba Cloud | Alibaba Cloud Access Key Secret | alibaba_cloud_access_key_secret
Amazon Web Services (AWS) | Amazon AWS Access Key ID | aws_access_key_id
Amazon Web Services (AWS) | Amazon AWS Secret Access Key | aws_secret_access_key{% endif %}
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
Amazon Web Services (AWS) | Amazon AWS Session Token | aws_session_token{% endif %}
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
{%- ifversion fpt or ghes > 3.2 %}
Amazon Web Services (AWS) | Amazon AWS Session Token | aws_session_token
Amazon Web Services (AWS) | Amazon AWS Temporary Access Key ID | aws_temporary_access_key_id{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
Asana | Asana Personal Access Token | asana_personal_access_token{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
Atlassian | Atlassian API Token | atlassian_api_token{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
{%- ifversion fpt or ghes > 2.22 or ghae %}
Atlassian | Atlassian API Token | atlassian_api_token
Atlassian | Atlassian JSON Web Token | atlassian_jwt{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
Atlassian | Bitbucket Server Personal Access Token | bitbucket_server_personal_access_token{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
Azure | Azure DevOps Personal Access Token | azure_devops_personal_access_token{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
Azure | Azure SAS Token | azure_sas_token{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
Azure | Azure Service Management Certificate | azure_management_certificate{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
Azure | Azure SQL Connection String | azure_sql_connection_string{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
{%- ifversion fpt or ghes > 2.22 or ghae %}
Azure | Azure DevOps Personal Access Token | azure_devops_personal_access_token
Azure | Azure SAS Token | azure_sas_token
Azure | Azure Service Management Certificate | azure_management_certificate
Azure | Azure SQL Connection String | azure_sql_connection_string
Azure | Azure Storage Account Key | azure_storage_account_key{% endif %}
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
{%- ifversion fpt or ghes > 3.2 %}
Beamer | Beamer API Key | beamer_api_key{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
Checkout.com | Checkout.com Production Secret Key | checkout_production_secret_key{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
Checkout.com | Checkout.com Production Secret Key | checkout_production_secret_key
Checkout.com | Checkout.com Test Secret Key | checkout_test_secret_key{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
{%- ifversion fpt or ghes > 2.22 or ghae %}
Clojars | Clojars Deploy Token | clojars_deploy_token{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
CloudBees CodeShip | CloudBees CodeShip Credential | codeship_credential{% endif %}
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
{%- ifversion fpt or ghes > 3.2 %}
Contentful | Contentful Personal Access Token | contentful_personal_access_token{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
Databricks | Databricks Access Token | databricks_access_token{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
{%- ifversion fpt or ghes > 2.22 or ghae %}
Databricks | Databricks Access Token | databricks_access_token
Discord | Discord Bot Token | discord_bot_token{% endif %}
{%- ifversion fpt or ghes > 3.0 or ghae-next %}
Doppler | Doppler Personal Token | doppler_personal_token{% endif %}
{%- ifversion fpt or ghes > 3.0 or ghae-next %}
Doppler | Doppler Service Token | doppler_service_token{% endif %}
{%- ifversion fpt or ghes > 3.0 or ghae-next %}
Doppler | Doppler CLI Token | doppler_cli_token{% endif %}
{%- ifversion fpt or ghes > 3.0 or ghae-next %}
{%- ifversion fpt or ghes > 3.0 or ghae %}
Doppler | Doppler Personal Token | doppler_personal_token
Doppler | Doppler Service Token | doppler_service_token
Doppler | Doppler CLI Token | doppler_cli_token
Doppler | Doppler SCIM Token | doppler_scim_token{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
Doppler | Doppler Audit Token | doppler_audit_token{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
Dropbox | Dropbox Access Token | dropbox_access_token{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
{%- ifversion fpt or ghes > 2.22 or ghae %}
Dropbox | Dropbox Access Token | dropbox_access_token
Dropbox | Dropbox Short Lived Access Token | dropbox_short_lived_access_token{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
Duffel | Duffel Live Access Token | duffel_live_access_token{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
Duffel | Duffel Live Access Token | duffel_live_access_token
Duffel | Duffel Test Access Token | duffel_test_access_token{% endif %}
{%- ifversion fpt or ghes > 3.0 or ghae-next %}
{%- ifversion fpt or ghes > 3.0 or ghae %}
Dynatrace | Dynatrace Access Token | dynatrace_access_token{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
{%- ifversion fpt or ghes > 2.22 or ghae %}
Dynatrace | Dynatrace Internal Token | dynatrace_internal_token{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
EasyPost | EasyPost Production API Key | easypost_production_api_key{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
EasyPost | EasyPost Test API Key | easypost_test_api_key{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
Facebook | Facebook Access Token | facebook_access_token{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
EasyPost | EasyPost Production API Key | easypost_production_api_key
EasyPost | EasyPost Test API Key | easypost_test_api_key
Facebook | Facebook Access Token | facebook_access_token
Fastly | Fastly API Token | fastly_api_token{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
{%- ifversion fpt or ghes > 2.22 or ghae %}
Finicity | Finicity App Key | finicity_app_key{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
Flutterwave | Flutterwave Live API Secret Key | flutterwave_live_api_secret_key{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
Flutterwave | Flutterwave Live API Secret Key | flutterwave_live_api_secret_key
Flutterwave | Flutterwave Test API Secret Key | flutterwave_test_api_secret_key{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
Frame.io | Frame.io JSON Web Token | frameio_jwt{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
{%- ifversion fpt or ghes > 2.22 or ghae %}
Frame.io | Frame.io JSON Web Token | frameio_jwt
Frame.io| Frame.io Developer Token | frameio_developer_token{% endif %}
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
{%- ifversion fpt or ghes > 3.2 %}
FullStory | FullStory API Key | fullstory_api_key{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
GitHub | GitHub Personal Access Token | github_personal_access_token{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
GitHub | GitHub OAuth Access Token | github_oauth_access_token{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
GitHub | GitHub Refresh Token | github_refresh_token{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
GitHub | GitHub Personal Access Token | github_personal_access_token
GitHub | GitHub OAuth Access Token | github_oauth_access_token
GitHub | GitHub Refresh Token | github_refresh_token
GitHub | GitHub App Installation Access Token | github_app_installation_access_token{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
GitHub | GitHub SSH Private Key | github_ssh_private_key{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
GoCardless | GoCardless Live Access Token | gocardless_live_access_token{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
{%- ifversion fpt or ghes > 2.22 or ghae %}
GitHub | GitHub SSH Private Key | github_ssh_private_key
GoCardless | GoCardless Live Access Token | gocardless_live_access_token
GoCardless | GoCardless Sandbox Access Token | gocardless_sandbox_access_token{% endif %}
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
{%- ifversion fpt or ghes > 3.2 %}
Google | Firebase Cloud Messaging Server Key | firebase_cloud_messaging_server_key{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
Google | Google API Key | google_api_key{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
{%- ifversion fpt or ghes > 2.22 or ghae %}
Google | Google API Key | google_api_key
Google | Google Cloud Private Key ID | google_cloud_private_key_id{% endif %}
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
Google | Google Cloud Storage Access Key Secret | google_cloud_storage_access_key_secret{% endif %}
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
Google | Google Cloud Storage Service Account Access Key ID | google_cloud_storage_service_account_access_key_id{% endif %}
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
{%- ifversion fpt or ghes > 3.2 %}
Google | Google Cloud Storage Access Key Secret | google_cloud_storage_access_key_secret
Google | Google Cloud Storage Service Account Access Key ID | google_cloud_storage_service_account_access_key_id
Google | Google Cloud Storage User Access Key ID | google_cloud_storage_user_access_key_id{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
Grafana | Grafana API Key | grafana_api_key{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
Hashicorp Terraform | Terraform Cloud / Enterprise API Token | terraform_api_token{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
{%- ifversion fpt or ghes > 2.22 or ghae %}
Hashicorp Terraform | Terraform Cloud / Enterprise API Token | terraform_api_token
Hubspot | Hubspot API Key | hubspot_api_key{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
Intercom | Intercom Access Token | intercom_access_token{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
Ionic | Ionic Personal Access Token | ionic_personal_access_token{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
Intercom | Intercom Access Token | intercom_access_token
Ionic | Ionic Personal Access Token | ionic_personal_access_token
Ionic | Ionic Refresh Token | ionic_refresh_token{% endif %}
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
JFrog | JFrog Platform Access Token | jfrog_platform_access_token{% endif %}
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
{%- ifversion fpt or ghes > 3.2 %}
JFrog | JFrog Platform Access Token | jfrog_platform_access_token
JFrog | JFrog Platform API Key | jfrog_platform_api_key{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
Linear | Linear API Key | linear_api_key{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
Linear | Linear OAuth Access Token | linear_oauth_access_token{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
Lob | Lob Live API Key | lob_live_api_key{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
Linear | Linear API Key | linear_api_key
Linear | Linear OAuth Access Token | linear_oauth_access_token
Lob | Lob Live API Key | lob_live_api_key
Lob | Lob Test API Key | lob_test_api_key{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
Mailchimp | Mailchimp API Key | mailchimp_api_key{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
{%- ifversion fpt or ghes > 2.22 or ghae %}
Mailchimp | Mailchimp API Key | mailchimp_api_key
Mailgun | Mailgun API Key | mailgun_api_key{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
MessageBird | MessageBird API Key | messagebird_api_key{% endif %}
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
New Relic | New Relic Personal API Key | new_relic_personal_api_key{% endif %}
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
New Relic | New Relic REST API Key | new_relic_rest_api_key{% endif %}
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
New Relic | New Relic Insights Query Key | new_relic_insights_query_key{% endif %}
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
{%- ifversion fpt or ghes > 3.2 %}
New Relic | New Relic Personal API Key | new_relic_personal_api_key
New Relic | New Relic REST API Key | new_relic_rest_api_key
New Relic | New Relic Insights Query Key | new_relic_insights_query_key
New Relic | New Relic License Key | new_relic_license_key{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
npm | npm Access Token | npm_access_token{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
{%- ifversion fpt or ghes > 2.22 or ghae %}
npm | npm Access Token | npm_access_token
NuGet | NuGet API Key | nuget_api_key{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
Onfido | Onfido Live API Token | onfido_live_api_token{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
Onfido | Onfido Sandbox API Token | onfido_sandbox_api_token{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
Onfido | Onfido Live API Token | onfido_live_api_token
Onfido | Onfido Sandbox API Token | onfido_sandbox_api_token
OpenAI | OpenAI API Key | openai_api_key{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
{%- ifversion fpt or ghes > 2.22 or ghae %}
Palantir | Palantir JSON Web Token | palantir_jwt{% endif %}
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
PlanetScale | PlanetScale Database Password | planetscale_database_password{% endif %}
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
PlanetScale | PlanetScale OAuth Token | planetscale_oauth_token{% endif %}
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
PlanetScale | PlanetScale Service Token | planetscale_service_token{% endif %}
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
Plivo | Plivo Auth ID | plivo_auth_id{% endif %}
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
{%- ifversion fpt or ghes > 3.2 %}
PlanetScale | PlanetScale Database Password | planetscale_database_password
PlanetScale | PlanetScale OAuth Token | planetscale_oauth_token
PlanetScale | PlanetScale Service Token | planetscale_service_token
Plivo | Plivo Auth ID | plivo_auth_id
Plivo | Plivo Auth Token | plivo_auth_token{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
Postman | Postman API Key | postman_api_key{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
Proctorio | Proctorio Consumer Key | proctorio_consumer_key{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
Proctorio | Proctorio Linkage Key | proctorio_linkage_key{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
Proctorio | Proctorio Registration Key | proctorio_registration_key{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
Proctorio | Proctorio Secret Key | proctorio_secret_key{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
{%- ifversion fpt or ghes > 2.22 or ghae %}
Postman | Postman API Key | postman_api_key
Proctorio | Proctorio Consumer Key | proctorio_consumer_key
Proctorio | Proctorio Linkage Key | proctorio_linkage_key
Proctorio | Proctorio Registration Key | proctorio_registration_key
Proctorio | Proctorio Secret Key | proctorio_secret_key
Pulumi | Pulumi Access Token | pulumi_access_token{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
PyPI | PyPI API Token | pypi_api_token{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
PyPI | PyPI API Token | pypi_api_token
RubyGems | RubyGems API Key | rubygems_api_key{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
Samsara | Samsara API Token | samsara_api_token{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
{%- ifversion fpt or ghes > 2.22 or ghae %}
Samsara | Samsara API Token | samsara_api_token
Samsara | Samsara OAuth Access Token | samsara_oauth_access_token{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
SendGrid | SendGrid API Key | sendgrid_api_key{% endif %}
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
Sendinblue | Sendinblue API Key | sendinblue_api_key{% endif %}
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
{%- ifversion fpt or ghes > 3.2 %}
Sendinblue | Sendinblue API Key | sendinblue_api_key
Sendinblue | Sendinblue SMTP Key | sendinblue_smtp_key{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
Shippo | Shippo Live API Token | shippo_live_api_token{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
Shippo | Shippo Live API Token | shippo_live_api_token
Shippo | Shippo Test API Token | shippo_test_api_token{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
Shopify | Shopify App Shared Secret | shopify_app_shared_secret{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
Shopify | Shopify Access Token | shopify_access_token{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
Shopify | Shopify Custom App Access Token | shopify_custom_app_access_token{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
Shopify | Shopify Private App Password | shopify_private_app_password{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
Slack | Slack API Token | slack_api_token{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
Slack | Slack Incoming Webhook URL | slack_incoming_webhook_url{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
Slack | Slack Workflow Webhook URL | slack_workflow_webhook_url{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
SSLMate | SSLMate API Key | sslmate_api_key{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
SSLMate | SSLMate Cluster Secret | sslmate_cluster_secret{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
{%- ifversion fpt or ghes > 2.22 or ghae %}
Shopify | Shopify App Shared Secret | shopify_app_shared_secret
Shopify | Shopify Access Token | shopify_access_token
Shopify | Shopify Custom App Access Token | shopify_custom_app_access_token
Shopify | Shopify Private App Password | shopify_private_app_password
Slack | Slack API Token | slack_api_token
Slack | Slack Incoming Webhook URL | slack_incoming_webhook_url
Slack | Slack Workflow Webhook URL | slack_workflow_webhook_url
SSLMate | SSLMate API Key | sslmate_api_key
SSLMate | SSLMate Cluster Secret | sslmate_cluster_secret
Stripe | Stripe API Key | stripe_api_key{% endif %}
{%- ifversion fpt or ghes > 3.0 or ghae-next %}
Stripe | Stripe Live API Secret Key | stripe_live_secret_key{% endif %}
{%- ifversion fpt or ghes > 3.0 or ghae-next %}
Stripe | Stripe Test API Secret Key | stripe_test_secret_key{% endif %}
{%- ifversion fpt or ghes > 3.0 or ghae-next %}
Stripe | Stripe Live API Restricted Key | stripe_live_restricted_key{% endif %}
{%- ifversion fpt or ghes > 3.0 or ghae-next %}
{%- ifversion fpt or ghes > 3.0 or ghae %}
Stripe | Stripe Live API Secret Key | stripe_live_secret_key
Stripe | Stripe Test API Secret Key | stripe_test_secret_key
Stripe | Stripe Live API Restricted Key | stripe_live_restricted_key
Stripe | Stripe Test API Restricted Key | stripe_test_restricted_key{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
Stripe | Stripe Webhook Signing Secret | stripe_webhook_signing_secret{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
Tableau | Tableau Personal Access Token | tableau_personal_access_token{% endif %}
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
Stripe | Stripe Webhook Signing Secret | stripe_webhook_signing_secret
Tableau | Tableau Personal Access Token | tableau_personal_access_token
Telegram | Telegram Bot Token | telegram_bot_token{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
Tencent Cloud | Tencent Cloud Secret ID | tencent_cloud_secret_id{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
Twilio | Twilio Account String Identifier | twilio_account_sid{% endif %}
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
{%- ifversion fpt or ghes > 2.22 or ghae %}
Tencent Cloud | Tencent Cloud Secret ID | tencent_cloud_secret_id
Twilio | Twilio Account String Identifier | twilio_account_sid
Twilio | Twilio API Key | twilio_api_key{% endif %}

232
lib/rest/static/decorated/api.github.com.json
View File

@@ -24713,12 +24713,22 @@
{
"name": "secret_type",
"in": "query",
"description": "A comma separated list of secret types to return. By default all secret types are returned.",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.",
"required": false,
"schema": {
"type": "string"
},
"descriptionHTML": "<p>A comma separated list of secret types to return. By default all secret types are returned.</p>"
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.</p>"
},
{
"name": "resolution",
"in": "query",
"description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.",
"required": false,
"schema": {
"type": "string"
},
"descriptionHTML": "<p>A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are <code>false_positive</code>, <code>wont_fix</code>, <code>revoked</code>, <code>pattern_edited</code>, <code>pattern_deleted</code> or <code>used_in_tests</code>.</p>"
},
{
"name": "page",
@@ -46759,6 +46769,100 @@
}
]
},
{
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest",
"serverUrl": "https://api.github.com",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "check_run_id",
"description": "check_run_id parameter",
"in": "path",
"required": true,
"schema": {
"type": "integer"
},
"descriptionHTML": "<p>check_run_id parameter</p>"
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42/rerequest",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42/rerequest</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest', {\n owner: 'octocat',\n repo: 'hello-world',\n check_run_id: 42\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">check_run_id</span>: <span class=\"hljs-number\">42</span>\n})\n</code></pre>"
}
],
"summary": "Rerequest a check run",
"description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.",
"tags": [
"checks"
],
"operationId": "checks/rerequest-run",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/checks#rerequest-a-check-run"
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"previews": [],
"category": "checks",
"subcategory": "runs"
},
"slug": "rerequest-a-check-run",
"category": "checks",
"categoryLabel": "Checks",
"subcategory": "runs",
"subcategoryLabel": "Runs",
"notes": [],
"responses": [
{
"httpStatusCode": "201",
"httpStatusMessage": "Created",
"description": "Response"
},
{
"httpStatusCode": "403",
"httpStatusMessage": "Forbidden",
"description": "Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App"
},
{
"httpStatusCode": "404",
"httpStatusMessage": "Not Found",
"description": "Resource not found"
},
{
"httpStatusCode": "422",
"httpStatusMessage": "Unprocessable Entity",
"description": "Validation error if the check run is not rerequestable"
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the <a href=\"https://docs.github.com/webhooks/event-payloads/#check_run\"><code>check_run</code> webhook</a> event with the action <code>rerequested</code>. When a check run is <code>rerequested</code>, its <code>status</code> is reset to <code>queued</code> and the <code>conclusion</code> is cleared.</p>\n<p>To rerequest a check run, your GitHub App must have the <code>checks:read</code> permission on a private repository or pull access to a public repository.</p>"
},
{
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/check-suites",
@@ -67328,13 +67432,13 @@
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'</code></pre>"
"source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('POST /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n source: {\n branch: 'branch',\n path: 'path'\n },\n mediaType: {\n previews: [\n 'switcheroo'\n ]\n }\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'POST /repos/{owner}/{repo}/pages'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">source</span>: {\n <span class=\"hljs-attr\">branch</span>: <span class=\"hljs-string\">'branch'</span>,\n <span class=\"hljs-attr\">path</span>: <span class=\"hljs-string\">'path'</span>\n },\n <span class=\"hljs-attr\">mediaType</span>: {\n <span class=\"hljs-attr\">previews</span>: [\n <span class=\"hljs-string\">'switcheroo'</span>\n ]\n }\n})\n</code></pre>"
"source": "await octokit.request('POST /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n source: {\n branch: 'branch',\n path: 'path'\n }\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'POST /repos/{owner}/{repo}/pages'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">source</span>: {\n <span class=\"hljs-attr\">branch</span>: <span class=\"hljs-string\">'branch'</span>,\n <span class=\"hljs-attr\">path</span>: <span class=\"hljs-string\">'path'</span>\n }\n})\n</code></pre>"
}
],
"summary": "Create a GitHub Pages site",
@@ -67441,14 +67545,6 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"previews": [
{
"required": true,
"name": "switcheroo",
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
"html": "<p>Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/\">blog post</a> preview for more details. To access the new endpoints during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.switcheroo-preview+json</code></pre>"
}
],
"category": "repos",
"subcategory": "pages"
},
@@ -67472,11 +67568,6 @@
"httpStatusMessage": "Conflict",
"description": "Conflict"
},
{
"httpStatusCode": "415",
"httpStatusMessage": "Unsupported Media Type",
"description": "Preview header missing"
},
{
"httpStatusCode": "422",
"httpStatusMessage": "Unprocessable Entity",
@@ -67839,13 +67930,13 @@
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages</code></pre>"
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('DELETE /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'switcheroo'\n ]\n }\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'DELETE /repos/{owner}/{repo}/pages'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">mediaType</span>: {\n <span class=\"hljs-attr\">previews</span>: [\n <span class=\"hljs-string\">'switcheroo'</span>\n ]\n }\n})\n</code></pre>"
"source": "await octokit.request('DELETE /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'DELETE /repos/{owner}/{repo}/pages'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>\n})\n</code></pre>"
}
],
"summary": "Delete a GitHub Pages site",
@@ -67861,14 +67952,6 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"previews": [
{
"required": true,
"name": "switcheroo",
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
"html": "<p>Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/\">blog post</a> preview for more details. To access the new endpoints during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.switcheroo-preview+json</code></pre>"
}
],
"category": "repos",
"subcategory": "pages"
},
@@ -67889,11 +67972,6 @@
"httpStatusMessage": "Not Found",
"description": "Resource not found"
},
{
"httpStatusCode": "415",
"httpStatusMessage": "Unsupported Media Type",
"description": "Preview header missing"
},
{
"httpStatusCode": "422",
"httpStatusMessage": "Unprocessable Entity",
@@ -73435,6 +73513,16 @@
"rawType": "string",
"rawDescription": "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see \"[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\"",
"childParamsGroups": []
},
"generate_release_notes": {
"type": "boolean",
"description": "<p>Whether to automatically generate the name and body for this release. If <code>name</code> is specified, the specified name will be used; otherwise, a name will be automatically generated. If <code>body</code> is specified, the body will be pre-pended to the automatically generated notes.</p>",
"default": false,
"name": "generate_release_notes",
"in": "body",
"rawType": "boolean",
"rawDescription": "Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes.",
"childParamsGroups": []
}
},
"required": [
@@ -73447,7 +73535,8 @@
"name": "v1.0.0",
"body": "Description of the release",
"draft": false,
"prerelease": false
"prerelease": false,
"generate_release_notes": false
}
}
}
@@ -73533,6 +73622,16 @@
"rawType": "string",
"rawDescription": "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see \"[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\"",
"childParamsGroups": []
},
{
"type": "boolean",
"description": "<p>Whether to automatically generate the name and body for this release. If <code>name</code> is specified, the specified name will be used; otherwise, a name will be automatically generated. If <code>body</code> is specified, the body will be pre-pended to the automatically generated notes.</p>",
"default": false,
"name": "generate_release_notes",
"in": "body",
"rawType": "boolean",
"rawDescription": "Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes.",
"childParamsGroups": []
}
],
"responses": [
@@ -75002,12 +75101,22 @@
{
"name": "secret_type",
"in": "query",
"description": "A comma separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
"description": "A comma-separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
"required": false,
"schema": {
"type": "string"
},
"descriptionHTML": "<p>A comma separated list of secret types to return. By default all secret types are returned. See \"<a href=\"https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories\">About secret scanning for private repositories</a>\" for a complete list of secret types (API slug).</p>"
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned. See \"<a href=\"https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories\">About secret scanning for private repositories</a>\" for a complete list of secret types (API slug).</p>"
},
{
"name": "resolution",
"in": "query",
"description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.",
"required": false,
"schema": {
"type": "string"
},
"descriptionHTML": "<p>A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are <code>false_positive</code>, <code>wont_fix</code>, <code>revoked</code>, <code>pattern_edited</code>, <code>pattern_deleted</code> or <code>used_in_tests</code>.</p>"
},
{
"name": "page",
@@ -75163,6 +75272,11 @@
"description": "Response",
"payload": "<pre><code class=\"hljs language-json\"><span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"number\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">42</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"created_at\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"2020-11-06T18:18:30Z\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"html_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://github.com/owner/private-repo/security/secret-scanning/42\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"state\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"open\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"resolution\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-keyword\">null</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"resolved_at\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-keyword\">null</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"resolved_by\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-keyword\">null</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"secret_type\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"mailchimp_api_key\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"secret\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2\"</span>\n<span class=\"hljs-punctuation\">}</span>\n</code></pre>"
},
{
"httpStatusCode": "304",
"httpStatusMessage": "Not Modified",
"description": "Not modified"
},
{
"httpStatusCode": "404",
"httpStatusMessage": "Not Found",
@@ -87758,7 +87872,7 @@
"tags": [
"users"
],
"operationId": "users/list-blocked-by-authenticated",
"operationId": "users/list-blocked-by-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#list-users-blocked-by-the-authenticated-user"
@@ -88079,7 +88193,7 @@
"tags": [
"users"
],
"operationId": "users/set-primary-email-visibility-for-authenticated",
"operationId": "users/set-primary-email-visibility-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user"
@@ -88219,7 +88333,7 @@
"tags": [
"users"
],
"operationId": "users/list-emails-for-authenticated",
"operationId": "users/list-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#list-email-addresses-for-the-authenticated-user"
@@ -88290,7 +88404,7 @@
"tags": [
"users"
],
"operationId": "users/add-email-for-authenticated",
"operationId": "users/add-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#add-an-email-address-for-the-authenticated-user"
@@ -88433,7 +88547,7 @@
"tags": [
"users"
],
"operationId": "users/delete-email-for-authenticated",
"operationId": "users/delete-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
@@ -88682,7 +88796,7 @@
"tags": [
"users"
],
"operationId": "users/list-followed-by-authenticated",
"operationId": "users/list-followed-by-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#list-the-people-the-authenticated-user-follows"
@@ -89009,7 +89123,7 @@
"tags": [
"users"
],
"operationId": "users/list-gpg-keys-for-authenticated",
"operationId": "users/list-gpg-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
@@ -89077,7 +89191,7 @@
],
"summary": "Create a GPG key for the authenticated user",
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
"operationId": "users/create-gpg-key-for-authenticated",
"operationId": "users/create-gpg-key-for-authenticated-user",
"tags": [
"users"
],
@@ -89202,7 +89316,7 @@
"tags": [
"users"
],
"operationId": "users/get-gpg-key-for-authenticated",
"operationId": "users/get-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
@@ -89284,7 +89398,7 @@
"tags": [
"users"
],
"operationId": "users/delete-gpg-key-for-authenticated",
"operationId": "users/delete-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
@@ -89575,7 +89689,7 @@
"tags": [
"apps"
],
"operationId": "apps/add-repo-to-installation",
"operationId": "apps/add-repo-to-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/apps#add-a-repository-to-an-app-installation"
@@ -89660,7 +89774,7 @@
"tags": [
"apps"
],
"operationId": "apps/remove-repo-from-installation",
"operationId": "apps/remove-repo-from-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/apps#remove-a-repository-from-an-app-installation"
@@ -90157,7 +90271,7 @@
"tags": [
"users"
],
"operationId": "users/list-public-ssh-keys-for-authenticated",
"operationId": "users/list-public-ssh-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
@@ -90225,7 +90339,7 @@
],
"summary": "Create a public SSH key for the authenticated user",
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
"operationId": "users/create-public-ssh-key-for-authenticated",
"operationId": "users/create-public-ssh-key-for-authenticated-user",
"tags": [
"users"
],
@@ -90372,7 +90486,7 @@
"tags": [
"users"
],
"operationId": "users/get-public-ssh-key-for-authenticated",
"operationId": "users/get-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
@@ -90454,7 +90568,7 @@
"tags": [
"users"
],
"operationId": "users/delete-public-ssh-key-for-authenticated",
"operationId": "users/delete-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
@@ -91689,7 +91803,7 @@
"tags": [
"migrations"
],
"operationId": "migrations/list-repos-for-user",
"operationId": "migrations/list-repos-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/migrations#list-repositories-for-a-user-migration"
@@ -92757,7 +92871,7 @@
"tags": [
"users"
],
"operationId": "users/list-public-emails-for-authenticated",
"operationId": "users/list-public-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
@@ -93596,7 +93710,7 @@
"tags": [
"repos"
],
"operationId": "repos/accept-invitation",
"operationId": "repos/accept-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/repos#accept-a-repository-invitation"
@@ -93677,7 +93791,7 @@
"tags": [
"repos"
],
"operationId": "repos/decline-invitation",
"operationId": "repos/decline-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/repos#decline-a-repository-invitation"

132
lib/rest/static/decorated/ghes-2.22.json
View File

@@ -8897,7 +8897,7 @@
}
],
"summary": "List self-hosted runner groups for an enterprise",
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-self-hosted-runner-groups-for-enterprise",
"tags": [
"enterprise-admin"
@@ -8920,7 +8920,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists all self-hosted runner groups for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Lists all self-hosted runner groups for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -8959,7 +8959,7 @@
}
],
"summary": "Create a self-hosted runner group for an enterprise",
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/create-self-hosted-runner-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -9057,7 +9057,7 @@
"subcategoryLabel": "Actions",
"contentType": "application/json",
"notes": [],
"descriptionHTML": "<p>Creates a new self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Creates a new self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"bodyParameters": [
{
"description": "<p><strong>Required</strong>. Name of the runner group.</p>",
@@ -9156,7 +9156,7 @@
}
],
"summary": "Get a self-hosted runner group for an enterprise",
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/get-self-hosted-runner-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -9179,7 +9179,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Gets a specific self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Gets a specific self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -9228,7 +9228,7 @@
}
],
"summary": "Update a self-hosted runner group for an enterprise",
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/update-self-hosted-runner-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -9289,7 +9289,7 @@
"subcategoryLabel": "Actions",
"contentType": "application/json",
"notes": [],
"descriptionHTML": "<p>Updates the <code>name</code> and <code>visibility</code> of a self-hosted runner group in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Updates the <code>name</code> and <code>visibility</code> of a self-hosted runner group in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"bodyParameters": [
{
"description": "<p>Name of the runner group.</p>",
@@ -9363,7 +9363,7 @@
}
],
"summary": "Delete a self-hosted runner group from an enterprise",
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/delete-self-hosted-runner-group-from-enterprise",
"tags": [
"enterprise-admin"
@@ -9393,7 +9393,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Deletes a self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
"descriptionHTML": "<p>Deletes a self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
},
{
"verb": "get",
@@ -9454,7 +9454,7 @@
}
],
"summary": "List organization access to a self-hosted runner group in an enterprise",
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -9477,7 +9477,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists the organizations with access to a self-hosted runner group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Lists the organizations with access to a self-hosted runner group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -9526,7 +9526,7 @@
}
],
"summary": "Set organization access for a self-hosted runner group in an enterprise",
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -9590,7 +9590,7 @@
"description": "Response"
}
],
"descriptionHTML": "<p>Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"bodyParameters": [
{
"description": "<p><strong>Required</strong>. List of organization IDs that can access the runner group.</p>",
@@ -9656,7 +9656,7 @@
}
],
"summary": "Add organization access to a self-hosted runner group in an enterprise",
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -9686,7 +9686,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
"descriptionHTML": "<p>Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
},
{
"verb": "delete",
@@ -9737,7 +9737,7 @@
}
],
"summary": "Remove organization access to a self-hosted runner group in an enterprise",
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -9767,7 +9767,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
"descriptionHTML": "<p>Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
},
{
"verb": "get",
@@ -9828,7 +9828,7 @@
}
],
"summary": "List self-hosted runners in a group for an enterprise",
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -9851,7 +9851,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists the self-hosted runners that are in a specific enterprise group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Lists the self-hosted runners that are in a specific enterprise group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -9900,7 +9900,7 @@
}
],
"summary": "Set self-hosted runners in a group for an enterprise",
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -9964,7 +9964,7 @@
"description": "Response"
}
],
"descriptionHTML": "<p>Replaces the list of self-hosted runners that are part of an enterprise runner group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Replaces the list of self-hosted runners that are part of an enterprise runner group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"bodyParameters": [
{
"description": "<p><strong>Required</strong>. List of runner IDs to add to the runner group.</p>",
@@ -10030,7 +10030,7 @@
}
],
"summary": "Add a self-hosted runner to a group for an enterprise",
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise`\nscope to use this endpoint.",
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise`\nscope to use this endpoint.",
"operationId": "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -10060,7 +10060,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Adds a self-hosted runner to a runner group configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code>\nscope to use this endpoint.</p>"
"descriptionHTML": "<p>Adds a self-hosted runner to a runner group configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code>\nscope to use this endpoint.</p>"
},
{
"verb": "delete",
@@ -10111,7 +10111,7 @@
}
],
"summary": "Remove a self-hosted runner from a group for an enterprise",
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -10141,7 +10141,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
},
{
"verb": "get",
@@ -10192,7 +10192,7 @@
}
],
"summary": "List self-hosted runners for an enterprise",
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-self-hosted-runners-for-enterprise",
"tags": [
"enterprise-admin"
@@ -10215,7 +10215,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists all self-hosted runners configured for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Lists all self-hosted runners configured for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -10254,7 +10254,7 @@
}
],
"summary": "List runner applications for an enterprise",
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-runner-applications-for-enterprise",
"tags": [
"enterprise-admin"
@@ -10277,7 +10277,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists binaries for the runner application that you can download and run.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Lists binaries for the runner application that you can download and run.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -10316,7 +10316,7 @@
}
],
"summary": "Create a registration token for an enterprise",
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
"operationId": "enterprise-admin/create-registration-token-for-enterprise",
"tags": [
"enterprise-admin"
@@ -10339,7 +10339,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-registration-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-registration-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using registration token</h4>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n</code></pre>",
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-registration-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-registration-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using registration token</h4>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n</code></pre>",
"responses": [
{
"httpStatusCode": "201",
@@ -10378,7 +10378,7 @@
}
],
"summary": "Create a remove token for an enterprise",
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
"operationId": "enterprise-admin/create-remove-token-for-enterprise",
"tags": [
"enterprise-admin"
@@ -10401,7 +10401,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an enterprise. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-remove-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-remove-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using remove token</h4>\n<p>To remove your self-hosted runner from an enterprise, replace <code>TOKEN</code> with the remove token provided by this\nendpoint.</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>",
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an enterprise. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-remove-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-remove-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using remove token</h4>\n<p>To remove your self-hosted runner from an enterprise, replace <code>TOKEN</code> with the remove token provided by this\nendpoint.</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>",
"responses": [
{
"httpStatusCode": "201",
@@ -10450,7 +10450,7 @@
}
],
"summary": "Get a self-hosted runner for an enterprise",
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/get-self-hosted-runner-for-enterprise",
"tags": [
"enterprise-admin"
@@ -10473,7 +10473,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Gets a specific self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Gets a specific self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -10522,7 +10522,7 @@
}
],
"summary": "Delete a self-hosted runner from an enterprise",
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/delete-self-hosted-runner-from-enterprise",
"tags": [
"enterprise-admin"
@@ -10552,7 +10552,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
"descriptionHTML": "<p>Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
},
{
"verb": "get",
@@ -58410,6 +58410,8 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "repos",
"subcategory": "pages",
"previews": [
{
"required": true,
@@ -58417,9 +58419,7 @@
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
"html": "<p>Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/\">blog post</a> preview for more details. To access the new endpoints during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.22/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.switcheroo-preview+json</code></pre>"
}
],
"category": "repos",
"subcategory": "pages"
]
},
"slug": "create-a-github-enterprise-server-pages-site",
"category": "repos",
@@ -58441,11 +58441,6 @@
"httpStatusMessage": "Conflict",
"description": "Conflict"
},
{
"httpStatusCode": "415",
"httpStatusMessage": "Unsupported Media Type",
"description": "Preview header missing"
},
{
"httpStatusCode": "422",
"httpStatusMessage": "Unprocessable Entity",
@@ -58830,6 +58825,8 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "repos",
"subcategory": "pages",
"previews": [
{
"required": true,
@@ -58837,9 +58834,7 @@
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
"html": "<p>Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/\">blog post</a> preview for more details. To access the new endpoints during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.22/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.switcheroo-preview+json</code></pre>"
}
],
"category": "repos",
"subcategory": "pages"
]
},
"slug": "delete-a-github-enterprise-server-pages-site",
"category": "repos",
@@ -58858,11 +58853,6 @@
"httpStatusMessage": "Not Found",
"description": "Resource not found"
},
{
"httpStatusCode": "415",
"httpStatusMessage": "Unsupported Media Type",
"description": "Preview header missing"
},
{
"httpStatusCode": "422",
"httpStatusMessage": "Unprocessable Entity",
@@ -73488,7 +73478,7 @@
"tags": [
"users"
],
"operationId": "users/list-emails-for-authenticated",
"operationId": "users/list-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#list-email-addresses-for-the-authenticated-user"
@@ -73559,7 +73549,7 @@
"tags": [
"users"
],
"operationId": "users/add-email-for-authenticated",
"operationId": "users/add-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#add-an-email-address-for-the-authenticated-user"
@@ -73702,7 +73692,7 @@
"tags": [
"users"
],
"operationId": "users/delete-email-for-authenticated",
"operationId": "users/delete-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
@@ -73951,7 +73941,7 @@
"tags": [
"users"
],
"operationId": "users/list-followed-by-authenticated",
"operationId": "users/list-followed-by-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#list-the-people-the-authenticated-user-follows"
@@ -74278,7 +74268,7 @@
"tags": [
"users"
],
"operationId": "users/list-gpg-keys-for-authenticated",
"operationId": "users/list-gpg-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
@@ -74346,7 +74336,7 @@
],
"summary": "Create a GPG key for the authenticated user",
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
"operationId": "users/create-gpg-key-for-authenticated",
"operationId": "users/create-gpg-key-for-authenticated-user",
"tags": [
"users"
],
@@ -74471,7 +74461,7 @@
"tags": [
"users"
],
"operationId": "users/get-gpg-key-for-authenticated",
"operationId": "users/get-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
@@ -74553,7 +74543,7 @@
"tags": [
"users"
],
"operationId": "users/delete-gpg-key-for-authenticated",
"operationId": "users/delete-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
@@ -74844,7 +74834,7 @@
"tags": [
"apps"
],
"operationId": "apps/add-repo-to-installation",
"operationId": "apps/add-repo-to-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/apps#add-a-repository-to-an-app-installation"
@@ -74929,7 +74919,7 @@
"tags": [
"apps"
],
"operationId": "apps/remove-repo-from-installation",
"operationId": "apps/remove-repo-from-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/apps#remove-a-repository-from-an-app-installation"
@@ -75194,7 +75184,7 @@
"tags": [
"users"
],
"operationId": "users/list-public-ssh-keys-for-authenticated",
"operationId": "users/list-public-ssh-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
@@ -75262,7 +75252,7 @@
],
"summary": "Create a public SSH key for the authenticated user",
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
"operationId": "users/create-public-ssh-key-for-authenticated",
"operationId": "users/create-public-ssh-key-for-authenticated-user",
"tags": [
"users"
],
@@ -75409,7 +75399,7 @@
"tags": [
"users"
],
"operationId": "users/get-public-ssh-key-for-authenticated",
"operationId": "users/get-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
@@ -75491,7 +75481,7 @@
"tags": [
"users"
],
"operationId": "users/delete-public-ssh-key-for-authenticated",
"operationId": "users/delete-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
@@ -76103,7 +76093,7 @@
"tags": [
"users"
],
"operationId": "users/list-public-emails-for-authenticated",
"operationId": "users/list-public-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
@@ -76925,7 +76915,7 @@
"tags": [
"repos"
],
"operationId": "repos/accept-invitation",
"operationId": "repos/accept-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#accept-a-repository-invitation"
@@ -77006,7 +76996,7 @@
"tags": [
"repos"
],
"operationId": "repos/decline-invitation",
"operationId": "repos/decline-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#decline-a-repository-invitation"

132
lib/rest/static/decorated/ghes-3.0.json
View File

@@ -11921,7 +11921,7 @@
}
],
"summary": "List self-hosted runner groups for an enterprise",
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-self-hosted-runner-groups-for-enterprise",
"tags": [
"enterprise-admin"
@@ -11944,7 +11944,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists all self-hosted runner groups for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Lists all self-hosted runner groups for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -11983,7 +11983,7 @@
}
],
"summary": "Create a self-hosted runner group for an enterprise",
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/create-self-hosted-runner-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -12081,7 +12081,7 @@
"subcategoryLabel": "Actions",
"contentType": "application/json",
"notes": [],
"descriptionHTML": "<p>Creates a new self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Creates a new self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"bodyParameters": [
{
"description": "<p><strong>Required</strong>. Name of the runner group.</p>",
@@ -12180,7 +12180,7 @@
}
],
"summary": "Get a self-hosted runner group for an enterprise",
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/get-self-hosted-runner-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -12203,7 +12203,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Gets a specific self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Gets a specific self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -12252,7 +12252,7 @@
}
],
"summary": "Update a self-hosted runner group for an enterprise",
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/update-self-hosted-runner-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -12313,7 +12313,7 @@
"subcategoryLabel": "Actions",
"contentType": "application/json",
"notes": [],
"descriptionHTML": "<p>Updates the <code>name</code> and <code>visibility</code> of a self-hosted runner group in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Updates the <code>name</code> and <code>visibility</code> of a self-hosted runner group in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"bodyParameters": [
{
"description": "<p>Name of the runner group.</p>",
@@ -12387,7 +12387,7 @@
}
],
"summary": "Delete a self-hosted runner group from an enterprise",
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/delete-self-hosted-runner-group-from-enterprise",
"tags": [
"enterprise-admin"
@@ -12417,7 +12417,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Deletes a self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
"descriptionHTML": "<p>Deletes a self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
},
{
"verb": "get",
@@ -12478,7 +12478,7 @@
}
],
"summary": "List organization access to a self-hosted runner group in an enterprise",
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -12501,7 +12501,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists the organizations with access to a self-hosted runner group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Lists the organizations with access to a self-hosted runner group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -12550,7 +12550,7 @@
}
],
"summary": "Set organization access for a self-hosted runner group in an enterprise",
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -12614,7 +12614,7 @@
"description": "Response"
}
],
"descriptionHTML": "<p>Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"bodyParameters": [
{
"description": "<p><strong>Required</strong>. List of organization IDs that can access the runner group.</p>",
@@ -12680,7 +12680,7 @@
}
],
"summary": "Add organization access to a self-hosted runner group in an enterprise",
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -12710,7 +12710,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
"descriptionHTML": "<p>Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
},
{
"verb": "delete",
@@ -12761,7 +12761,7 @@
}
],
"summary": "Remove organization access to a self-hosted runner group in an enterprise",
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -12791,7 +12791,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
"descriptionHTML": "<p>Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
},
{
"verb": "get",
@@ -12852,7 +12852,7 @@
}
],
"summary": "List self-hosted runners in a group for an enterprise",
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -12875,7 +12875,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists the self-hosted runners that are in a specific enterprise group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Lists the self-hosted runners that are in a specific enterprise group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -12924,7 +12924,7 @@
}
],
"summary": "Set self-hosted runners in a group for an enterprise",
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -12988,7 +12988,7 @@
"description": "Response"
}
],
"descriptionHTML": "<p>Replaces the list of self-hosted runners that are part of an enterprise runner group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Replaces the list of self-hosted runners that are part of an enterprise runner group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"bodyParameters": [
{
"description": "<p><strong>Required</strong>. List of runner IDs to add to the runner group.</p>",
@@ -13054,7 +13054,7 @@
}
],
"summary": "Add a self-hosted runner to a group for an enterprise",
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise`\nscope to use this endpoint.",
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise`\nscope to use this endpoint.",
"operationId": "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -13084,7 +13084,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Adds a self-hosted runner to a runner group configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code>\nscope to use this endpoint.</p>"
"descriptionHTML": "<p>Adds a self-hosted runner to a runner group configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code>\nscope to use this endpoint.</p>"
},
{
"verb": "delete",
@@ -13135,7 +13135,7 @@
}
],
"summary": "Remove a self-hosted runner from a group for an enterprise",
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -13165,7 +13165,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
},
{
"verb": "get",
@@ -13216,7 +13216,7 @@
}
],
"summary": "List self-hosted runners for an enterprise",
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-self-hosted-runners-for-enterprise",
"tags": [
"enterprise-admin"
@@ -13239,7 +13239,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists all self-hosted runners configured for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Lists all self-hosted runners configured for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -13278,7 +13278,7 @@
}
],
"summary": "List runner applications for an enterprise",
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-runner-applications-for-enterprise",
"tags": [
"enterprise-admin"
@@ -13301,7 +13301,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists binaries for the runner application that you can download and run.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Lists binaries for the runner application that you can download and run.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -13340,7 +13340,7 @@
}
],
"summary": "Create a registration token for an enterprise",
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
"operationId": "enterprise-admin/create-registration-token-for-enterprise",
"tags": [
"enterprise-admin"
@@ -13363,7 +13363,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-registration-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-registration-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using registration token</h4>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n</code></pre>",
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-registration-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-registration-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using registration token</h4>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n</code></pre>",
"responses": [
{
"httpStatusCode": "201",
@@ -13402,7 +13402,7 @@
}
],
"summary": "Create a remove token for an enterprise",
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
"operationId": "enterprise-admin/create-remove-token-for-enterprise",
"tags": [
"enterprise-admin"
@@ -13425,7 +13425,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an enterprise. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-remove-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-remove-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using remove token</h4>\n<p>To remove your self-hosted runner from an enterprise, replace <code>TOKEN</code> with the remove token provided by this\nendpoint.</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>",
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an enterprise. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-remove-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-remove-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using remove token</h4>\n<p>To remove your self-hosted runner from an enterprise, replace <code>TOKEN</code> with the remove token provided by this\nendpoint.</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>",
"responses": [
{
"httpStatusCode": "201",
@@ -13474,7 +13474,7 @@
}
],
"summary": "Get a self-hosted runner for an enterprise",
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/get-self-hosted-runner-for-enterprise",
"tags": [
"enterprise-admin"
@@ -13497,7 +13497,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Gets a specific self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Gets a specific self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -13546,7 +13546,7 @@
}
],
"summary": "Delete a self-hosted runner from an enterprise",
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/delete-self-hosted-runner-from-enterprise",
"tags": [
"enterprise-admin"
@@ -13576,7 +13576,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
"descriptionHTML": "<p>Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
},
{
"verb": "get",
@@ -63213,6 +63213,8 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "repos",
"subcategory": "pages",
"previews": [
{
"required": true,
@@ -63220,9 +63222,7 @@
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
"html": "<p>Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/\">blog post</a> preview for more details. To access the new endpoints during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.0/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.switcheroo-preview+json</code></pre>"
}
],
"category": "repos",
"subcategory": "pages"
]
},
"slug": "create-a-github-enterprise-server-pages-site",
"category": "repos",
@@ -63244,11 +63244,6 @@
"httpStatusMessage": "Conflict",
"description": "Conflict"
},
{
"httpStatusCode": "415",
"httpStatusMessage": "Unsupported Media Type",
"description": "Preview header missing"
},
{
"httpStatusCode": "422",
"httpStatusMessage": "Unprocessable Entity",
@@ -63633,6 +63628,8 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "repos",
"subcategory": "pages",
"previews": [
{
"required": true,
@@ -63640,9 +63637,7 @@
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
"html": "<p>Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/\">blog post</a> preview for more details. To access the new endpoints during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.0/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.switcheroo-preview+json</code></pre>"
}
],
"category": "repos",
"subcategory": "pages"
]
},
"slug": "delete-a-github-enterprise-server-pages-site",
"category": "repos",
@@ -63661,11 +63656,6 @@
"httpStatusMessage": "Not Found",
"description": "Resource not found"
},
{
"httpStatusCode": "415",
"httpStatusMessage": "Unsupported Media Type",
"description": "Preview header missing"
},
{
"httpStatusCode": "422",
"httpStatusMessage": "Unprocessable Entity",
@@ -78291,7 +78281,7 @@
"tags": [
"users"
],
"operationId": "users/list-emails-for-authenticated",
"operationId": "users/list-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-email-addresses-for-the-authenticated-user"
@@ -78362,7 +78352,7 @@
"tags": [
"users"
],
"operationId": "users/add-email-for-authenticated",
"operationId": "users/add-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#add-an-email-address-for-the-authenticated-user"
@@ -78505,7 +78495,7 @@
"tags": [
"users"
],
"operationId": "users/delete-email-for-authenticated",
"operationId": "users/delete-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
@@ -78754,7 +78744,7 @@
"tags": [
"users"
],
"operationId": "users/list-followed-by-authenticated",
"operationId": "users/list-followed-by-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-the-people-the-authenticated-user-follows"
@@ -79081,7 +79071,7 @@
"tags": [
"users"
],
"operationId": "users/list-gpg-keys-for-authenticated",
"operationId": "users/list-gpg-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
@@ -79149,7 +79139,7 @@
],
"summary": "Create a GPG key for the authenticated user",
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
"operationId": "users/create-gpg-key-for-authenticated",
"operationId": "users/create-gpg-key-for-authenticated-user",
"tags": [
"users"
],
@@ -79274,7 +79264,7 @@
"tags": [
"users"
],
"operationId": "users/get-gpg-key-for-authenticated",
"operationId": "users/get-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
@@ -79356,7 +79346,7 @@
"tags": [
"users"
],
"operationId": "users/delete-gpg-key-for-authenticated",
"operationId": "users/delete-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
@@ -79647,7 +79637,7 @@
"tags": [
"apps"
],
"operationId": "apps/add-repo-to-installation",
"operationId": "apps/add-repo-to-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#add-a-repository-to-an-app-installation"
@@ -79732,7 +79722,7 @@
"tags": [
"apps"
],
"operationId": "apps/remove-repo-from-installation",
"operationId": "apps/remove-repo-from-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#remove-a-repository-from-an-app-installation"
@@ -79997,7 +79987,7 @@
"tags": [
"users"
],
"operationId": "users/list-public-ssh-keys-for-authenticated",
"operationId": "users/list-public-ssh-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
@@ -80065,7 +80055,7 @@
],
"summary": "Create a public SSH key for the authenticated user",
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
"operationId": "users/create-public-ssh-key-for-authenticated",
"operationId": "users/create-public-ssh-key-for-authenticated-user",
"tags": [
"users"
],
@@ -80212,7 +80202,7 @@
"tags": [
"users"
],
"operationId": "users/get-public-ssh-key-for-authenticated",
"operationId": "users/get-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
@@ -80294,7 +80284,7 @@
"tags": [
"users"
],
"operationId": "users/delete-public-ssh-key-for-authenticated",
"operationId": "users/delete-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
@@ -80906,7 +80896,7 @@
"tags": [
"users"
],
"operationId": "users/list-public-emails-for-authenticated",
"operationId": "users/list-public-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
@@ -81728,7 +81718,7 @@
"tags": [
"repos"
],
"operationId": "repos/accept-invitation",
"operationId": "repos/accept-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#accept-a-repository-invitation"
@@ -81809,7 +81799,7 @@
"tags": [
"repos"
],
"operationId": "repos/decline-invitation",
"operationId": "repos/decline-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#decline-a-repository-invitation"

151
lib/rest/static/decorated/ghes-3.1.json
View File

@@ -11921,7 +11921,7 @@
}
],
"summary": "List self-hosted runner groups for an enterprise",
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-self-hosted-runner-groups-for-enterprise",
"tags": [
"enterprise-admin"
@@ -11944,7 +11944,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists all self-hosted runner groups for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Lists all self-hosted runner groups for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -11983,7 +11983,7 @@
}
],
"summary": "Create a self-hosted runner group for an enterprise",
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/create-self-hosted-runner-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -12081,7 +12081,7 @@
"subcategoryLabel": "Actions",
"contentType": "application/json",
"notes": [],
"descriptionHTML": "<p>Creates a new self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Creates a new self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"bodyParameters": [
{
"description": "<p><strong>Required</strong>. Name of the runner group.</p>",
@@ -12180,7 +12180,7 @@
}
],
"summary": "Get a self-hosted runner group for an enterprise",
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/get-self-hosted-runner-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -12203,7 +12203,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Gets a specific self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Gets a specific self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -12252,7 +12252,7 @@
}
],
"summary": "Update a self-hosted runner group for an enterprise",
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/update-self-hosted-runner-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -12313,7 +12313,7 @@
"subcategoryLabel": "Actions",
"contentType": "application/json",
"notes": [],
"descriptionHTML": "<p>Updates the <code>name</code> and <code>visibility</code> of a self-hosted runner group in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Updates the <code>name</code> and <code>visibility</code> of a self-hosted runner group in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"bodyParameters": [
{
"description": "<p>Name of the runner group.</p>",
@@ -12387,7 +12387,7 @@
}
],
"summary": "Delete a self-hosted runner group from an enterprise",
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/delete-self-hosted-runner-group-from-enterprise",
"tags": [
"enterprise-admin"
@@ -12417,7 +12417,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Deletes a self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
"descriptionHTML": "<p>Deletes a self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
},
{
"verb": "get",
@@ -12478,7 +12478,7 @@
}
],
"summary": "List organization access to a self-hosted runner group in an enterprise",
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -12501,7 +12501,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists the organizations with access to a self-hosted runner group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Lists the organizations with access to a self-hosted runner group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -12550,7 +12550,7 @@
}
],
"summary": "Set organization access for a self-hosted runner group in an enterprise",
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -12614,7 +12614,7 @@
"description": "Response"
}
],
"descriptionHTML": "<p>Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"bodyParameters": [
{
"description": "<p><strong>Required</strong>. List of organization IDs that can access the runner group.</p>",
@@ -12680,7 +12680,7 @@
}
],
"summary": "Add organization access to a self-hosted runner group in an enterprise",
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -12710,7 +12710,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
"descriptionHTML": "<p>Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
},
{
"verb": "delete",
@@ -12761,7 +12761,7 @@
}
],
"summary": "Remove organization access to a self-hosted runner group in an enterprise",
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -12791,7 +12791,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
"descriptionHTML": "<p>Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
},
{
"verb": "get",
@@ -12852,7 +12852,7 @@
}
],
"summary": "List self-hosted runners in a group for an enterprise",
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -12875,7 +12875,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists the self-hosted runners that are in a specific enterprise group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Lists the self-hosted runners that are in a specific enterprise group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -12924,7 +12924,7 @@
}
],
"summary": "Set self-hosted runners in a group for an enterprise",
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -12988,7 +12988,7 @@
"description": "Response"
}
],
"descriptionHTML": "<p>Replaces the list of self-hosted runners that are part of an enterprise runner group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Replaces the list of self-hosted runners that are part of an enterprise runner group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"bodyParameters": [
{
"description": "<p><strong>Required</strong>. List of runner IDs to add to the runner group.</p>",
@@ -13054,7 +13054,7 @@
}
],
"summary": "Add a self-hosted runner to a group for an enterprise",
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise`\nscope to use this endpoint.",
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise`\nscope to use this endpoint.",
"operationId": "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -13084,7 +13084,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Adds a self-hosted runner to a runner group configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code>\nscope to use this endpoint.</p>"
"descriptionHTML": "<p>Adds a self-hosted runner to a runner group configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code>\nscope to use this endpoint.</p>"
},
{
"verb": "delete",
@@ -13135,7 +13135,7 @@
}
],
"summary": "Remove a self-hosted runner from a group for an enterprise",
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -13165,7 +13165,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
},
{
"verb": "get",
@@ -13216,7 +13216,7 @@
}
],
"summary": "List self-hosted runners for an enterprise",
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-self-hosted-runners-for-enterprise",
"tags": [
"enterprise-admin"
@@ -13239,7 +13239,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists all self-hosted runners configured for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Lists all self-hosted runners configured for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -13278,7 +13278,7 @@
}
],
"summary": "List runner applications for an enterprise",
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-runner-applications-for-enterprise",
"tags": [
"enterprise-admin"
@@ -13301,7 +13301,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists binaries for the runner application that you can download and run.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Lists binaries for the runner application that you can download and run.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -13340,7 +13340,7 @@
}
],
"summary": "Create a registration token for an enterprise",
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
"operationId": "enterprise-admin/create-registration-token-for-enterprise",
"tags": [
"enterprise-admin"
@@ -13363,7 +13363,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-registration-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-registration-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using registration token</h4>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n</code></pre>",
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-registration-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-registration-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using registration token</h4>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n</code></pre>",
"responses": [
{
"httpStatusCode": "201",
@@ -13402,7 +13402,7 @@
}
],
"summary": "Create a remove token for an enterprise",
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
"operationId": "enterprise-admin/create-remove-token-for-enterprise",
"tags": [
"enterprise-admin"
@@ -13425,7 +13425,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an enterprise. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-remove-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-remove-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using remove token</h4>\n<p>To remove your self-hosted runner from an enterprise, replace <code>TOKEN</code> with the remove token provided by this\nendpoint.</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>",
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an enterprise. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-remove-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-remove-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using remove token</h4>\n<p>To remove your self-hosted runner from an enterprise, replace <code>TOKEN</code> with the remove token provided by this\nendpoint.</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>",
"responses": [
{
"httpStatusCode": "201",
@@ -13474,7 +13474,7 @@
}
],
"summary": "Get a self-hosted runner for an enterprise",
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/get-self-hosted-runner-for-enterprise",
"tags": [
"enterprise-admin"
@@ -13497,7 +13497,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Gets a specific self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Gets a specific self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -13546,7 +13546,7 @@
}
],
"summary": "Delete a self-hosted runner from an enterprise",
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/delete-self-hosted-runner-from-enterprise",
"tags": [
"enterprise-admin"
@@ -13576,7 +13576,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
"descriptionHTML": "<p>Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
},
{
"verb": "get",
@@ -63903,6 +63903,8 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "repos",
"subcategory": "pages",
"previews": [
{
"required": true,
@@ -63910,9 +63912,7 @@
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
"html": "<p>Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/\">blog post</a> preview for more details. To access the new endpoints during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.1/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.switcheroo-preview+json</code></pre>"
}
],
"category": "repos",
"subcategory": "pages"
]
},
"slug": "create-a-github-enterprise-server-pages-site",
"category": "repos",
@@ -63934,11 +63934,6 @@
"httpStatusMessage": "Conflict",
"description": "Conflict"
},
{
"httpStatusCode": "415",
"httpStatusMessage": "Unsupported Media Type",
"description": "Preview header missing"
},
{
"httpStatusCode": "422",
"httpStatusMessage": "Unprocessable Entity",
@@ -64323,6 +64318,8 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "repos",
"subcategory": "pages",
"previews": [
{
"required": true,
@@ -64330,9 +64327,7 @@
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
"html": "<p>Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/\">blog post</a> preview for more details. To access the new endpoints during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.1/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.switcheroo-preview+json</code></pre>"
}
],
"category": "repos",
"subcategory": "pages"
]
},
"slug": "delete-a-github-enterprise-server-pages-site",
"category": "repos",
@@ -64351,11 +64346,6 @@
"httpStatusMessage": "Not Found",
"description": "Resource not found"
},
{
"httpStatusCode": "415",
"httpStatusMessage": "Unsupported Media Type",
"description": "Preview header missing"
},
{
"httpStatusCode": "422",
"httpStatusMessage": "Unprocessable Entity",
@@ -71491,12 +71481,22 @@
{
"name": "secret_type",
"in": "query",
"description": "A comma separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.1/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
"description": "A comma-separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.1/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
"required": false,
"schema": {
"type": "string"
},
"descriptionHTML": "<p>A comma separated list of secret types to return. By default all secret types are returned. See \"<a href=\"https://docs.github.com/enterprise-server@3.1/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories\">About secret scanning for private repositories</a>\" for a complete list of secret types (API slug).</p>"
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned. See \"<a href=\"https://docs.github.com/enterprise-server@3.1/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories\">About secret scanning for private repositories</a>\" for a complete list of secret types (API slug).</p>"
},
{
"name": "resolution",
"in": "query",
"description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.",
"required": false,
"schema": {
"type": "string"
},
"descriptionHTML": "<p>A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are <code>false_positive</code>, <code>wont_fix</code>, <code>revoked</code>, <code>pattern_edited</code>, <code>pattern_deleted</code> or <code>used_in_tests</code>.</p>"
},
{
"name": "page",
@@ -71652,6 +71652,11 @@
"description": "Response",
"payload": "<pre><code class=\"hljs language-json\"><span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"number\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">42</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"created_at\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"2020-11-06T18:18:30Z\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"html_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://github.com/owner/private-repo/security/secret-scanning/42\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"state\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"open\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"resolution\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-keyword\">null</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"resolved_at\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-keyword\">null</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"resolved_by\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-keyword\">null</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"secret_type\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"mailchimp_api_key\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"secret\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2\"</span>\n<span class=\"hljs-punctuation\">}</span>\n</code></pre>"
},
{
"httpStatusCode": "304",
"httpStatusMessage": "Not Modified",
"description": "Not modified"
},
{
"httpStatusCode": "404",
"httpStatusMessage": "Not Found",
@@ -79194,7 +79199,7 @@
"tags": [
"users"
],
"operationId": "users/list-emails-for-authenticated",
"operationId": "users/list-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#list-email-addresses-for-the-authenticated-user"
@@ -79265,7 +79270,7 @@
"tags": [
"users"
],
"operationId": "users/add-email-for-authenticated",
"operationId": "users/add-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#add-an-email-address-for-the-authenticated-user"
@@ -79408,7 +79413,7 @@
"tags": [
"users"
],
"operationId": "users/delete-email-for-authenticated",
"operationId": "users/delete-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
@@ -79657,7 +79662,7 @@
"tags": [
"users"
],
"operationId": "users/list-followed-by-authenticated",
"operationId": "users/list-followed-by-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#list-the-people-the-authenticated-user-follows"
@@ -79984,7 +79989,7 @@
"tags": [
"users"
],
"operationId": "users/list-gpg-keys-for-authenticated",
"operationId": "users/list-gpg-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
@@ -80052,7 +80057,7 @@
],
"summary": "Create a GPG key for the authenticated user",
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/enterprise-server@3.1/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
"operationId": "users/create-gpg-key-for-authenticated",
"operationId": "users/create-gpg-key-for-authenticated-user",
"tags": [
"users"
],
@@ -80177,7 +80182,7 @@
"tags": [
"users"
],
"operationId": "users/get-gpg-key-for-authenticated",
"operationId": "users/get-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
@@ -80259,7 +80264,7 @@
"tags": [
"users"
],
"operationId": "users/delete-gpg-key-for-authenticated",
"operationId": "users/delete-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
@@ -80550,7 +80555,7 @@
"tags": [
"apps"
],
"operationId": "apps/add-repo-to-installation",
"operationId": "apps/add-repo-to-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/apps#add-a-repository-to-an-app-installation"
@@ -80635,7 +80640,7 @@
"tags": [
"apps"
],
"operationId": "apps/remove-repo-from-installation",
"operationId": "apps/remove-repo-from-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/apps#remove-a-repository-from-an-app-installation"
@@ -80900,7 +80905,7 @@
"tags": [
"users"
],
"operationId": "users/list-public-ssh-keys-for-authenticated",
"operationId": "users/list-public-ssh-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
@@ -80968,7 +80973,7 @@
],
"summary": "Create a public SSH key for the authenticated user",
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/enterprise-server@3.1/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
"operationId": "users/create-public-ssh-key-for-authenticated",
"operationId": "users/create-public-ssh-key-for-authenticated-user",
"tags": [
"users"
],
@@ -81115,7 +81120,7 @@
"tags": [
"users"
],
"operationId": "users/get-public-ssh-key-for-authenticated",
"operationId": "users/get-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
@@ -81197,7 +81202,7 @@
"tags": [
"users"
],
"operationId": "users/delete-public-ssh-key-for-authenticated",
"operationId": "users/delete-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
@@ -81809,7 +81814,7 @@
"tags": [
"users"
],
"operationId": "users/list-public-emails-for-authenticated",
"operationId": "users/list-public-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
@@ -82631,7 +82636,7 @@
"tags": [
"repos"
],
"operationId": "repos/accept-invitation",
"operationId": "repos/accept-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/repos#accept-a-repository-invitation"
@@ -82712,7 +82717,7 @@
"tags": [
"repos"
],
"operationId": "repos/decline-invitation",
"operationId": "repos/decline-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/repos#decline-a-repository-invitation"

151
lib/rest/static/decorated/ghes-3.2.json
View File

@@ -12144,7 +12144,7 @@
}
],
"summary": "List self-hosted runner groups for an enterprise",
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-self-hosted-runner-groups-for-enterprise",
"tags": [
"enterprise-admin"
@@ -12167,7 +12167,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists all self-hosted runner groups for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Lists all self-hosted runner groups for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -12206,7 +12206,7 @@
}
],
"summary": "Create a self-hosted runner group for an enterprise",
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/create-self-hosted-runner-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -12304,7 +12304,7 @@
"subcategoryLabel": "Actions",
"contentType": "application/json",
"notes": [],
"descriptionHTML": "<p>Creates a new self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Creates a new self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"bodyParameters": [
{
"description": "<p><strong>Required</strong>. Name of the runner group.</p>",
@@ -12403,7 +12403,7 @@
}
],
"summary": "Get a self-hosted runner group for an enterprise",
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/get-self-hosted-runner-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -12426,7 +12426,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Gets a specific self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Gets a specific self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -12475,7 +12475,7 @@
}
],
"summary": "Update a self-hosted runner group for an enterprise",
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/update-self-hosted-runner-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -12536,7 +12536,7 @@
"subcategoryLabel": "Actions",
"contentType": "application/json",
"notes": [],
"descriptionHTML": "<p>Updates the <code>name</code> and <code>visibility</code> of a self-hosted runner group in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Updates the <code>name</code> and <code>visibility</code> of a self-hosted runner group in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"bodyParameters": [
{
"description": "<p>Name of the runner group.</p>",
@@ -12610,7 +12610,7 @@
}
],
"summary": "Delete a self-hosted runner group from an enterprise",
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/delete-self-hosted-runner-group-from-enterprise",
"tags": [
"enterprise-admin"
@@ -12640,7 +12640,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Deletes a self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
"descriptionHTML": "<p>Deletes a self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
},
{
"verb": "get",
@@ -12701,7 +12701,7 @@
}
],
"summary": "List organization access to a self-hosted runner group in an enterprise",
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -12724,7 +12724,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists the organizations with access to a self-hosted runner group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Lists the organizations with access to a self-hosted runner group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -12773,7 +12773,7 @@
}
],
"summary": "Set organization access for a self-hosted runner group in an enterprise",
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -12837,7 +12837,7 @@
"description": "Response"
}
],
"descriptionHTML": "<p>Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"bodyParameters": [
{
"description": "<p><strong>Required</strong>. List of organization IDs that can access the runner group.</p>",
@@ -12903,7 +12903,7 @@
}
],
"summary": "Add organization access to a self-hosted runner group in an enterprise",
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -12933,7 +12933,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
"descriptionHTML": "<p>Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
},
{
"verb": "delete",
@@ -12984,7 +12984,7 @@
}
],
"summary": "Remove organization access to a self-hosted runner group in an enterprise",
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -13014,7 +13014,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
"descriptionHTML": "<p>Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
},
{
"verb": "get",
@@ -13075,7 +13075,7 @@
}
],
"summary": "List self-hosted runners in a group for an enterprise",
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -13098,7 +13098,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists the self-hosted runners that are in a specific enterprise group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Lists the self-hosted runners that are in a specific enterprise group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -13147,7 +13147,7 @@
}
],
"summary": "Set self-hosted runners in a group for an enterprise",
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -13211,7 +13211,7 @@
"description": "Response"
}
],
"descriptionHTML": "<p>Replaces the list of self-hosted runners that are part of an enterprise runner group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Replaces the list of self-hosted runners that are part of an enterprise runner group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"bodyParameters": [
{
"description": "<p><strong>Required</strong>. List of runner IDs to add to the runner group.</p>",
@@ -13277,7 +13277,7 @@
}
],
"summary": "Add a self-hosted runner to a group for an enterprise",
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise`\nscope to use this endpoint.",
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise`\nscope to use this endpoint.",
"operationId": "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -13307,7 +13307,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Adds a self-hosted runner to a runner group configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code>\nscope to use this endpoint.</p>"
"descriptionHTML": "<p>Adds a self-hosted runner to a runner group configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code>\nscope to use this endpoint.</p>"
},
{
"verb": "delete",
@@ -13358,7 +13358,7 @@
}
],
"summary": "Remove a self-hosted runner from a group for an enterprise",
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -13388,7 +13388,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
},
{
"verb": "get",
@@ -13439,7 +13439,7 @@
}
],
"summary": "List self-hosted runners for an enterprise",
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-self-hosted-runners-for-enterprise",
"tags": [
"enterprise-admin"
@@ -13462,7 +13462,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists all self-hosted runners configured for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Lists all self-hosted runners configured for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -13501,7 +13501,7 @@
}
],
"summary": "List runner applications for an enterprise",
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-runner-applications-for-enterprise",
"tags": [
"enterprise-admin"
@@ -13524,7 +13524,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists binaries for the runner application that you can download and run.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Lists binaries for the runner application that you can download and run.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -13563,7 +13563,7 @@
}
],
"summary": "Create a registration token for an enterprise",
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
"operationId": "enterprise-admin/create-registration-token-for-enterprise",
"tags": [
"enterprise-admin"
@@ -13586,7 +13586,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-registration-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-registration-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using registration token</h4>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n</code></pre>",
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-registration-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-registration-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using registration token</h4>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n</code></pre>",
"responses": [
{
"httpStatusCode": "201",
@@ -13625,7 +13625,7 @@
}
],
"summary": "Create a remove token for an enterprise",
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
"operationId": "enterprise-admin/create-remove-token-for-enterprise",
"tags": [
"enterprise-admin"
@@ -13648,7 +13648,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an enterprise. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-remove-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-remove-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using remove token</h4>\n<p>To remove your self-hosted runner from an enterprise, replace <code>TOKEN</code> with the remove token provided by this\nendpoint.</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>",
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an enterprise. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-remove-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-remove-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using remove token</h4>\n<p>To remove your self-hosted runner from an enterprise, replace <code>TOKEN</code> with the remove token provided by this\nendpoint.</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>",
"responses": [
{
"httpStatusCode": "201",
@@ -13697,7 +13697,7 @@
}
],
"summary": "Get a self-hosted runner for an enterprise",
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/get-self-hosted-runner-for-enterprise",
"tags": [
"enterprise-admin"
@@ -13720,7 +13720,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Gets a specific self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Gets a specific self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -13769,7 +13769,7 @@
}
],
"summary": "Delete a self-hosted runner from an enterprise",
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/delete-self-hosted-runner-from-enterprise",
"tags": [
"enterprise-admin"
@@ -13799,7 +13799,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
"descriptionHTML": "<p>Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
},
{
"verb": "get",
@@ -66109,6 +66109,8 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "repos",
"subcategory": "pages",
"previews": [
{
"required": true,
@@ -66116,9 +66118,7 @@
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
"html": "<p>Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/\">blog post</a> preview for more details. To access the new endpoints during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.2/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.switcheroo-preview+json</code></pre>"
}
],
"category": "repos",
"subcategory": "pages"
]
},
"slug": "create-a-github-enterprise-server-pages-site",
"category": "repos",
@@ -66140,11 +66140,6 @@
"httpStatusMessage": "Conflict",
"description": "Conflict"
},
{
"httpStatusCode": "415",
"httpStatusMessage": "Unsupported Media Type",
"description": "Preview header missing"
},
{
"httpStatusCode": "422",
"httpStatusMessage": "Unprocessable Entity",
@@ -66529,6 +66524,8 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "repos",
"subcategory": "pages",
"previews": [
{
"required": true,
@@ -66536,9 +66533,7 @@
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
"html": "<p>Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/\">blog post</a> preview for more details. To access the new endpoints during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.2/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.switcheroo-preview+json</code></pre>"
}
],
"category": "repos",
"subcategory": "pages"
]
},
"slug": "delete-a-github-enterprise-server-pages-site",
"category": "repos",
@@ -66557,11 +66552,6 @@
"httpStatusMessage": "Not Found",
"description": "Resource not found"
},
{
"httpStatusCode": "415",
"httpStatusMessage": "Unsupported Media Type",
"description": "Preview header missing"
},
{
"httpStatusCode": "422",
"httpStatusMessage": "Unprocessable Entity",
@@ -73846,12 +73836,22 @@
{
"name": "secret_type",
"in": "query",
"description": "A comma separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.2/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
"description": "A comma-separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.2/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
"required": false,
"schema": {
"type": "string"
},
"descriptionHTML": "<p>A comma separated list of secret types to return. By default all secret types are returned. See \"<a href=\"https://docs.github.com/enterprise-server@3.2/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories\">About secret scanning for private repositories</a>\" for a complete list of secret types (API slug).</p>"
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned. See \"<a href=\"https://docs.github.com/enterprise-server@3.2/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories\">About secret scanning for private repositories</a>\" for a complete list of secret types (API slug).</p>"
},
{
"name": "resolution",
"in": "query",
"description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.",
"required": false,
"schema": {
"type": "string"
},
"descriptionHTML": "<p>A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are <code>false_positive</code>, <code>wont_fix</code>, <code>revoked</code>, <code>pattern_edited</code>, <code>pattern_deleted</code> or <code>used_in_tests</code>.</p>"
},
{
"name": "page",
@@ -74007,6 +74007,11 @@
"description": "Response",
"payload": "<pre><code class=\"hljs language-json\"><span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"number\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">42</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"created_at\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"2020-11-06T18:18:30Z\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"html_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://github.com/owner/private-repo/security/secret-scanning/42\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"state\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"open\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"resolution\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-keyword\">null</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"resolved_at\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-keyword\">null</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"resolved_by\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-keyword\">null</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"secret_type\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"mailchimp_api_key\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"secret\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2\"</span>\n<span class=\"hljs-punctuation\">}</span>\n</code></pre>"
},
{
"httpStatusCode": "304",
"httpStatusMessage": "Not Modified",
"description": "Not modified"
},
{
"httpStatusCode": "404",
"httpStatusMessage": "Not Found",
@@ -82017,7 +82022,7 @@
"tags": [
"users"
],
"operationId": "users/list-emails-for-authenticated",
"operationId": "users/list-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-email-addresses-for-the-authenticated-user"
@@ -82088,7 +82093,7 @@
"tags": [
"users"
],
"operationId": "users/add-email-for-authenticated",
"operationId": "users/add-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#add-an-email-address-for-the-authenticated-user"
@@ -82231,7 +82236,7 @@
"tags": [
"users"
],
"operationId": "users/delete-email-for-authenticated",
"operationId": "users/delete-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
@@ -82480,7 +82485,7 @@
"tags": [
"users"
],
"operationId": "users/list-followed-by-authenticated",
"operationId": "users/list-followed-by-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-the-people-the-authenticated-user-follows"
@@ -82807,7 +82812,7 @@
"tags": [
"users"
],
"operationId": "users/list-gpg-keys-for-authenticated",
"operationId": "users/list-gpg-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
@@ -82875,7 +82880,7 @@
],
"summary": "Create a GPG key for the authenticated user",
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
"operationId": "users/create-gpg-key-for-authenticated",
"operationId": "users/create-gpg-key-for-authenticated-user",
"tags": [
"users"
],
@@ -83000,7 +83005,7 @@
"tags": [
"users"
],
"operationId": "users/get-gpg-key-for-authenticated",
"operationId": "users/get-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
@@ -83082,7 +83087,7 @@
"tags": [
"users"
],
"operationId": "users/delete-gpg-key-for-authenticated",
"operationId": "users/delete-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
@@ -83373,7 +83378,7 @@
"tags": [
"apps"
],
"operationId": "apps/add-repo-to-installation",
"operationId": "apps/add-repo-to-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#add-a-repository-to-an-app-installation"
@@ -83458,7 +83463,7 @@
"tags": [
"apps"
],
"operationId": "apps/remove-repo-from-installation",
"operationId": "apps/remove-repo-from-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#remove-a-repository-from-an-app-installation"
@@ -83723,7 +83728,7 @@
"tags": [
"users"
],
"operationId": "users/list-public-ssh-keys-for-authenticated",
"operationId": "users/list-public-ssh-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
@@ -83791,7 +83796,7 @@
],
"summary": "Create a public SSH key for the authenticated user",
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
"operationId": "users/create-public-ssh-key-for-authenticated",
"operationId": "users/create-public-ssh-key-for-authenticated-user",
"tags": [
"users"
],
@@ -83938,7 +83943,7 @@
"tags": [
"users"
],
"operationId": "users/get-public-ssh-key-for-authenticated",
"operationId": "users/get-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
@@ -84020,7 +84025,7 @@
"tags": [
"users"
],
"operationId": "users/delete-public-ssh-key-for-authenticated",
"operationId": "users/delete-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
@@ -84632,7 +84637,7 @@
"tags": [
"users"
],
"operationId": "users/list-public-emails-for-authenticated",
"operationId": "users/list-public-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
@@ -85471,7 +85476,7 @@
"tags": [
"repos"
],
"operationId": "repos/accept-invitation",
"operationId": "repos/accept-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#accept-a-repository-invitation"
@@ -85552,7 +85557,7 @@
"tags": [
"repos"
],
"operationId": "repos/decline-invitation",
"operationId": "repos/decline-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#decline-a-repository-invitation"

162
lib/rest/static/decorated/github.ae.json
View File

@@ -38546,6 +38546,100 @@
}
]
},
{
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest",
"serverUrl": "https://{hostname}/api/v3",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "check_run_id",
"description": "check_run_id parameter",
"in": "path",
"required": true,
"schema": {
"type": "integer"
},
"descriptionHTML": "<p>check_run_id parameter</p>"
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42/rerequest",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42/rerequest</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest', {\n owner: 'octocat',\n repo: 'hello-world',\n check_run_id: 42\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">check_run_id</span>: <span class=\"hljs-number\">42</span>\n})\n</code></pre>"
}
],
"summary": "Rerequest a check run",
"description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.",
"tags": [
"checks"
],
"operationId": "checks/rerequest-run",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/checks#rerequest-a-check-run"
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"previews": [],
"category": "checks",
"subcategory": "runs"
},
"slug": "rerequest-a-check-run",
"category": "checks",
"categoryLabel": "Checks",
"subcategory": "runs",
"subcategoryLabel": "Runs",
"notes": [],
"responses": [
{
"httpStatusCode": "201",
"httpStatusMessage": "Created",
"description": "Response"
},
{
"httpStatusCode": "403",
"httpStatusMessage": "Forbidden",
"description": "Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App"
},
{
"httpStatusCode": "404",
"httpStatusMessage": "Not Found",
"description": "Resource not found"
},
{
"httpStatusCode": "422",
"httpStatusMessage": "Unprocessable Entity",
"description": "Validation error if the check run is not rerequestable"
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the <a href=\"https://docs.github.com/github-ae@latest/webhooks/event-payloads/#check_run\"><code>check_run</code> webhook</a> event with the action <code>rerequested</code>. When a check run is <code>rerequested</code>, its <code>status</code> is reset to <code>queued</code> and the <code>conclusion</code> is cleared.</p>\n<p>To rerequest a check run, your GitHub App must have the <code>checks:read</code> permission on a private repository or pull access to a public repository.</p>"
},
{
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/check-suites",
@@ -56940,13 +57034,13 @@
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'</code></pre>"
"source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('POST /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n source: {\n branch: 'branch',\n path: 'path'\n },\n mediaType: {\n previews: [\n 'switcheroo'\n ]\n }\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'POST /repos/{owner}/{repo}/pages'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">source</span>: {\n <span class=\"hljs-attr\">branch</span>: <span class=\"hljs-string\">'branch'</span>,\n <span class=\"hljs-attr\">path</span>: <span class=\"hljs-string\">'path'</span>\n },\n <span class=\"hljs-attr\">mediaType</span>: {\n <span class=\"hljs-attr\">previews</span>: [\n <span class=\"hljs-string\">'switcheroo'</span>\n ]\n }\n})\n</code></pre>"
"source": "await octokit.request('POST /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n source: {\n branch: 'branch',\n path: 'path'\n }\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'POST /repos/{owner}/{repo}/pages'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">source</span>: {\n <span class=\"hljs-attr\">branch</span>: <span class=\"hljs-string\">'branch'</span>,\n <span class=\"hljs-attr\">path</span>: <span class=\"hljs-string\">'path'</span>\n }\n})\n</code></pre>"
}
],
"summary": "Create a GitHub AE Pages site",
@@ -57053,14 +57147,6 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"previews": [
{
"required": true,
"name": "switcheroo",
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
"html": "<p>Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/\">blog post</a> preview for more details. To access the new endpoints during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.switcheroo-preview+json</code></pre>"
}
],
"category": "repos",
"subcategory": "pages"
},
@@ -57084,11 +57170,6 @@
"httpStatusMessage": "Conflict",
"description": "Conflict"
},
{
"httpStatusCode": "415",
"httpStatusMessage": "Unsupported Media Type",
"description": "Preview header missing"
},
{
"httpStatusCode": "422",
"httpStatusMessage": "Unprocessable Entity",
@@ -57451,13 +57532,13 @@
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/pages",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/pages</code></pre>"
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/pages",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/pages</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('DELETE /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'switcheroo'\n ]\n }\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'DELETE /repos/{owner}/{repo}/pages'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">mediaType</span>: {\n <span class=\"hljs-attr\">previews</span>: [\n <span class=\"hljs-string\">'switcheroo'</span>\n ]\n }\n})\n</code></pre>"
"source": "await octokit.request('DELETE /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'DELETE /repos/{owner}/{repo}/pages'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>\n})\n</code></pre>"
}
],
"summary": "Delete a GitHub AE Pages site",
@@ -57473,14 +57554,6 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"previews": [
{
"required": true,
"name": "switcheroo",
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
"html": "<p>Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/\">blog post</a> preview for more details. To access the new endpoints during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.switcheroo-preview+json</code></pre>"
}
],
"category": "repos",
"subcategory": "pages"
},
@@ -57501,11 +57574,6 @@
"httpStatusMessage": "Not Found",
"description": "Resource not found"
},
{
"httpStatusCode": "415",
"httpStatusMessage": "Unsupported Media Type",
"description": "Preview header missing"
},
{
"httpStatusCode": "422",
"httpStatusMessage": "Unprocessable Entity",
@@ -71924,7 +71992,7 @@
"tags": [
"users"
],
"operationId": "users/list-followed-by-authenticated",
"operationId": "users/list-followed-by-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#list-the-people-the-authenticated-user-follows"
@@ -72251,7 +72319,7 @@
"tags": [
"users"
],
"operationId": "users/list-gpg-keys-for-authenticated",
"operationId": "users/list-gpg-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
@@ -72319,7 +72387,7 @@
],
"summary": "Create a GPG key for the authenticated user",
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
"operationId": "users/create-gpg-key-for-authenticated",
"operationId": "users/create-gpg-key-for-authenticated-user",
"tags": [
"users"
],
@@ -72444,7 +72512,7 @@
"tags": [
"users"
],
"operationId": "users/get-gpg-key-for-authenticated",
"operationId": "users/get-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
@@ -72526,7 +72594,7 @@
"tags": [
"users"
],
"operationId": "users/delete-gpg-key-for-authenticated",
"operationId": "users/delete-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
@@ -72817,7 +72885,7 @@
"tags": [
"apps"
],
"operationId": "apps/add-repo-to-installation",
"operationId": "apps/add-repo-to-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/apps#add-a-repository-to-an-app-installation"
@@ -72902,7 +72970,7 @@
"tags": [
"apps"
],
"operationId": "apps/remove-repo-from-installation",
"operationId": "apps/remove-repo-from-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/apps#remove-a-repository-from-an-app-installation"
@@ -73154,7 +73222,7 @@
"tags": [
"users"
],
"operationId": "users/list-public-ssh-keys-for-authenticated",
"operationId": "users/list-public-ssh-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
@@ -73222,7 +73290,7 @@
],
"summary": "Create a public SSH key for the authenticated user",
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
"operationId": "users/create-public-ssh-key-for-authenticated",
"operationId": "users/create-public-ssh-key-for-authenticated-user",
"tags": [
"users"
],
@@ -73369,7 +73437,7 @@
"tags": [
"users"
],
"operationId": "users/get-public-ssh-key-for-authenticated",
"operationId": "users/get-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
@@ -73451,7 +73519,7 @@
"tags": [
"users"
],
"operationId": "users/delete-public-ssh-key-for-authenticated",
"operationId": "users/delete-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
@@ -74803,7 +74871,7 @@
"tags": [
"repos"
],
"operationId": "repos/accept-invitation",
"operationId": "repos/accept-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/repos#accept-a-repository-invitation"
@@ -74884,7 +74952,7 @@
"tags": [
"repos"
],
"operationId": "repos/decline-invitation",
"operationId": "repos/decline-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/repos#decline-a-repository-invitation"

274
lib/rest/static/dereferenced/api.github.com.deref.json
View File

@@ -93305,7 +93305,16 @@
{
"name": "secret_type",
"in": "query",
"description": "A comma separated list of secret types to return. By default all secret types are returned.",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "resolution",
"in": "query",
"description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.",
"required": false,
"schema": {
"type": "string"
@@ -166839,6 +166848,149 @@
}
}
},
"/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": {
"post": {
"summary": "Rerequest a check run",
"description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.",
"tags": [
"checks"
],
"operationId": "checks/rerequest-run",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/checks#rerequest-a-check-run"
},
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "check_run_id",
"description": "check_run_id parameter",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"201": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
},
"additionalProperties": false
}
}
}
},
"403": {
"description": "Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App",
"content": {
"application/json": {
"schema": {
"title": "Basic Error",
"description": "Basic Error",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"documentation_url": {
"type": "string"
},
"url": {
"type": "string"
},
"status": {
"type": "string"
}
}
}
}
}
},
"422": {
"description": "Validation error if the check run is not rerequestable",
"content": {
"application/json": {
"schema": {
"title": "Basic Error",
"description": "Basic Error",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"documentation_url": {
"type": "string"
},
"url": {
"type": "string"
},
"status": {
"type": "string"
}
}
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"title": "Basic Error",
"description": "Basic Error",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"documentation_url": {
"type": "string"
},
"url": {
"type": "string"
},
"status": {
"type": "string"
}
}
}
}
}
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"previews": [
],
"category": "checks",
"subcategory": "runs"
}
}
},
"/repos/{owner}/{repo}/check-suites": {
"post": {
"summary": "Create a check suite",
@@ -289620,28 +289772,6 @@
}
}
},
"415": {
"description": "Preview header missing",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"message",
"documentation_url"
],
"properties": {
"message": {
"type": "string"
},
"documentation_url": {
"type": "string"
}
}
}
}
}
},
"409": {
"description": "Conflict",
"content": {
@@ -289672,13 +289802,6 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"previews": [
{
"required": true,
"name": "switcheroo",
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
}
],
"category": "repos",
"subcategory": "pages"
}
@@ -290047,28 +290170,6 @@
}
}
},
"415": {
"description": "Preview header missing",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"message",
"documentation_url"
],
"properties": {
"message": {
"type": "string"
},
"documentation_url": {
"type": "string"
}
}
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
@@ -290099,13 +290200,6 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"previews": [
{
"required": true,
"name": "switcheroo",
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
}
],
"category": "repos",
"subcategory": "pages"
}
@@ -326539,6 +326633,11 @@
"discussion_category_name": {
"type": "string",
"description": "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see \"[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\""
},
"generate_release_notes": {
"type": "boolean",
"description": "Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes.",
"default": false
}
},
"required": [
@@ -326551,7 +326650,8 @@
"name": "v1.0.0",
"body": "Description of the release",
"draft": false,
"prerelease": false
"prerelease": false,
"generate_release_notes": false
}
}
}
@@ -331898,7 +331998,16 @@
{
"name": "secret_type",
"in": "query",
"description": "A comma separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
"description": "A comma-separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "resolution",
"in": "query",
"description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.",
"required": false,
"schema": {
"type": "string"
@@ -332467,6 +332576,9 @@
}
}
},
"304": {
"description": "Not modified"
},
"404": {
"description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found"
},
@@ -371171,7 +371283,7 @@
"tags": [
"users"
],
"operationId": "users/list-blocked-by-authenticated",
"operationId": "users/list-blocked-by-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#list-users-blocked-by-the-authenticated-user"
@@ -371879,7 +371991,7 @@
"tags": [
"users"
],
"operationId": "users/set-primary-email-visibility-for-authenticated",
"operationId": "users/set-primary-email-visibility-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user"
@@ -372133,7 +372245,7 @@
"tags": [
"users"
],
"operationId": "users/list-emails-for-authenticated",
"operationId": "users/list-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#list-email-addresses-for-the-authenticated-user"
@@ -372318,7 +372430,7 @@
"tags": [
"users"
],
"operationId": "users/add-email-for-authenticated",
"operationId": "users/add-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#add-an-email-address-for-the-authenticated-user"
@@ -372606,7 +372718,7 @@
"tags": [
"users"
],
"operationId": "users/delete-email-for-authenticated",
"operationId": "users/delete-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
@@ -373095,7 +373207,7 @@
"tags": [
"users"
],
"operationId": "users/list-followed-by-authenticated",
"operationId": "users/list-followed-by-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#list-the-people-the-authenticated-user-follows"
@@ -373711,7 +373823,7 @@
"tags": [
"users"
],
"operationId": "users/list-gpg-keys-for-authenticated",
"operationId": "users/list-gpg-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
@@ -374054,7 +374166,7 @@
"post": {
"summary": "Create a GPG key for the authenticated user",
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
"operationId": "users/create-gpg-key-for-authenticated",
"operationId": "users/create-gpg-key-for-authenticated-user",
"tags": [
"users"
],
@@ -374463,7 +374575,7 @@
"tags": [
"users"
],
"operationId": "users/get-gpg-key-for-authenticated",
"operationId": "users/get-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
@@ -374787,7 +374899,7 @@
"tags": [
"users"
],
"operationId": "users/delete-gpg-key-for-authenticated",
"operationId": "users/delete-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
@@ -377299,7 +377411,7 @@
"tags": [
"apps"
],
"operationId": "apps/add-repo-to-installation",
"operationId": "apps/add-repo-to-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/apps#add-a-repository-to-an-app-installation"
@@ -377399,7 +377511,7 @@
"tags": [
"apps"
],
"operationId": "apps/remove-repo-from-installation",
"operationId": "apps/remove-repo-from-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/apps#remove-a-repository-from-an-app-installation"
@@ -380539,7 +380651,7 @@
"tags": [
"users"
],
"operationId": "users/list-public-ssh-keys-for-authenticated",
"operationId": "users/list-public-ssh-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
@@ -380740,7 +380852,7 @@
"post": {
"summary": "Create a public SSH key for the authenticated user",
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
"operationId": "users/create-public-ssh-key-for-authenticated",
"operationId": "users/create-public-ssh-key-for-authenticated-user",
"tags": [
"users"
],
@@ -381004,7 +381116,7 @@
"tags": [
"users"
],
"operationId": "users/get-public-ssh-key-for-authenticated",
"operationId": "users/get-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
@@ -381177,7 +381289,7 @@
"tags": [
"users"
],
"operationId": "users/delete-public-ssh-key-for-authenticated",
"operationId": "users/delete-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
@@ -388520,7 +388632,7 @@
"tags": [
"migrations"
],
"operationId": "migrations/list-repos-for-user",
"operationId": "migrations/list-repos-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/migrations#list-repositories-for-a-user-migration"
@@ -396214,7 +396326,7 @@
"tags": [
"users"
],
"operationId": "users/list-public-emails-for-authenticated",
"operationId": "users/list-public-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
@@ -401721,7 +401833,7 @@
"tags": [
"repos"
],
"operationId": "repos/accept-invitation",
"operationId": "repos/accept-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/repos#accept-a-repository-invitation"
@@ -401839,7 +401951,7 @@
"tags": [
"repos"
],
"operationId": "repos/decline-invitation",
"operationId": "repos/decline-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/repos#decline-a-repository-invitation"

128
lib/rest/static/dereferenced/ghes-2.22.deref.json
View File

@@ -22174,7 +22174,7 @@
"/enterprises/{enterprise}/actions/runner-groups": {
"get": {
"summary": "List self-hosted runner groups for an enterprise",
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-self-hosted-runner-groups-for-enterprise",
"tags": [
"enterprise-admin"
@@ -22316,7 +22316,7 @@
},
"post": {
"summary": "Create a self-hosted runner group for an enterprise",
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/create-self-hosted-runner-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -22461,7 +22461,7 @@
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": {
"get": {
"summary": "Get a self-hosted runner group for an enterprise",
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/get-self-hosted-runner-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -22558,7 +22558,7 @@
},
"patch": {
"summary": "Update a self-hosted runner group for an enterprise",
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/update-self-hosted-runner-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -22683,7 +22683,7 @@
},
"delete": {
"summary": "Delete a self-hosted runner group from an enterprise",
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/delete-self-hosted-runner-group-from-enterprise",
"tags": [
"enterprise-admin"
@@ -22731,7 +22731,7 @@
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": {
"get": {
"summary": "List organization access to a self-hosted runner group in an enterprise",
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -22910,7 +22910,7 @@
},
"put": {
"summary": "Set organization access for a self-hosted runner group in an enterprise",
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -22987,7 +22987,7 @@
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": {
"put": {
"summary": "Add organization access to a self-hosted runner group in an enterprise",
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -23042,7 +23042,7 @@
},
"delete": {
"summary": "Remove organization access to a self-hosted runner group in an enterprise",
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -23099,7 +23099,7 @@
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": {
"get": {
"summary": "List self-hosted runners in a group for an enterprise",
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -23233,7 +23233,7 @@
},
"put": {
"summary": "Set self-hosted runners in a group for an enterprise",
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -23310,7 +23310,7 @@
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": {
"put": {
"summary": "Add a self-hosted runner to a group for an enterprise",
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise`\nscope to use this endpoint.",
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise`\nscope to use this endpoint.",
"operationId": "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -23365,7 +23365,7 @@
},
"delete": {
"summary": "Remove a self-hosted runner from a group for an enterprise",
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -23422,7 +23422,7 @@
"/enterprises/{enterprise}/actions/runners": {
"get": {
"summary": "List self-hosted runners for an enterprise",
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-self-hosted-runners-for-enterprise",
"tags": [
"enterprise-admin"
@@ -23545,7 +23545,7 @@
"/enterprises/{enterprise}/actions/runners/downloads": {
"get": {
"summary": "List runner applications for an enterprise",
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-runner-applications-for-enterprise",
"tags": [
"enterprise-admin"
@@ -23659,7 +23659,7 @@
"/enterprises/{enterprise}/actions/runners/registration-token": {
"post": {
"summary": "Create a registration token for an enterprise",
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
"operationId": "enterprise-admin/create-registration-token-for-enterprise",
"tags": [
"enterprise-admin"
@@ -24846,7 +24846,7 @@
"/enterprises/{enterprise}/actions/runners/remove-token": {
"post": {
"summary": "Create a remove token for an enterprise",
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
"operationId": "enterprise-admin/create-remove-token-for-enterprise",
"tags": [
"enterprise-admin"
@@ -26033,7 +26033,7 @@
"/enterprises/{enterprise}/actions/runners/{runner_id}": {
"get": {
"summary": "Get a self-hosted runner for an enterprise",
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/get-self-hosted-runner-for-enterprise",
"tags": [
"enterprise-admin"
@@ -26114,7 +26114,7 @@
},
"delete": {
"summary": "Delete a self-hosted runner from an enterprise",
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/delete-self-hosted-runner-from-enterprise",
"tags": [
"enterprise-admin"
@@ -254238,28 +254238,6 @@
}
}
},
"415": {
"description": "Preview header missing",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"message",
"documentation_url"
],
"properties": {
"message": {
"type": "string"
},
"documentation_url": {
"type": "string"
}
}
}
}
}
},
"409": {
"description": "Conflict",
"content": {
@@ -254290,15 +254268,15 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "repos",
"subcategory": "pages",
"previews": [
{
"required": true,
"name": "switcheroo",
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
}
],
"category": "repos",
"subcategory": "pages"
]
}
},
"put": {
@@ -254665,28 +254643,6 @@
}
}
},
"415": {
"description": "Preview header missing",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"message",
"documentation_url"
],
"properties": {
"message": {
"type": "string"
},
"documentation_url": {
"type": "string"
}
}
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
@@ -254717,15 +254673,15 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "repos",
"subcategory": "pages",
"previews": [
{
"required": true,
"name": "switcheroo",
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
}
],
"category": "repos",
"subcategory": "pages"
]
}
}
},
@@ -326901,7 +326857,7 @@
"tags": [
"users"
],
"operationId": "users/list-emails-for-authenticated",
"operationId": "users/list-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#list-email-addresses-for-the-authenticated-user"
@@ -327086,7 +327042,7 @@
"tags": [
"users"
],
"operationId": "users/add-email-for-authenticated",
"operationId": "users/add-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#add-an-email-address-for-the-authenticated-user"
@@ -327374,7 +327330,7 @@
"tags": [
"users"
],
"operationId": "users/delete-email-for-authenticated",
"operationId": "users/delete-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
@@ -327863,7 +327819,7 @@
"tags": [
"users"
],
"operationId": "users/list-followed-by-authenticated",
"operationId": "users/list-followed-by-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#list-the-people-the-authenticated-user-follows"
@@ -328479,7 +328435,7 @@
"tags": [
"users"
],
"operationId": "users/list-gpg-keys-for-authenticated",
"operationId": "users/list-gpg-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
@@ -328822,7 +328778,7 @@
"post": {
"summary": "Create a GPG key for the authenticated user",
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
"operationId": "users/create-gpg-key-for-authenticated",
"operationId": "users/create-gpg-key-for-authenticated-user",
"tags": [
"users"
],
@@ -329231,7 +329187,7 @@
"tags": [
"users"
],
"operationId": "users/get-gpg-key-for-authenticated",
"operationId": "users/get-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
@@ -329555,7 +329511,7 @@
"tags": [
"users"
],
"operationId": "users/delete-gpg-key-for-authenticated",
"operationId": "users/delete-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
@@ -331802,7 +331758,7 @@
"tags": [
"apps"
],
"operationId": "apps/add-repo-to-installation",
"operationId": "apps/add-repo-to-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/apps#add-a-repository-to-an-app-installation"
@@ -331902,7 +331858,7 @@
"tags": [
"apps"
],
"operationId": "apps/remove-repo-from-installation",
"operationId": "apps/remove-repo-from-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/apps#remove-a-repository-from-an-app-installation"
@@ -334754,7 +334710,7 @@
"tags": [
"users"
],
"operationId": "users/list-public-ssh-keys-for-authenticated",
"operationId": "users/list-public-ssh-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
@@ -334955,7 +334911,7 @@
"post": {
"summary": "Create a public SSH key for the authenticated user",
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
"operationId": "users/create-public-ssh-key-for-authenticated",
"operationId": "users/create-public-ssh-key-for-authenticated-user",
"tags": [
"users"
],
@@ -335219,7 +335175,7 @@
"tags": [
"users"
],
"operationId": "users/get-public-ssh-key-for-authenticated",
"operationId": "users/get-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
@@ -335392,7 +335348,7 @@
"tags": [
"users"
],
"operationId": "users/delete-public-ssh-key-for-authenticated",
"operationId": "users/delete-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
@@ -337544,7 +337500,7 @@
"tags": [
"users"
],
"operationId": "users/list-public-emails-for-authenticated",
"operationId": "users/list-public-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
@@ -343017,7 +342973,7 @@
"tags": [
"repos"
],
"operationId": "repos/accept-invitation",
"operationId": "repos/accept-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#accept-a-repository-invitation"
@@ -343135,7 +343091,7 @@
"tags": [
"repos"
],
"operationId": "repos/decline-invitation",
"operationId": "repos/decline-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#decline-a-repository-invitation"

128
lib/rest/static/dereferenced/ghes-3.0.deref.json
View File

@@ -24888,7 +24888,7 @@
"/enterprises/{enterprise}/actions/runner-groups": {
"get": {
"summary": "List self-hosted runner groups for an enterprise",
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-self-hosted-runner-groups-for-enterprise",
"tags": [
"enterprise-admin"
@@ -25030,7 +25030,7 @@
},
"post": {
"summary": "Create a self-hosted runner group for an enterprise",
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/create-self-hosted-runner-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -25175,7 +25175,7 @@
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": {
"get": {
"summary": "Get a self-hosted runner group for an enterprise",
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/get-self-hosted-runner-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -25272,7 +25272,7 @@
},
"patch": {
"summary": "Update a self-hosted runner group for an enterprise",
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/update-self-hosted-runner-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -25397,7 +25397,7 @@
},
"delete": {
"summary": "Delete a self-hosted runner group from an enterprise",
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/delete-self-hosted-runner-group-from-enterprise",
"tags": [
"enterprise-admin"
@@ -25445,7 +25445,7 @@
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": {
"get": {
"summary": "List organization access to a self-hosted runner group in an enterprise",
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -25624,7 +25624,7 @@
},
"put": {
"summary": "Set organization access for a self-hosted runner group in an enterprise",
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -25701,7 +25701,7 @@
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": {
"put": {
"summary": "Add organization access to a self-hosted runner group in an enterprise",
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -25756,7 +25756,7 @@
},
"delete": {
"summary": "Remove organization access to a self-hosted runner group in an enterprise",
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -25813,7 +25813,7 @@
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": {
"get": {
"summary": "List self-hosted runners in a group for an enterprise",
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -26028,7 +26028,7 @@
},
"put": {
"summary": "Set self-hosted runners in a group for an enterprise",
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -26105,7 +26105,7 @@
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": {
"put": {
"summary": "Add a self-hosted runner to a group for an enterprise",
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise`\nscope to use this endpoint.",
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise`\nscope to use this endpoint.",
"operationId": "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -26160,7 +26160,7 @@
},
"delete": {
"summary": "Remove a self-hosted runner from a group for an enterprise",
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -26217,7 +26217,7 @@
"/enterprises/{enterprise}/actions/runners": {
"get": {
"summary": "List self-hosted runners for an enterprise",
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-self-hosted-runners-for-enterprise",
"tags": [
"enterprise-admin"
@@ -26421,7 +26421,7 @@
"/enterprises/{enterprise}/actions/runners/downloads": {
"get": {
"summary": "List runner applications for an enterprise",
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-runner-applications-for-enterprise",
"tags": [
"enterprise-admin"
@@ -26535,7 +26535,7 @@
"/enterprises/{enterprise}/actions/runners/registration-token": {
"post": {
"summary": "Create a registration token for an enterprise",
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
"operationId": "enterprise-admin/create-registration-token-for-enterprise",
"tags": [
"enterprise-admin"
@@ -27722,7 +27722,7 @@
"/enterprises/{enterprise}/actions/runners/remove-token": {
"post": {
"summary": "Create a remove token for an enterprise",
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
"operationId": "enterprise-admin/create-remove-token-for-enterprise",
"tags": [
"enterprise-admin"
@@ -28909,7 +28909,7 @@
"/enterprises/{enterprise}/actions/runners/{runner_id}": {
"get": {
"summary": "Get a self-hosted runner for an enterprise",
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/get-self-hosted-runner-for-enterprise",
"tags": [
"enterprise-admin"
@@ -29054,7 +29054,7 @@
},
"delete": {
"summary": "Delete a self-hosted runner from an enterprise",
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/delete-self-hosted-runner-from-enterprise",
"tags": [
"enterprise-admin"
@@ -261079,28 +261079,6 @@
}
}
},
"415": {
"description": "Preview header missing",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"message",
"documentation_url"
],
"properties": {
"message": {
"type": "string"
},
"documentation_url": {
"type": "string"
}
}
}
}
}
},
"409": {
"description": "Conflict",
"content": {
@@ -261131,15 +261109,15 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "repos",
"subcategory": "pages",
"previews": [
{
"required": true,
"name": "switcheroo",
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
}
],
"category": "repos",
"subcategory": "pages"
]
}
},
"put": {
@@ -261506,28 +261484,6 @@
}
}
},
"415": {
"description": "Preview header missing",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"message",
"documentation_url"
],
"properties": {
"message": {
"type": "string"
},
"documentation_url": {
"type": "string"
}
}
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
@@ -261558,15 +261514,15 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "repos",
"subcategory": "pages",
"previews": [
{
"required": true,
"name": "switcheroo",
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
}
],
"category": "repos",
"subcategory": "pages"
]
}
}
},
@@ -333742,7 +333698,7 @@
"tags": [
"users"
],
"operationId": "users/list-emails-for-authenticated",
"operationId": "users/list-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-email-addresses-for-the-authenticated-user"
@@ -333927,7 +333883,7 @@
"tags": [
"users"
],
"operationId": "users/add-email-for-authenticated",
"operationId": "users/add-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#add-an-email-address-for-the-authenticated-user"
@@ -334215,7 +334171,7 @@
"tags": [
"users"
],
"operationId": "users/delete-email-for-authenticated",
"operationId": "users/delete-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
@@ -334704,7 +334660,7 @@
"tags": [
"users"
],
"operationId": "users/list-followed-by-authenticated",
"operationId": "users/list-followed-by-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-the-people-the-authenticated-user-follows"
@@ -335320,7 +335276,7 @@
"tags": [
"users"
],
"operationId": "users/list-gpg-keys-for-authenticated",
"operationId": "users/list-gpg-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
@@ -335663,7 +335619,7 @@
"post": {
"summary": "Create a GPG key for the authenticated user",
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
"operationId": "users/create-gpg-key-for-authenticated",
"operationId": "users/create-gpg-key-for-authenticated-user",
"tags": [
"users"
],
@@ -336072,7 +336028,7 @@
"tags": [
"users"
],
"operationId": "users/get-gpg-key-for-authenticated",
"operationId": "users/get-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
@@ -336396,7 +336352,7 @@
"tags": [
"users"
],
"operationId": "users/delete-gpg-key-for-authenticated",
"operationId": "users/delete-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
@@ -338898,7 +338854,7 @@
"tags": [
"apps"
],
"operationId": "apps/add-repo-to-installation",
"operationId": "apps/add-repo-to-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#add-a-repository-to-an-app-installation"
@@ -338998,7 +338954,7 @@
"tags": [
"apps"
],
"operationId": "apps/remove-repo-from-installation",
"operationId": "apps/remove-repo-from-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#remove-a-repository-from-an-app-installation"
@@ -341850,7 +341806,7 @@
"tags": [
"users"
],
"operationId": "users/list-public-ssh-keys-for-authenticated",
"operationId": "users/list-public-ssh-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
@@ -342051,7 +342007,7 @@
"post": {
"summary": "Create a public SSH key for the authenticated user",
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
"operationId": "users/create-public-ssh-key-for-authenticated",
"operationId": "users/create-public-ssh-key-for-authenticated-user",
"tags": [
"users"
],
@@ -342315,7 +342271,7 @@
"tags": [
"users"
],
"operationId": "users/get-public-ssh-key-for-authenticated",
"operationId": "users/get-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
@@ -342488,7 +342444,7 @@
"tags": [
"users"
],
"operationId": "users/delete-public-ssh-key-for-authenticated",
"operationId": "users/delete-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
@@ -344640,7 +344596,7 @@
"tags": [
"users"
],
"operationId": "users/list-public-emails-for-authenticated",
"operationId": "users/list-public-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
@@ -350113,7 +350069,7 @@
"tags": [
"repos"
],
"operationId": "repos/accept-invitation",
"operationId": "repos/accept-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#accept-a-repository-invitation"
@@ -350231,7 +350187,7 @@
"tags": [
"repos"
],
"operationId": "repos/decline-invitation",
"operationId": "repos/decline-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#decline-a-repository-invitation"

142
lib/rest/static/dereferenced/ghes-3.1.deref.json
View File

@@ -24888,7 +24888,7 @@
"/enterprises/{enterprise}/actions/runner-groups": {
"get": {
"summary": "List self-hosted runner groups for an enterprise",
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-self-hosted-runner-groups-for-enterprise",
"tags": [
"enterprise-admin"
@@ -25030,7 +25030,7 @@
},
"post": {
"summary": "Create a self-hosted runner group for an enterprise",
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/create-self-hosted-runner-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -25175,7 +25175,7 @@
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": {
"get": {
"summary": "Get a self-hosted runner group for an enterprise",
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/get-self-hosted-runner-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -25272,7 +25272,7 @@
},
"patch": {
"summary": "Update a self-hosted runner group for an enterprise",
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/update-self-hosted-runner-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -25397,7 +25397,7 @@
},
"delete": {
"summary": "Delete a self-hosted runner group from an enterprise",
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/delete-self-hosted-runner-group-from-enterprise",
"tags": [
"enterprise-admin"
@@ -25445,7 +25445,7 @@
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": {
"get": {
"summary": "List organization access to a self-hosted runner group in an enterprise",
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -25624,7 +25624,7 @@
},
"put": {
"summary": "Set organization access for a self-hosted runner group in an enterprise",
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -25701,7 +25701,7 @@
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": {
"put": {
"summary": "Add organization access to a self-hosted runner group in an enterprise",
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -25756,7 +25756,7 @@
},
"delete": {
"summary": "Remove organization access to a self-hosted runner group in an enterprise",
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -25813,7 +25813,7 @@
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": {
"get": {
"summary": "List self-hosted runners in a group for an enterprise",
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -26028,7 +26028,7 @@
},
"put": {
"summary": "Set self-hosted runners in a group for an enterprise",
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -26105,7 +26105,7 @@
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": {
"put": {
"summary": "Add a self-hosted runner to a group for an enterprise",
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise`\nscope to use this endpoint.",
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise`\nscope to use this endpoint.",
"operationId": "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -26160,7 +26160,7 @@
},
"delete": {
"summary": "Remove a self-hosted runner from a group for an enterprise",
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -26217,7 +26217,7 @@
"/enterprises/{enterprise}/actions/runners": {
"get": {
"summary": "List self-hosted runners for an enterprise",
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-self-hosted-runners-for-enterprise",
"tags": [
"enterprise-admin"
@@ -26421,7 +26421,7 @@
"/enterprises/{enterprise}/actions/runners/downloads": {
"get": {
"summary": "List runner applications for an enterprise",
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-runner-applications-for-enterprise",
"tags": [
"enterprise-admin"
@@ -26535,7 +26535,7 @@
"/enterprises/{enterprise}/actions/runners/registration-token": {
"post": {
"summary": "Create a registration token for an enterprise",
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
"operationId": "enterprise-admin/create-registration-token-for-enterprise",
"tags": [
"enterprise-admin"
@@ -27722,7 +27722,7 @@
"/enterprises/{enterprise}/actions/runners/remove-token": {
"post": {
"summary": "Create a remove token for an enterprise",
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
"operationId": "enterprise-admin/create-remove-token-for-enterprise",
"tags": [
"enterprise-admin"
@@ -28909,7 +28909,7 @@
"/enterprises/{enterprise}/actions/runners/{runner_id}": {
"get": {
"summary": "Get a self-hosted runner for an enterprise",
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/get-self-hosted-runner-for-enterprise",
"tags": [
"enterprise-admin"
@@ -29054,7 +29054,7 @@
},
"delete": {
"summary": "Delete a self-hosted runner from an enterprise",
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/delete-self-hosted-runner-from-enterprise",
"tags": [
"enterprise-admin"
@@ -264056,28 +264056,6 @@
}
}
},
"415": {
"description": "Preview header missing",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"message",
"documentation_url"
],
"properties": {
"message": {
"type": "string"
},
"documentation_url": {
"type": "string"
}
}
}
}
}
},
"409": {
"description": "Conflict",
"content": {
@@ -264108,15 +264086,15 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "repos",
"subcategory": "pages",
"previews": [
{
"required": true,
"name": "switcheroo",
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
}
],
"category": "repos",
"subcategory": "pages"
]
}
},
"put": {
@@ -264483,28 +264461,6 @@
}
}
},
"415": {
"description": "Preview header missing",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"message",
"documentation_url"
],
"properties": {
"message": {
"type": "string"
},
"documentation_url": {
"type": "string"
}
}
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
@@ -264535,15 +264491,15 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "repos",
"subcategory": "pages",
"previews": [
{
"required": true,
"name": "switcheroo",
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
}
],
"category": "repos",
"subcategory": "pages"
]
}
}
},
@@ -305551,7 +305507,16 @@
{
"name": "secret_type",
"in": "query",
"description": "A comma separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.1/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
"description": "A comma-separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.1/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "resolution",
"in": "query",
"description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.",
"required": false,
"schema": {
"type": "string"
@@ -306120,6 +306085,9 @@
}
}
},
"304": {
"description": "Not modified"
},
"404": {
"description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found"
},
@@ -338294,7 +338262,7 @@
"tags": [
"users"
],
"operationId": "users/list-emails-for-authenticated",
"operationId": "users/list-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#list-email-addresses-for-the-authenticated-user"
@@ -338479,7 +338447,7 @@
"tags": [
"users"
],
"operationId": "users/add-email-for-authenticated",
"operationId": "users/add-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#add-an-email-address-for-the-authenticated-user"
@@ -338767,7 +338735,7 @@
"tags": [
"users"
],
"operationId": "users/delete-email-for-authenticated",
"operationId": "users/delete-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
@@ -339256,7 +339224,7 @@
"tags": [
"users"
],
"operationId": "users/list-followed-by-authenticated",
"operationId": "users/list-followed-by-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#list-the-people-the-authenticated-user-follows"
@@ -339872,7 +339840,7 @@
"tags": [
"users"
],
"operationId": "users/list-gpg-keys-for-authenticated",
"operationId": "users/list-gpg-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
@@ -340215,7 +340183,7 @@
"post": {
"summary": "Create a GPG key for the authenticated user",
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/enterprise-server@3.1/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
"operationId": "users/create-gpg-key-for-authenticated",
"operationId": "users/create-gpg-key-for-authenticated-user",
"tags": [
"users"
],
@@ -340624,7 +340592,7 @@
"tags": [
"users"
],
"operationId": "users/get-gpg-key-for-authenticated",
"operationId": "users/get-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
@@ -340948,7 +340916,7 @@
"tags": [
"users"
],
"operationId": "users/delete-gpg-key-for-authenticated",
"operationId": "users/delete-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
@@ -343450,7 +343418,7 @@
"tags": [
"apps"
],
"operationId": "apps/add-repo-to-installation",
"operationId": "apps/add-repo-to-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/apps#add-a-repository-to-an-app-installation"
@@ -343550,7 +343518,7 @@
"tags": [
"apps"
],
"operationId": "apps/remove-repo-from-installation",
"operationId": "apps/remove-repo-from-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/apps#remove-a-repository-from-an-app-installation"
@@ -346402,7 +346370,7 @@
"tags": [
"users"
],
"operationId": "users/list-public-ssh-keys-for-authenticated",
"operationId": "users/list-public-ssh-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
@@ -346603,7 +346571,7 @@
"post": {
"summary": "Create a public SSH key for the authenticated user",
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/enterprise-server@3.1/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
"operationId": "users/create-public-ssh-key-for-authenticated",
"operationId": "users/create-public-ssh-key-for-authenticated-user",
"tags": [
"users"
],
@@ -346867,7 +346835,7 @@
"tags": [
"users"
],
"operationId": "users/get-public-ssh-key-for-authenticated",
"operationId": "users/get-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
@@ -347040,7 +347008,7 @@
"tags": [
"users"
],
"operationId": "users/delete-public-ssh-key-for-authenticated",
"operationId": "users/delete-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
@@ -349192,7 +349160,7 @@
"tags": [
"users"
],
"operationId": "users/list-public-emails-for-authenticated",
"operationId": "users/list-public-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
@@ -354665,7 +354633,7 @@
"tags": [
"repos"
],
"operationId": "repos/accept-invitation",
"operationId": "repos/accept-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/repos#accept-a-repository-invitation"
@@ -354783,7 +354751,7 @@
"tags": [
"repos"
],
"operationId": "repos/decline-invitation",
"operationId": "repos/decline-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/repos#decline-a-repository-invitation"

142
lib/rest/static/dereferenced/ghes-3.2.deref.json
View File

@@ -25796,7 +25796,7 @@
"/enterprises/{enterprise}/actions/runner-groups": {
"get": {
"summary": "List self-hosted runner groups for an enterprise",
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-self-hosted-runner-groups-for-enterprise",
"tags": [
"enterprise-admin"
@@ -25938,7 +25938,7 @@
},
"post": {
"summary": "Create a self-hosted runner group for an enterprise",
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/create-self-hosted-runner-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -26083,7 +26083,7 @@
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": {
"get": {
"summary": "Get a self-hosted runner group for an enterprise",
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/get-self-hosted-runner-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -26180,7 +26180,7 @@
},
"patch": {
"summary": "Update a self-hosted runner group for an enterprise",
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/update-self-hosted-runner-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -26305,7 +26305,7 @@
},
"delete": {
"summary": "Delete a self-hosted runner group from an enterprise",
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/delete-self-hosted-runner-group-from-enterprise",
"tags": [
"enterprise-admin"
@@ -26353,7 +26353,7 @@
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": {
"get": {
"summary": "List organization access to a self-hosted runner group in an enterprise",
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -26532,7 +26532,7 @@
},
"put": {
"summary": "Set organization access for a self-hosted runner group in an enterprise",
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -26609,7 +26609,7 @@
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": {
"put": {
"summary": "Add organization access to a self-hosted runner group in an enterprise",
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -26664,7 +26664,7 @@
},
"delete": {
"summary": "Remove organization access to a self-hosted runner group in an enterprise",
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise",
"tags": [
"enterprise-admin"
@@ -26721,7 +26721,7 @@
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": {
"get": {
"summary": "List self-hosted runners in a group for an enterprise",
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -26936,7 +26936,7 @@
},
"put": {
"summary": "Set self-hosted runners in a group for an enterprise",
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -27013,7 +27013,7 @@
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": {
"put": {
"summary": "Add a self-hosted runner to a group for an enterprise",
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise`\nscope to use this endpoint.",
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise`\nscope to use this endpoint.",
"operationId": "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -27068,7 +27068,7 @@
},
"delete": {
"summary": "Remove a self-hosted runner from a group for an enterprise",
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -27125,7 +27125,7 @@
"/enterprises/{enterprise}/actions/runners": {
"get": {
"summary": "List self-hosted runners for an enterprise",
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-self-hosted-runners-for-enterprise",
"tags": [
"enterprise-admin"
@@ -27329,7 +27329,7 @@
"/enterprises/{enterprise}/actions/runners/downloads": {
"get": {
"summary": "List runner applications for an enterprise",
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/list-runner-applications-for-enterprise",
"tags": [
"enterprise-admin"
@@ -27453,7 +27453,7 @@
"/enterprises/{enterprise}/actions/runners/registration-token": {
"post": {
"summary": "Create a registration token for an enterprise",
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
"operationId": "enterprise-admin/create-registration-token-for-enterprise",
"tags": [
"enterprise-admin"
@@ -28649,7 +28649,7 @@
"/enterprises/{enterprise}/actions/runners/remove-token": {
"post": {
"summary": "Create a remove token for an enterprise",
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
"operationId": "enterprise-admin/create-remove-token-for-enterprise",
"tags": [
"enterprise-admin"
@@ -29845,7 +29845,7 @@
"/enterprises/{enterprise}/actions/runners/{runner_id}": {
"get": {
"summary": "Get a self-hosted runner for an enterprise",
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/get-self-hosted-runner-for-enterprise",
"tags": [
"enterprise-admin"
@@ -29990,7 +29990,7 @@
},
"delete": {
"summary": "Delete a self-hosted runner from an enterprise",
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/delete-self-hosted-runner-from-enterprise",
"tags": [
"enterprise-admin"
@@ -270869,28 +270869,6 @@
}
}
},
"415": {
"description": "Preview header missing",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"message",
"documentation_url"
],
"properties": {
"message": {
"type": "string"
},
"documentation_url": {
"type": "string"
}
}
}
}
}
},
"409": {
"description": "Conflict",
"content": {
@@ -270921,15 +270899,15 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "repos",
"subcategory": "pages",
"previews": [
{
"required": true,
"name": "switcheroo",
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
}
],
"category": "repos",
"subcategory": "pages"
]
}
},
"put": {
@@ -271296,28 +271274,6 @@
}
}
},
"415": {
"description": "Preview header missing",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"message",
"documentation_url"
],
"properties": {
"message": {
"type": "string"
},
"documentation_url": {
"type": "string"
}
}
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
@@ -271348,15 +271304,15 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "repos",
"subcategory": "pages",
"previews": [
{
"required": true,
"name": "switcheroo",
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
}
],
"category": "repos",
"subcategory": "pages"
]
}
}
},
@@ -312997,7 +312953,16 @@
{
"name": "secret_type",
"in": "query",
"description": "A comma separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.2/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
"description": "A comma-separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.2/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "resolution",
"in": "query",
"description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.",
"required": false,
"schema": {
"type": "string"
@@ -313566,6 +313531,9 @@
}
}
},
"304": {
"description": "Not modified"
},
"404": {
"description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found"
},
@@ -346307,7 +346275,7 @@
"tags": [
"users"
],
"operationId": "users/list-emails-for-authenticated",
"operationId": "users/list-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-email-addresses-for-the-authenticated-user"
@@ -346492,7 +346460,7 @@
"tags": [
"users"
],
"operationId": "users/add-email-for-authenticated",
"operationId": "users/add-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#add-an-email-address-for-the-authenticated-user"
@@ -346780,7 +346748,7 @@
"tags": [
"users"
],
"operationId": "users/delete-email-for-authenticated",
"operationId": "users/delete-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
@@ -347269,7 +347237,7 @@
"tags": [
"users"
],
"operationId": "users/list-followed-by-authenticated",
"operationId": "users/list-followed-by-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-the-people-the-authenticated-user-follows"
@@ -347885,7 +347853,7 @@
"tags": [
"users"
],
"operationId": "users/list-gpg-keys-for-authenticated",
"operationId": "users/list-gpg-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
@@ -348228,7 +348196,7 @@
"post": {
"summary": "Create a GPG key for the authenticated user",
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
"operationId": "users/create-gpg-key-for-authenticated",
"operationId": "users/create-gpg-key-for-authenticated-user",
"tags": [
"users"
],
@@ -348637,7 +348605,7 @@
"tags": [
"users"
],
"operationId": "users/get-gpg-key-for-authenticated",
"operationId": "users/get-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
@@ -348961,7 +348929,7 @@
"tags": [
"users"
],
"operationId": "users/delete-gpg-key-for-authenticated",
"operationId": "users/delete-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
@@ -351473,7 +351441,7 @@
"tags": [
"apps"
],
"operationId": "apps/add-repo-to-installation",
"operationId": "apps/add-repo-to-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#add-a-repository-to-an-app-installation"
@@ -351573,7 +351541,7 @@
"tags": [
"apps"
],
"operationId": "apps/remove-repo-from-installation",
"operationId": "apps/remove-repo-from-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#remove-a-repository-from-an-app-installation"
@@ -354435,7 +354403,7 @@
"tags": [
"users"
],
"operationId": "users/list-public-ssh-keys-for-authenticated",
"operationId": "users/list-public-ssh-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
@@ -354636,7 +354604,7 @@
"post": {
"summary": "Create a public SSH key for the authenticated user",
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
"operationId": "users/create-public-ssh-key-for-authenticated",
"operationId": "users/create-public-ssh-key-for-authenticated-user",
"tags": [
"users"
],
@@ -354900,7 +354868,7 @@
"tags": [
"users"
],
"operationId": "users/get-public-ssh-key-for-authenticated",
"operationId": "users/get-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
@@ -355073,7 +355041,7 @@
"tags": [
"users"
],
"operationId": "users/delete-public-ssh-key-for-authenticated",
"operationId": "users/delete-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
@@ -357225,7 +357193,7 @@
"tags": [
"users"
],
"operationId": "users/list-public-emails-for-authenticated",
"operationId": "users/list-public-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
@@ -362732,7 +362700,7 @@
"tags": [
"repos"
],
"operationId": "repos/accept-invitation",
"operationId": "repos/accept-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#accept-a-repository-invitation"
@@ -362850,7 +362818,7 @@
"tags": [
"repos"
],
"operationId": "repos/decline-invitation",
"operationId": "repos/decline-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#decline-a-repository-invitation"

227
lib/rest/static/dereferenced/github.ae.deref.json
View File

@@ -119420,6 +119420,149 @@
}
}
},
"/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": {
"post": {
"summary": "Rerequest a check run",
"description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.",
"tags": [
"checks"
],
"operationId": "checks/rerequest-run",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/checks#rerequest-a-check-run"
},
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "check_run_id",
"description": "check_run_id parameter",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"201": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
},
"additionalProperties": false
}
}
}
},
"403": {
"description": "Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App",
"content": {
"application/json": {
"schema": {
"title": "Basic Error",
"description": "Basic Error",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"documentation_url": {
"type": "string"
},
"url": {
"type": "string"
},
"status": {
"type": "string"
}
}
}
}
}
},
"422": {
"description": "Validation error if the check run is not rerequestable",
"content": {
"application/json": {
"schema": {
"title": "Basic Error",
"description": "Basic Error",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"documentation_url": {
"type": "string"
},
"url": {
"type": "string"
},
"status": {
"type": "string"
}
}
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"title": "Basic Error",
"description": "Basic Error",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"documentation_url": {
"type": "string"
},
"url": {
"type": "string"
},
"status": {
"type": "string"
}
}
}
}
}
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"previews": [
],
"category": "checks",
"subcategory": "runs"
}
}
},
"/repos/{owner}/{repo}/check-suites": {
"post": {
"summary": "Create a check suite",
@@ -237643,28 +237786,6 @@
}
}
},
"415": {
"description": "Preview header missing",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"message",
"documentation_url"
],
"properties": {
"message": {
"type": "string"
},
"documentation_url": {
"type": "string"
}
}
}
}
}
},
"409": {
"description": "Conflict",
"content": {
@@ -237695,13 +237816,6 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"previews": [
{
"required": true,
"name": "switcheroo",
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
}
],
"category": "repos",
"subcategory": "pages"
}
@@ -238070,28 +238184,6 @@
}
}
},
"415": {
"description": "Preview header missing",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"message",
"documentation_url"
],
"properties": {
"message": {
"type": "string"
},
"documentation_url": {
"type": "string"
}
}
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
@@ -238122,13 +238214,6 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"previews": [
{
"required": true,
"name": "switcheroo",
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
}
],
"category": "repos",
"subcategory": "pages"
}
@@ -309534,7 +309619,7 @@
"tags": [
"users"
],
"operationId": "users/list-followed-by-authenticated",
"operationId": "users/list-followed-by-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#list-the-people-the-authenticated-user-follows"
@@ -310150,7 +310235,7 @@
"tags": [
"users"
],
"operationId": "users/list-gpg-keys-for-authenticated",
"operationId": "users/list-gpg-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
@@ -310493,7 +310578,7 @@
"post": {
"summary": "Create a GPG key for the authenticated user",
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
"operationId": "users/create-gpg-key-for-authenticated",
"operationId": "users/create-gpg-key-for-authenticated-user",
"tags": [
"users"
],
@@ -310902,7 +310987,7 @@
"tags": [
"users"
],
"operationId": "users/get-gpg-key-for-authenticated",
"operationId": "users/get-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
@@ -311226,7 +311311,7 @@
"tags": [
"users"
],
"operationId": "users/delete-gpg-key-for-authenticated",
"operationId": "users/delete-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
@@ -313738,7 +313823,7 @@
"tags": [
"apps"
],
"operationId": "apps/add-repo-to-installation",
"operationId": "apps/add-repo-to-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/apps#add-a-repository-to-an-app-installation"
@@ -313838,7 +313923,7 @@
"tags": [
"apps"
],
"operationId": "apps/remove-repo-from-installation",
"operationId": "apps/remove-repo-from-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/apps#remove-a-repository-from-an-app-installation"
@@ -316689,7 +316774,7 @@
"tags": [
"users"
],
"operationId": "users/list-public-ssh-keys-for-authenticated",
"operationId": "users/list-public-ssh-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
@@ -316890,7 +316975,7 @@
"post": {
"summary": "Create a public SSH key for the authenticated user",
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
"operationId": "users/create-public-ssh-key-for-authenticated",
"operationId": "users/create-public-ssh-key-for-authenticated-user",
"tags": [
"users"
],
@@ -317154,7 +317239,7 @@
"tags": [
"users"
],
"operationId": "users/get-public-ssh-key-for-authenticated",
"operationId": "users/get-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
@@ -317327,7 +317412,7 @@
"tags": [
"users"
],
"operationId": "users/delete-public-ssh-key-for-authenticated",
"operationId": "users/delete-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
@@ -324793,7 +324878,7 @@
"tags": [
"repos"
],
"operationId": "repos/accept-invitation",
"operationId": "repos/accept-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/repos#accept-a-repository-invitation"
@@ -324911,7 +324996,7 @@
"tags": [
"repos"
],
"operationId": "repos/decline-invitation",
"operationId": "repos/decline-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/repos#decline-a-repository-invitation"

4
lib/search/indexes/github-docs-2.22-cn-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:7fddf4c7faf6c930bf0e378a1ffcc9bfef95449c1d863b7143091bf1c960cd41
size 525387
oid sha256:d114c7b22367d93102a06e51c16671fe9cb68eb57b46fd458af625b4e13f02b0
size 525486

4
lib/search/indexes/github-docs-2.22-cn.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:6cdba924672d13a96e72c94d0b655f2da4f5db0d43a0ea2fa1405f6b42ccc19a
size 868817
oid sha256:bc585436bcd959d4cb4bea79ec3813aa236086178b730eeaa7ea86253dcccd20
size 868661

4
lib/search/indexes/github-docs-2.22-de-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:f8031aa7987254c33af030664ead0eb1c3e50fc6fcff27a5ca4f292ba67cbb50
size 479354
oid sha256:bcdd3c52ce0c9bef3470189d7115bb67f323d7b9c61a50b57ddae3d3aeeab5e4
size 479335

4
lib/search/indexes/github-docs-2.22-de.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:b99f605bc49ee1b3a25628af635843f16e7977a73e52390bc313acd016c7bde5
size 2127018
oid sha256:d859ff65c917ca7f602f394b81f969bd0dac338d16c80c51e508db5c7b6389f1
size 2126741

4
lib/search/indexes/github-docs-2.22-en-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:1af5ed92b5d28760746f716ae1cb30744cc31fa11e4fbac972165224d7569c00
size 433209
oid sha256:14dd9ade966816ac9871f455f7467a35e20c0ce21a4c5763a660e945603bab87
size 434002

4
lib/search/indexes/github-docs-2.22-en.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:0f74a2f4c99b8b8c12d08e13664063fb5127ed5eafee4172d24339a4420e4ea4
size 1691908
oid sha256:582e57c5b7b9c8569d191bff9604e002f86a6af6f5ebdb64d334f8cb3d84e1d5
size 1694431

4
lib/search/indexes/github-docs-2.22-es-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:684ae2ed9ff94f290a37483b01392248ecad74c82a2cdb0a3d310248a81b003e
size 194966
oid sha256:c3abc8d6b3fccfac1f63c7a1ee556a3df68c40d7c3501ae033b2580da28212e3
size 194947

4
lib/search/indexes/github-docs-2.22-es.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:8da6555baf4dc636f2a10b47c5b9cee0af00ea34f065c7e2927eb761d6e65390
size 702561
oid sha256:5ebfa8fa87f8983ad1d0bb11650bb0b24c8729a3a12505ff94c2ef4096f61f35
size 702808

4
lib/search/indexes/github-docs-2.22-ja-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:ac5b16a4f0e00a22ceafc689084228c5e9256bdd2e7899158b6d029691ee2ec2
size 545312
oid sha256:88f551ef41760e565eb549c4a5bdc5cf70f39b45c4e85d774e90c8fd4bbd7ca9
size 545371

4
lib/search/indexes/github-docs-2.22-ja.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:2a9ca00d6233c9a57d6c626adb98a3ab56acd7a603dadb9b07dd9d56dfe912ca
size 2880736
oid sha256:63e10625085871114846e24be09fb4d947bd70e8c300ed7489975b963162b484
size 2881066

4
lib/search/indexes/github-docs-2.22-pt-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:eeaa533b175af0ed77e04bc809e267e2d9691cc71db070d76daa65713db4ace0
size 456916
oid sha256:39219dc530ddb49f3bb89bac713b598b56c944d0cb640e23c4bb1992baaca18f
size 456869

4
lib/search/indexes/github-docs-2.22-pt.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:e564855f3a9cb64eac81e2e824ee4567ccebf8c0ad3c23a063af553cf2cd202a
size 1906016
oid sha256:3e79dab7b004505fffd0b62aa35d91c696d24e970da5edbc6d6d0591db9929fb
size 1905314

4
lib/search/indexes/github-docs-3.0-cn-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:2bf514c59e3928c9c156a7297961ac0f9e40196c133f0f6f42b9124a54571a97
size 544827
oid sha256:c3024b43540554ca461df3785180daae860b7598149a153d409939238c06c434
size 544816

4
lib/search/indexes/github-docs-3.0-cn.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:870a970a2d7faa1bebf71d76ef894bfbb30f7d1d9b9aeb724fecb0ffa2ddfe6f
size 906924
oid sha256:6f296eb87fcd2df9ab89ca8790dbb988a2c324fd9b6f75930c7738590e95c8e2
size 906964

4
lib/search/indexes/github-docs-3.0-de-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:2538fd004ef1f5cfd3c68865cc225200ec4650fce02d758345f9f491aa99fee5
size 499761
oid sha256:0c20a895354c773031bef46c1a778ad71880dc42e7d37955609f56e9e40f9578
size 499831

4
lib/search/indexes/github-docs-3.0-de.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:49c06c5d0f26bb42d2797c56fb4dcbfdad8b3856760452eb9fbb7fe37e14d167
size 2232343
oid sha256:8a2d152430503fee662621371dd12284298a51f9c1b2bb9bb84323673ee3da71
size 2233318

4
lib/search/indexes/github-docs-3.0-en-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:56eee7ffb97d071f93035c1e14e52107831f3b45af4ed351c941ed1796b0624e
size 453365
oid sha256:0b65336727234510f1853750584cc7e646b222207c9e1064273843ce7949b26e
size 454366

4
lib/search/indexes/github-docs-3.0-en.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:6d8f2b68341c3ae80dbfbfe40d910816bbb99f141239672bbd70f035d9a5a60f
size 1766262
oid sha256:99d22e830d9eb19417dc853899b7622a775a2515f260213dfed8cd1556ef45c9
size 1770358

4
lib/search/indexes/github-docs-3.0-es-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:7e7f2780c8fe7c1aab0ed263ab293ce6d954bd417cb0ba3cc1f79698d8748bba
size 193801
oid sha256:381887558a887ab88eeee2ea6f065d9de8121cbbb52d0a9f7598351bab86f6ee
size 193643

4
lib/search/indexes/github-docs-3.0-es.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:b810b4df4eee3953399f92c37951736bdc71eea7463222a321b3db333b31252b
size 694352
oid sha256:75ff34c5ac0dfb233a58633235e94567055d6b485b079e12fd7c04e8e1b31963
size 694141

4
lib/search/indexes/github-docs-3.0-ja-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:53e7f463b04033d32c3996b0212503d4b199da02c3d14499b3472e1f080b2398
size 567804
oid sha256:13db5065563e7c411417ce929f12a5b8e1a7e0cc496d9625d5d7edcfc9f9fd7b
size 567793

4
lib/search/indexes/github-docs-3.0-ja.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:49a2a706283a54b8f878a9edde25b3be6504d32447b32558994a6db17ac320dc
size 3007018
oid sha256:830257244057a240973d359a65c6d158c8cbae3ba19c258a96ad1ab5b639f519
size 3006791

4
lib/search/indexes/github-docs-3.0-pt-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:d081c90eb2aaaff60ebc80549e72734df6b03f03baa8b53d0a62255be77e56d7
size 477490
oid sha256:da8a07bac1f10ffb60faade6dd75d463fc44adaf6531a9e512535bb9b1c38a9e
size 477774

4
lib/search/indexes/github-docs-3.0-pt.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:6b12f9dd29b19b36445a09b1b82727c09d98c315c7ba89e3cd83a021314062d2
size 1994090
oid sha256:9b42e4655d11f80a00fb3fb4eb240f1374ccc250236a2fe854d80067604bcd94
size 1992967

4
lib/search/indexes/github-docs-3.1-cn-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:6ad305dc09e9a22d000b29a82e3f8fb9946d1ae5e74049de10dccf3b9e929f94
size 557425
oid sha256:1d512b1586e7941b60676c79f45c15448d3fbdf3e83fb9223a26efffab2d5b52
size 557226

4
lib/search/indexes/github-docs-3.1-cn.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:1e17dfd64c1d3e9de9fffc1f478ec4c7664799b03ec7405a6eec3cb212a6f573
size 929718
oid sha256:8ff0910c159473bcbd81b0e2d3d5570f965014fefac70407c24ceccb26210575
size 929514

4
lib/search/indexes/github-docs-3.1-de-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:ce036cc17ecb858f5256716d97332d6048f7b4c61250ffa5d061bd6b3bb1e9d8
size 508542
oid sha256:94c902ad1041c8c7ebfd51ae7cb5b46a3dde2b001015cd6a20ba97955a691768
size 508442

4
lib/search/indexes/github-docs-3.1-de.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:6ce66bf59df88391d0438292bc4fc0a01581f77de1e1696df20d2de53401e373
size 2284813
oid sha256:872f680f8c046ccb4343a7c898b34da2cfbb9895d287455a1be5ad61246c9718
size 2284994

4
lib/search/indexes/github-docs-3.1-en-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:c750dddeba3fa6917a5fb899b98a0abfe15ab92e8740dafdae885c999756775e
size 461953
oid sha256:03d369d4bd85ec18910eb860d55177c1c3774dd6e7a4c69f9fcef294d96aaa48
size 463859

4
lib/search/indexes/github-docs-3.1-en.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:3293fa50b36d8c39712d1f315282099702cdceddd51daf619c97a59c016a6583
size 1804852
oid sha256:21e93451edfd6e0259708ebf5019c4ab3961a86d27b476be7f3abc174f1e9527
size 1812535

4
lib/search/indexes/github-docs-3.1-es-records.json.br
View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:5f649f668c7a78318efdf0af749846e2cd8dbda4bffaeb86a32ced1b1a42b682
size 193642
oid sha256:896e15b7efeb807130a22783de6e558e67201c193ce0fde2386923a4d5184b95
size 193540

Some files were not shown because too many files have changed in this diff Show More