diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 8a28c2133..c1a97df60 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -29,3 +29,5 @@ jobs: run: npm ci - name: Test run: npm test + - name: Build to verify integrity of code + types + run: npm run build diff --git a/docs/actions/addCustomLabelsToSelfHostedRunnerForOrg.md b/docs/actions/addCustomLabelsToSelfHostedRunnerForOrg.md new file mode 100644 index 000000000..6c03bd0c4 --- /dev/null +++ b/docs/actions/addCustomLabelsToSelfHostedRunnerForOrg.md @@ -0,0 +1,52 @@ +--- +name: Add custom labels to a self-hosted runner for an organization +example: octokit.rest.actions.addCustomLabelsToSelfHostedRunnerForOrg({ org, runner_id, labels }) +route: POST /orgs/{org}/actions/runners/{runner_id}/labels +scope: actions +type: API method +--- + +# Add custom labels to a self-hosted runner for an organization + +Add custom labels to a self-hosted runner configured in an organization. + +You must authenticate using an access token with the `admin:org` scope to use this endpoint. + +```js +octokit.rest.actions.addCustomLabelsToSelfHostedRunnerForOrg({ + org, + runner_id, + labels, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
runner_idyes + +Unique identifier of the self-hosted runner. + +
labelsyes + +The names of the custom labels to add to the runner. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-an-organization). diff --git a/docs/actions/addCustomLabelsToSelfHostedRunnerForRepo.md b/docs/actions/addCustomLabelsToSelfHostedRunnerForRepo.md new file mode 100644 index 000000000..cfcaad261 --- /dev/null +++ b/docs/actions/addCustomLabelsToSelfHostedRunnerForRepo.md @@ -0,0 +1,59 @@ +--- +name: Add custom labels to a self-hosted runner for a repository +example: octokit.rest.actions.addCustomLabelsToSelfHostedRunnerForRepo({ owner, repo, runner_id, labels }) +route: POST /repos/{owner}/{repo}/actions/runners/{runner_id}/labels +scope: actions +type: API method +--- + +# Add custom labels to a self-hosted runner for a repository + +Add custom labels to a self-hosted runner configured in a repository. + +You must authenticate using an access token with the `repo` scope to use this +endpoint. + +```js +octokit.rest.actions.addCustomLabelsToSelfHostedRunnerForRepo({ + owner, + repo, + runner_id, + labels, +}); +``` + +## Parameters + + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
runner_idyes + +Unique identifier of the self-hosted runner. + +
labelsyes + +The names of the custom labels to add to the runner. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-a-repository). diff --git a/docs/actions/addSelectedRepoToOrgSecret.md b/docs/actions/addSelectedRepoToOrgSecret.md index f74fc8d24..9bc3aaf7d 100644 --- a/docs/actions/addSelectedRepoToOrgSecret.md +++ b/docs/actions/addSelectedRepoToOrgSecret.md @@ -31,10 +31,12 @@ octokit.rest.actions.addSelectedRepoToOrgSecret({ orgyes +The organization name. The name is not case sensitive. + secret_nameyes -secret_name parameter +The name of the secret. repository_idyes diff --git a/docs/actions/approveWorkflowRun.md b/docs/actions/approveWorkflowRun.md index 2f2253d0b..0d3b2da9f 100644 --- a/docs/actions/approveWorkflowRun.md +++ b/docs/actions/approveWorkflowRun.md @@ -33,13 +33,17 @@ octokit.rest.actions.approveWorkflowRun({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + run_idyes -The id of the workflow run. +The unique identifier of the workflow run. diff --git a/docs/actions/cancelWorkflowRun.md b/docs/actions/cancelWorkflowRun.md index 76c15382a..a1014be19 100644 --- a/docs/actions/cancelWorkflowRun.md +++ b/docs/actions/cancelWorkflowRun.md @@ -31,13 +31,17 @@ octokit.rest.actions.cancelWorkflowRun({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + run_idyes -The id of the workflow run. +The unique identifier of the workflow run. diff --git a/docs/actions/createOrUpdateEnvironmentSecret.md b/docs/actions/createOrUpdateEnvironmentSecret.md index 8cd0c7a39..d578e2ce4 100644 --- a/docs/actions/createOrUpdateEnvironmentSecret.md +++ b/docs/actions/createOrUpdateEnvironmentSecret.md @@ -38,7 +38,7 @@ console.log(encrypted); #### Example encrypting a secret using Python -Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3. +Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. ``` from base64 import b64encode @@ -106,6 +106,8 @@ octokit.rest.actions.createOrUpdateEnvironmentSecret({ repository_idyes +The unique identifier of the repository. + environment_nameyes @@ -114,7 +116,7 @@ The name of the environment secret_nameyes -secret_name parameter +The name of the secret. encrypted_valueyes diff --git a/docs/actions/createOrUpdateOrgSecret.md b/docs/actions/createOrUpdateOrgSecret.md index 2c28a657e..356dcef94 100644 --- a/docs/actions/createOrUpdateOrgSecret.md +++ b/docs/actions/createOrUpdateOrgSecret.md @@ -38,7 +38,7 @@ console.log(encrypted); #### Example encrypting a secret using Python -Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3. +Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. ``` from base64 import b64encode @@ -104,10 +104,12 @@ octokit.rest.actions.createOrUpdateOrgSecret({ orgyes +The organization name. The name is not case sensitive. + secret_nameyes -secret_name parameter +The name of the secret. encrypted_valueno @@ -122,10 +124,7 @@ ID of the key you used to encrypt the secret. visibilityyes -Configures the access that repositories have to the organization secret. Can be one of: -\- `all` - All repositories in an organization can access the secret. -\- `private` - Private repositories in an organization can access the secret. -\- `selected` - Only specific repositories can access the secret. +Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret. selected_repository_idsno diff --git a/docs/actions/createOrUpdateRepoSecret.md b/docs/actions/createOrUpdateRepoSecret.md index a84e5f3eb..a570c1f03 100644 --- a/docs/actions/createOrUpdateRepoSecret.md +++ b/docs/actions/createOrUpdateRepoSecret.md @@ -38,7 +38,7 @@ console.log(encrypted); #### Example encrypting a secret using Python -Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3. +Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. ``` from base64 import b64encode @@ -104,13 +104,17 @@ octokit.rest.actions.createOrUpdateRepoSecret({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + secret_nameyes -secret_name parameter +The name of the secret. encrypted_valueno diff --git a/docs/actions/createRegistrationTokenForOrg.md b/docs/actions/createRegistrationTokenForOrg.md index ea1d0b912..0129efea6 100644 --- a/docs/actions/createRegistrationTokenForOrg.md +++ b/docs/actions/createRegistrationTokenForOrg.md @@ -39,6 +39,8 @@ octokit.rest.actions.createRegistrationTokenForOrg({ orgyes +The organization name. The name is not case sensitive. + diff --git a/docs/actions/createRegistrationTokenForRepo.md b/docs/actions/createRegistrationTokenForRepo.md index c2f72117d..81abeda64 100644 --- a/docs/actions/createRegistrationTokenForRepo.md +++ b/docs/actions/createRegistrationTokenForRepo.md @@ -39,9 +39,13 @@ octokit.rest.actions.createRegistrationTokenForRepo({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/actions/createRemoveTokenForOrg.md b/docs/actions/createRemoveTokenForOrg.md index b26a960c4..3b6ac8855 100644 --- a/docs/actions/createRemoveTokenForOrg.md +++ b/docs/actions/createRemoveTokenForOrg.md @@ -40,6 +40,8 @@ octokit.rest.actions.createRemoveTokenForOrg({ orgyes +The organization name. The name is not case sensitive. + diff --git a/docs/actions/createRemoveTokenForRepo.md b/docs/actions/createRemoveTokenForRepo.md index 101af69de..c5853c408 100644 --- a/docs/actions/createRemoveTokenForRepo.md +++ b/docs/actions/createRemoveTokenForRepo.md @@ -39,9 +39,13 @@ octokit.rest.actions.createRemoveTokenForRepo({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/actions/createWorkflowDispatch.md b/docs/actions/createWorkflowDispatch.md index 3cb5a2dfe..03b4f448a 100644 --- a/docs/actions/createWorkflowDispatch.md +++ b/docs/actions/createWorkflowDispatch.md @@ -12,7 +12,7 @@ You can use this endpoint to manually trigger a GitHub Actions workflow run. You You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." -You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)." +You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)." ```js octokit.rest.actions.createWorkflowDispatch({ @@ -36,9 +36,13 @@ octokit.rest.actions.createWorkflowDispatch({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + workflow_idyes diff --git a/docs/actions/deleteArtifact.md b/docs/actions/deleteArtifact.md index dd35e6c32..1b4c89fc2 100644 --- a/docs/actions/deleteArtifact.md +++ b/docs/actions/deleteArtifact.md @@ -31,13 +31,17 @@ octokit.rest.actions.deleteArtifact({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + artifact_idyes -artifact_id parameter +The unique identifier of the artifact. diff --git a/docs/actions/deleteEnvironmentSecret.md b/docs/actions/deleteEnvironmentSecret.md index 0f017dabc..7e8a58684 100644 --- a/docs/actions/deleteEnvironmentSecret.md +++ b/docs/actions/deleteEnvironmentSecret.md @@ -31,6 +31,8 @@ octokit.rest.actions.deleteEnvironmentSecret({ repository_idyes +The unique identifier of the repository. + environment_nameyes @@ -39,7 +41,7 @@ The name of the environment secret_nameyes -secret_name parameter +The name of the secret. diff --git a/docs/actions/deleteOrgSecret.md b/docs/actions/deleteOrgSecret.md index c1acde1b1..52af6d1d6 100644 --- a/docs/actions/deleteOrgSecret.md +++ b/docs/actions/deleteOrgSecret.md @@ -30,10 +30,12 @@ octokit.rest.actions.deleteOrgSecret({ orgyes +The organization name. The name is not case sensitive. + secret_nameyes -secret_name parameter +The name of the secret. diff --git a/docs/actions/deleteRepoSecret.md b/docs/actions/deleteRepoSecret.md index 9a75a99e2..6987af6b3 100644 --- a/docs/actions/deleteRepoSecret.md +++ b/docs/actions/deleteRepoSecret.md @@ -31,13 +31,17 @@ octokit.rest.actions.deleteRepoSecret({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + secret_nameyes -secret_name parameter +The name of the secret. diff --git a/docs/actions/deleteSelfHostedRunnerFromOrg.md b/docs/actions/deleteSelfHostedRunnerFromOrg.md index 31c3c9dcb..7a7f5c325 100644 --- a/docs/actions/deleteSelfHostedRunnerFromOrg.md +++ b/docs/actions/deleteSelfHostedRunnerFromOrg.md @@ -32,6 +32,8 @@ octokit.rest.actions.deleteSelfHostedRunnerFromOrg({ orgyes +The organization name. The name is not case sensitive. + runner_idyes diff --git a/docs/actions/deleteSelfHostedRunnerFromRepo.md b/docs/actions/deleteSelfHostedRunnerFromRepo.md index eec4acfb3..5b0d89b8d 100644 --- a/docs/actions/deleteSelfHostedRunnerFromRepo.md +++ b/docs/actions/deleteSelfHostedRunnerFromRepo.md @@ -34,9 +34,13 @@ octokit.rest.actions.deleteSelfHostedRunnerFromRepo({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + runner_idyes diff --git a/docs/actions/deleteWorkflowRun.md b/docs/actions/deleteWorkflowRun.md index c3a019bc6..510327788 100644 --- a/docs/actions/deleteWorkflowRun.md +++ b/docs/actions/deleteWorkflowRun.md @@ -33,13 +33,17 @@ octokit.rest.actions.deleteWorkflowRun({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + run_idyes -The id of the workflow run. +The unique identifier of the workflow run. diff --git a/docs/actions/deleteWorkflowRunLogs.md b/docs/actions/deleteWorkflowRunLogs.md index 504d7ae17..912960ca0 100644 --- a/docs/actions/deleteWorkflowRunLogs.md +++ b/docs/actions/deleteWorkflowRunLogs.md @@ -31,13 +31,17 @@ octokit.rest.actions.deleteWorkflowRunLogs({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + run_idyes -The id of the workflow run. +The unique identifier of the workflow run. diff --git a/docs/actions/disableSelectedRepositoryGithubActionsOrganization.md b/docs/actions/disableSelectedRepositoryGithubActionsOrganization.md index e774dde2e..08953dc21 100644 --- a/docs/actions/disableSelectedRepositoryGithubActionsOrganization.md +++ b/docs/actions/disableSelectedRepositoryGithubActionsOrganization.md @@ -32,9 +32,13 @@ octokit.rest.actions.disableSelectedRepositoryGithubActionsOrganization({ orgyes +The organization name. The name is not case sensitive. + repository_idyes +The unique identifier of the repository. + diff --git a/docs/actions/disableWorkflow.md b/docs/actions/disableWorkflow.md index 9941da1bb..94a16f58c 100644 --- a/docs/actions/disableWorkflow.md +++ b/docs/actions/disableWorkflow.md @@ -33,9 +33,13 @@ octokit.rest.actions.disableWorkflow({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + workflow_idyes diff --git a/docs/actions/downloadArtifact.md b/docs/actions/downloadArtifact.md index 85f92486e..83b62d902 100644 --- a/docs/actions/downloadArtifact.md +++ b/docs/actions/downloadArtifact.md @@ -35,13 +35,17 @@ octokit.rest.actions.downloadArtifact({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + artifact_idyes -artifact_id parameter +The unique identifier of the artifact. archive_formatyes diff --git a/docs/actions/downloadJobLogsForWorkflowRun.md b/docs/actions/downloadJobLogsForWorkflowRun.md index 8420c9f56..21b3105ec 100644 --- a/docs/actions/downloadJobLogsForWorkflowRun.md +++ b/docs/actions/downloadJobLogsForWorkflowRun.md @@ -34,13 +34,17 @@ octokit.rest.actions.downloadJobLogsForWorkflowRun({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + job_idyes -job_id parameter +The unique identifier of the job. diff --git a/docs/actions/downloadWorkflowRunAttemptLogs.md b/docs/actions/downloadWorkflowRunAttemptLogs.md index a526a21cc..ff94a5796 100644 --- a/docs/actions/downloadWorkflowRunAttemptLogs.md +++ b/docs/actions/downloadWorkflowRunAttemptLogs.md @@ -35,13 +35,17 @@ octokit.rest.actions.downloadWorkflowRunAttemptLogs({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + run_idyes -The id of the workflow run. +The unique identifier of the workflow run. attempt_numberyes diff --git a/docs/actions/downloadWorkflowRunLogs.md b/docs/actions/downloadWorkflowRunLogs.md index 09bce4ff1..c6eece002 100644 --- a/docs/actions/downloadWorkflowRunLogs.md +++ b/docs/actions/downloadWorkflowRunLogs.md @@ -34,13 +34,17 @@ octokit.rest.actions.downloadWorkflowRunLogs({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + run_idyes -The id of the workflow run. +The unique identifier of the workflow run. diff --git a/docs/actions/enableSelectedRepositoryGithubActionsOrganization.md b/docs/actions/enableSelectedRepositoryGithubActionsOrganization.md index bbb3ebd1e..09b2b68db 100644 --- a/docs/actions/enableSelectedRepositoryGithubActionsOrganization.md +++ b/docs/actions/enableSelectedRepositoryGithubActionsOrganization.md @@ -32,9 +32,13 @@ octokit.rest.actions.enableSelectedRepositoryGithubActionsOrganization({ orgyes +The organization name. The name is not case sensitive. + repository_idyes +The unique identifier of the repository. + diff --git a/docs/actions/enableWorkflow.md b/docs/actions/enableWorkflow.md index f2474db83..f7d1fd7da 100644 --- a/docs/actions/enableWorkflow.md +++ b/docs/actions/enableWorkflow.md @@ -33,9 +33,13 @@ octokit.rest.actions.enableWorkflow({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + workflow_idyes diff --git a/docs/actions/getActionsCacheUsage.md b/docs/actions/getActionsCacheUsage.md new file mode 100644 index 000000000..3840870cc --- /dev/null +++ b/docs/actions/getActionsCacheUsage.md @@ -0,0 +1,46 @@ +--- +name: Get GitHub Actions cache usage for a repository +example: octokit.rest.actions.getActionsCacheUsage({ owner, repo }) +route: GET /repos/{owner}/{repo}/actions/cache/usage +scope: actions +type: API method +--- + +# Get GitHub Actions cache usage for a repository + +Gets GitHub Actions cache usage for a repository. +The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. +Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + +```js +octokit.rest.actions.getActionsCacheUsage({ + owner, + repo, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-github-actions-cache-usage-for-a-repository). diff --git a/docs/actions/getActionsCacheUsageByRepoForOrg.md b/docs/actions/getActionsCacheUsageByRepoForOrg.md new file mode 100644 index 000000000..2b13cdfb4 --- /dev/null +++ b/docs/actions/getActionsCacheUsageByRepoForOrg.md @@ -0,0 +1,50 @@ +--- +name: List repositories with GitHub Actions cache usage for an organization +example: octokit.rest.actions.getActionsCacheUsageByRepoForOrg({ org }) +route: GET /orgs/{org}/actions/cache/usage-by-repository +scope: actions +type: API method +--- + +# List repositories with GitHub Actions cache usage for an organization + +Lists repositories and their GitHub Actions cache usage for an organization. +The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. +You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint. + +```js +octokit.rest.actions.getActionsCacheUsageByRepoForOrg({ + org, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
per_pageno + +The number of results per page (max 100). + +
pageno + +Page number of the results to fetch. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#list-repositories-with-github-actions-cache-usage-for-an-organization). diff --git a/docs/actions/getActionsCacheUsageForEnterprise.md b/docs/actions/getActionsCacheUsageForEnterprise.md new file mode 100644 index 000000000..379da4c23 --- /dev/null +++ b/docs/actions/getActionsCacheUsageForEnterprise.md @@ -0,0 +1,40 @@ +--- +name: Get GitHub Actions cache usage for an enterprise +example: octokit.rest.actions.getActionsCacheUsageForEnterprise({ enterprise }) +route: GET /enterprises/{enterprise}/actions/cache/usage +scope: actions +type: API method +--- + +# Get GitHub Actions cache usage for an enterprise + +Gets the total GitHub Actions cache usage for an enterprise. +The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. +You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + +```js +octokit.rest.actions.getActionsCacheUsageForEnterprise({ + enterprise, +}); +``` + +## Parameters + + + + + + + + + + + + +
namerequireddescription
enterpriseyes + +The slug version of the enterprise name. You can also substitute this value with the enterprise id. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-github-actions-cache-usage-for-an-enterprise). diff --git a/docs/actions/getActionsCacheUsageForOrg.md b/docs/actions/getActionsCacheUsageForOrg.md new file mode 100644 index 000000000..678f3fda2 --- /dev/null +++ b/docs/actions/getActionsCacheUsageForOrg.md @@ -0,0 +1,40 @@ +--- +name: Get GitHub Actions cache usage for an organization +example: octokit.rest.actions.getActionsCacheUsageForOrg({ org }) +route: GET /orgs/{org}/actions/cache/usage +scope: actions +type: API method +--- + +# Get GitHub Actions cache usage for an organization + +Gets the total GitHub Actions cache usage for an organization. +The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. +You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint. + +```js +octokit.rest.actions.getActionsCacheUsageForOrg({ + org, +}); +``` + +## Parameters + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-github-actions-cache-usage-for-an-organization). diff --git a/docs/actions/getAllowedActionsOrganization.md b/docs/actions/getAllowedActionsOrganization.md index 25ae7a1e7..6f8851097 100644 --- a/docs/actions/getAllowedActionsOrganization.md +++ b/docs/actions/getAllowedActionsOrganization.md @@ -1,14 +1,14 @@ --- -name: Get allowed actions for an organization +name: Get allowed actions and reusable workflows for an organization example: octokit.rest.actions.getAllowedActionsOrganization({ org }) route: GET /orgs/{org}/actions/permissions/selected-actions scope: actions type: API method --- -# Get allowed actions for an organization +# Get allowed actions and reusable workflows for an organization -Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" +Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. @@ -31,6 +31,8 @@ octokit.rest.actions.getAllowedActionsOrganization({ orgyes +The organization name. The name is not case sensitive. + diff --git a/docs/actions/getAllowedActionsRepository.md b/docs/actions/getAllowedActionsRepository.md index cee724ded..69fd2b851 100644 --- a/docs/actions/getAllowedActionsRepository.md +++ b/docs/actions/getAllowedActionsRepository.md @@ -1,14 +1,14 @@ --- -name: Get allowed actions for a repository +name: Get allowed actions and reusable workflows for a repository example: octokit.rest.actions.getAllowedActionsRepository({ owner, repo }) route: GET /repos/{owner}/{repo}/actions/permissions/selected-actions scope: actions type: API method --- -# Get allowed actions for a repository +# Get allowed actions and reusable workflows for a repository -Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." +Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. @@ -32,9 +32,13 @@ octokit.rest.actions.getAllowedActionsRepository({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/actions/getArtifact.md b/docs/actions/getArtifact.md index 1474b8d25..a3c0807ae 100644 --- a/docs/actions/getArtifact.md +++ b/docs/actions/getArtifact.md @@ -31,13 +31,17 @@ octokit.rest.actions.getArtifact({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + artifact_idyes -artifact_id parameter +The unique identifier of the artifact. diff --git a/docs/actions/getEnvironmentPublicKey.md b/docs/actions/getEnvironmentPublicKey.md index 10edfbbff..3cba05446 100644 --- a/docs/actions/getEnvironmentPublicKey.md +++ b/docs/actions/getEnvironmentPublicKey.md @@ -30,6 +30,8 @@ octokit.rest.actions.getEnvironmentPublicKey({ repository_idyes +The unique identifier of the repository. + environment_nameyes diff --git a/docs/actions/getEnvironmentSecret.md b/docs/actions/getEnvironmentSecret.md index b52a5fa50..52eb89835 100644 --- a/docs/actions/getEnvironmentSecret.md +++ b/docs/actions/getEnvironmentSecret.md @@ -31,6 +31,8 @@ octokit.rest.actions.getEnvironmentSecret({ repository_idyes +The unique identifier of the repository. + environment_nameyes @@ -39,7 +41,7 @@ The name of the environment secret_nameyes -secret_name parameter +The name of the secret. diff --git a/docs/actions/getGithubActionsDefaultWorkflowPermissionsEnterprise.md b/docs/actions/getGithubActionsDefaultWorkflowPermissionsEnterprise.md new file mode 100644 index 000000000..0cda0915e --- /dev/null +++ b/docs/actions/getGithubActionsDefaultWorkflowPermissionsEnterprise.md @@ -0,0 +1,43 @@ +--- +name: Get default workflow permissions for an enterprise +example: octokit.rest.actions.getGithubActionsDefaultWorkflowPermissionsEnterprise({ enterprise }) +route: GET /enterprises/{enterprise}/actions/permissions/workflow +scope: actions +type: API method +--- + +# Get default workflow permissions for an enterprise + +Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, +as well as whether GitHub Actions can submit approving pull request reviews. For more information, see +"[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." + +You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. +GitHub Apps must have the `enterprise_administration:write` permission to use this endpoint. + +```js +octokit.rest.actions.getGithubActionsDefaultWorkflowPermissionsEnterprise({ + enterprise, +}); +``` + +## Parameters + + + + + + + + + + + + +
namerequireddescription
enterpriseyes + +The slug version of the enterprise name. You can also substitute this value with the enterprise id. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-default-workflow-permissions-for-an-enterprise). diff --git a/docs/actions/getGithubActionsDefaultWorkflowPermissionsOrganization.md b/docs/actions/getGithubActionsDefaultWorkflowPermissionsOrganization.md new file mode 100644 index 000000000..a94be742f --- /dev/null +++ b/docs/actions/getGithubActionsDefaultWorkflowPermissionsOrganization.md @@ -0,0 +1,42 @@ +--- +name: Get default workflow permissions for an organization +example: octokit.rest.actions.getGithubActionsDefaultWorkflowPermissionsOrganization({ org }) +route: GET /orgs/{org}/actions/permissions/workflow +scope: actions +type: API method +--- + +# Get default workflow permissions for an organization + +Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, +as well as whether GitHub Actions can submit approving pull request reviews. For more information, see +"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + +You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + +```js +octokit.rest.actions.getGithubActionsDefaultWorkflowPermissionsOrganization({ + org, +}); +``` + +## Parameters + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-default-workflow-permissions). diff --git a/docs/actions/getGithubActionsDefaultWorkflowPermissionsRepository.md b/docs/actions/getGithubActionsDefaultWorkflowPermissionsRepository.md new file mode 100644 index 000000000..540b68779 --- /dev/null +++ b/docs/actions/getGithubActionsDefaultWorkflowPermissionsRepository.md @@ -0,0 +1,48 @@ +--- +name: Get default workflow permissions for a repository +example: octokit.rest.actions.getGithubActionsDefaultWorkflowPermissionsRepository({ owner, repo }) +route: GET /repos/{owner}/{repo}/actions/permissions/workflow +scope: actions +type: API method +--- + +# Get default workflow permissions for a repository + +Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, +as well as if GitHub Actions can submit approving pull request reviews. +For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + +You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API. + +```js +octokit.rest.actions.getGithubActionsDefaultWorkflowPermissionsRepository({ + owner, + repo, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-default-workflow-permissions-for-a-repository). diff --git a/docs/actions/getGithubActionsPermissionsOrganization.md b/docs/actions/getGithubActionsPermissionsOrganization.md index d66890ffd..42fedadd4 100644 --- a/docs/actions/getGithubActionsPermissionsOrganization.md +++ b/docs/actions/getGithubActionsPermissionsOrganization.md @@ -8,7 +8,7 @@ type: API method # Get GitHub Actions permissions for an organization -Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization. +Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. @@ -31,6 +31,8 @@ octokit.rest.actions.getGithubActionsPermissionsOrganization({ orgyes +The organization name. The name is not case sensitive. + diff --git a/docs/actions/getGithubActionsPermissionsRepository.md b/docs/actions/getGithubActionsPermissionsRepository.md index 489efd337..7eb97d594 100644 --- a/docs/actions/getGithubActionsPermissionsRepository.md +++ b/docs/actions/getGithubActionsPermissionsRepository.md @@ -8,10 +8,9 @@ type: API method # Get GitHub Actions permissions for a repository -Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. +Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository. -You must authenticate using an access token with the `repo` scope to use this -endpoint. GitHub Apps must have the `administration` repository permission to use this API. +You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. ```js octokit.rest.actions.getGithubActionsPermissionsRepository({ @@ -33,9 +32,13 @@ octokit.rest.actions.getGithubActionsPermissionsRepository({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/actions/getJobForWorkflowRun.md b/docs/actions/getJobForWorkflowRun.md index 67aa84029..debc488e1 100644 --- a/docs/actions/getJobForWorkflowRun.md +++ b/docs/actions/getJobForWorkflowRun.md @@ -31,13 +31,17 @@ octokit.rest.actions.getJobForWorkflowRun({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + job_idyes -job_id parameter +The unique identifier of the job. diff --git a/docs/actions/getOrgPublicKey.md b/docs/actions/getOrgPublicKey.md index 8a1c067bf..950e2835d 100644 --- a/docs/actions/getOrgPublicKey.md +++ b/docs/actions/getOrgPublicKey.md @@ -29,6 +29,8 @@ octokit.rest.actions.getOrgPublicKey({ orgyes +The organization name. The name is not case sensitive. + diff --git a/docs/actions/getOrgSecret.md b/docs/actions/getOrgSecret.md index 7c12ea6d2..d07883b44 100644 --- a/docs/actions/getOrgSecret.md +++ b/docs/actions/getOrgSecret.md @@ -30,10 +30,12 @@ octokit.rest.actions.getOrgSecret({ orgyes +The organization name. The name is not case sensitive. + secret_nameyes -secret_name parameter +The name of the secret. diff --git a/docs/actions/getPendingDeploymentsForRun.md b/docs/actions/getPendingDeploymentsForRun.md index 7c1e2cd49..1e49987eb 100644 --- a/docs/actions/getPendingDeploymentsForRun.md +++ b/docs/actions/getPendingDeploymentsForRun.md @@ -33,13 +33,17 @@ octokit.rest.actions.getPendingDeploymentsForRun({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + run_idyes -The id of the workflow run. +The unique identifier of the workflow run. diff --git a/docs/actions/getRepoPermissions.md b/docs/actions/getRepoPermissions.md index 68133b044..d8b4cb68f 100644 --- a/docs/actions/getRepoPermissions.md +++ b/docs/actions/getRepoPermissions.md @@ -10,10 +10,9 @@ type: API method **Deprecated:** This method has been renamed to actions.getGithubActionsPermissionsRepository -Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. +Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository. -You must authenticate using an access token with the `repo` scope to use this -endpoint. GitHub Apps must have the `administration` repository permission to use this API. +You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. ```js octokit.rest.actions.getRepoPermissions({ @@ -35,9 +34,13 @@ octokit.rest.actions.getRepoPermissions({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/actions/getRepoPublicKey.md b/docs/actions/getRepoPublicKey.md index a37883a09..fd7883f0f 100644 --- a/docs/actions/getRepoPublicKey.md +++ b/docs/actions/getRepoPublicKey.md @@ -30,9 +30,13 @@ octokit.rest.actions.getRepoPublicKey({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/actions/getRepoSecret.md b/docs/actions/getRepoSecret.md index 5a422f02b..75903969d 100644 --- a/docs/actions/getRepoSecret.md +++ b/docs/actions/getRepoSecret.md @@ -31,13 +31,17 @@ octokit.rest.actions.getRepoSecret({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + secret_nameyes -secret_name parameter +The name of the secret. diff --git a/docs/actions/getReviewsForRun.md b/docs/actions/getReviewsForRun.md index c15b015c2..ce43dc033 100644 --- a/docs/actions/getReviewsForRun.md +++ b/docs/actions/getReviewsForRun.md @@ -31,13 +31,17 @@ octokit.rest.actions.getReviewsForRun({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + run_idyes -The id of the workflow run. +The unique identifier of the workflow run. diff --git a/docs/actions/getSelfHostedRunnerForOrg.md b/docs/actions/getSelfHostedRunnerForOrg.md index 3520253dc..483557212 100644 --- a/docs/actions/getSelfHostedRunnerForOrg.md +++ b/docs/actions/getSelfHostedRunnerForOrg.md @@ -32,6 +32,8 @@ octokit.rest.actions.getSelfHostedRunnerForOrg({ orgyes +The organization name. The name is not case sensitive. + runner_idyes diff --git a/docs/actions/getSelfHostedRunnerForRepo.md b/docs/actions/getSelfHostedRunnerForRepo.md index fb916552f..f3c5bff72 100644 --- a/docs/actions/getSelfHostedRunnerForRepo.md +++ b/docs/actions/getSelfHostedRunnerForRepo.md @@ -34,9 +34,13 @@ octokit.rest.actions.getSelfHostedRunnerForRepo({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + runner_idyes diff --git a/docs/actions/getWorkflow.md b/docs/actions/getWorkflow.md index a74cc4d83..197309cc4 100644 --- a/docs/actions/getWorkflow.md +++ b/docs/actions/getWorkflow.md @@ -31,9 +31,13 @@ octokit.rest.actions.getWorkflow({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + workflow_idyes diff --git a/docs/actions/getWorkflowAccessToRepository.md b/docs/actions/getWorkflowAccessToRepository.md new file mode 100644 index 000000000..0511875a2 --- /dev/null +++ b/docs/actions/getWorkflowAccessToRepository.md @@ -0,0 +1,48 @@ +--- +name: Get the level of access for workflows outside of the repository +example: octokit.rest.actions.getWorkflowAccessToRepository({ owner, repo }) +route: GET /repos/{owner}/{repo}/actions/permissions/access +scope: actions +type: API method +--- + +# Get the level of access for workflows outside of the repository + +Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. +This endpoint only applies to internal repositories. For more information, see "[Managing GitHub Actions settings for a repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." + +You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the +repository `administration` permission to use this endpoint. + +```js +octokit.rest.actions.getWorkflowAccessToRepository({ + owner, + repo, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-workflow-access-level-to-a-repository). diff --git a/docs/actions/getWorkflowRun.md b/docs/actions/getWorkflowRun.md index 0451f8f30..cd9d4ad51 100644 --- a/docs/actions/getWorkflowRun.md +++ b/docs/actions/getWorkflowRun.md @@ -31,13 +31,17 @@ octokit.rest.actions.getWorkflowRun({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + run_idyes -The id of the workflow run. +The unique identifier of the workflow run. exclude_pull_requestsno diff --git a/docs/actions/getWorkflowRunAttempt.md b/docs/actions/getWorkflowRunAttempt.md index 18f697272..45307465d 100644 --- a/docs/actions/getWorkflowRunAttempt.md +++ b/docs/actions/getWorkflowRunAttempt.md @@ -35,13 +35,17 @@ octokit.rest.actions.getWorkflowRunAttempt({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + run_idyes -The id of the workflow run. +The unique identifier of the workflow run. attempt_numberyes diff --git a/docs/actions/getWorkflowRunUsage.md b/docs/actions/getWorkflowRunUsage.md index 561925d6b..fbbec8fc8 100644 --- a/docs/actions/getWorkflowRunUsage.md +++ b/docs/actions/getWorkflowRunUsage.md @@ -8,7 +8,7 @@ type: API method # Get workflow run usage -Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". +Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. @@ -33,13 +33,17 @@ octokit.rest.actions.getWorkflowRunUsage({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + run_idyes -The id of the workflow run. +The unique identifier of the workflow run. diff --git a/docs/actions/getWorkflowUsage.md b/docs/actions/getWorkflowUsage.md index 14274ffbf..c0c83d488 100644 --- a/docs/actions/getWorkflowUsage.md +++ b/docs/actions/getWorkflowUsage.md @@ -8,7 +8,7 @@ type: API method # Get workflow usage -Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". +Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. @@ -33,9 +33,13 @@ octokit.rest.actions.getWorkflowUsage({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + workflow_idyes diff --git a/docs/actions/listArtifactsForRepo.md b/docs/actions/listArtifactsForRepo.md index e08642d2d..0b8290293 100644 --- a/docs/actions/listArtifactsForRepo.md +++ b/docs/actions/listArtifactsForRepo.md @@ -30,13 +30,17 @@ octokit.rest.actions.listArtifactsForRepo({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/actions/listEnvironmentSecrets.md b/docs/actions/listEnvironmentSecrets.md index 604b6e16f..a0f0e24c1 100644 --- a/docs/actions/listEnvironmentSecrets.md +++ b/docs/actions/listEnvironmentSecrets.md @@ -30,6 +30,8 @@ octokit.rest.actions.listEnvironmentSecrets({ repository_idyes +The unique identifier of the repository. + environment_nameyes @@ -38,7 +40,7 @@ The name of the environment per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/actions/listJobsForWorkflowRun.md b/docs/actions/listJobsForWorkflowRun.md index 9657a2999..47baf5112 100644 --- a/docs/actions/listJobsForWorkflowRun.md +++ b/docs/actions/listJobsForWorkflowRun.md @@ -31,25 +31,27 @@ octokit.rest.actions.listJobsForWorkflowRun({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + run_idyes -The id of the workflow run. +The unique identifier of the workflow run. filterno -Filters jobs by their `completed_at` timestamp. Can be one of: -\* `latest`: Returns jobs from the most recent execution of the workflow run. -\* `all`: Returns all jobs for a workflow run, including from old executions of the workflow run. +Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all jobs for a workflow run, including from old executions of the workflow run. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/actions/listJobsForWorkflowRunAttempt.md b/docs/actions/listJobsForWorkflowRunAttempt.md index 1b460109b..9a01f8042 100644 --- a/docs/actions/listJobsForWorkflowRunAttempt.md +++ b/docs/actions/listJobsForWorkflowRunAttempt.md @@ -32,13 +32,17 @@ octokit.rest.actions.listJobsForWorkflowRunAttempt({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + run_idyes -The id of the workflow run. +The unique identifier of the workflow run. attempt_numberyes @@ -48,7 +52,7 @@ The attempt number of the workflow run. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/actions/listLabelsForSelfHostedRunnerForOrg.md b/docs/actions/listLabelsForSelfHostedRunnerForOrg.md new file mode 100644 index 000000000..a22fc274c --- /dev/null +++ b/docs/actions/listLabelsForSelfHostedRunnerForOrg.md @@ -0,0 +1,46 @@ +--- +name: List labels for a self-hosted runner for an organization +example: octokit.rest.actions.listLabelsForSelfHostedRunnerForOrg({ org, runner_id }) +route: GET /orgs/{org}/actions/runners/{runner_id}/labels +scope: actions +type: API method +--- + +# List labels for a self-hosted runner for an organization + +Lists all labels for a self-hosted runner configured in an organization. + +You must authenticate using an access token with the `admin:org` scope to use this endpoint. + +```js +octokit.rest.actions.listLabelsForSelfHostedRunnerForOrg({ + org, + runner_id, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
runner_idyes + +Unique identifier of the self-hosted runner. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-an-organization). diff --git a/docs/actions/listLabelsForSelfHostedRunnerForRepo.md b/docs/actions/listLabelsForSelfHostedRunnerForRepo.md new file mode 100644 index 000000000..924772658 --- /dev/null +++ b/docs/actions/listLabelsForSelfHostedRunnerForRepo.md @@ -0,0 +1,53 @@ +--- +name: List labels for a self-hosted runner for a repository +example: octokit.rest.actions.listLabelsForSelfHostedRunnerForRepo({ owner, repo, runner_id }) +route: GET /repos/{owner}/{repo}/actions/runners/{runner_id}/labels +scope: actions +type: API method +--- + +# List labels for a self-hosted runner for a repository + +Lists all labels for a self-hosted runner configured in a repository. + +You must authenticate using an access token with the `repo` scope to use this +endpoint. + +```js +octokit.rest.actions.listLabelsForSelfHostedRunnerForRepo({ + owner, + repo, + runner_id, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
runner_idyes + +Unique identifier of the self-hosted runner. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-a-repository). diff --git a/docs/actions/listOrgSecrets.md b/docs/actions/listOrgSecrets.md index afd4d7292..1597d61c3 100644 --- a/docs/actions/listOrgSecrets.md +++ b/docs/actions/listOrgSecrets.md @@ -29,10 +29,12 @@ octokit.rest.actions.listOrgSecrets({ orgyes +The organization name. The name is not case sensitive. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/actions/listRepoSecrets.md b/docs/actions/listRepoSecrets.md index 4d48ec7c6..f3a76e5a2 100644 --- a/docs/actions/listRepoSecrets.md +++ b/docs/actions/listRepoSecrets.md @@ -30,13 +30,17 @@ octokit.rest.actions.listRepoSecrets({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/actions/listRepoWorkflows.md b/docs/actions/listRepoWorkflows.md index fa68ab728..153929d5d 100644 --- a/docs/actions/listRepoWorkflows.md +++ b/docs/actions/listRepoWorkflows.md @@ -30,13 +30,17 @@ octokit.rest.actions.listRepoWorkflows({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/actions/listRunnerApplicationsForOrg.md b/docs/actions/listRunnerApplicationsForOrg.md index 836399a08..3a2f9f8bf 100644 --- a/docs/actions/listRunnerApplicationsForOrg.md +++ b/docs/actions/listRunnerApplicationsForOrg.md @@ -31,6 +31,8 @@ octokit.rest.actions.listRunnerApplicationsForOrg({ orgyes +The organization name. The name is not case sensitive. + diff --git a/docs/actions/listRunnerApplicationsForRepo.md b/docs/actions/listRunnerApplicationsForRepo.md index 2f40e82d2..385cdb4da 100644 --- a/docs/actions/listRunnerApplicationsForRepo.md +++ b/docs/actions/listRunnerApplicationsForRepo.md @@ -32,9 +32,13 @@ octokit.rest.actions.listRunnerApplicationsForRepo({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/actions/listSelectedReposForOrgSecret.md b/docs/actions/listSelectedReposForOrgSecret.md index e317a0eb1..1e5792d89 100644 --- a/docs/actions/listSelectedReposForOrgSecret.md +++ b/docs/actions/listSelectedReposForOrgSecret.md @@ -30,10 +30,12 @@ octokit.rest.actions.listSelectedReposForOrgSecret({ orgyes +The organization name. The name is not case sensitive. + secret_nameyes -secret_name parameter +The name of the secret. pageno @@ -43,7 +45,7 @@ Page number of the results to fetch. per_pageno -Results per page (max 100) +The number of results per page (max 100). diff --git a/docs/actions/listSelectedRepositoriesEnabledGithubActionsOrganization.md b/docs/actions/listSelectedRepositoriesEnabledGithubActionsOrganization.md index 1ce2ed373..bbc02d2ba 100644 --- a/docs/actions/listSelectedRepositoriesEnabledGithubActionsOrganization.md +++ b/docs/actions/listSelectedRepositoriesEnabledGithubActionsOrganization.md @@ -31,10 +31,12 @@ octokit.rest.actions.listSelectedRepositoriesEnabledGithubActionsOrganization({ orgyes +The organization name. The name is not case sensitive. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/actions/listSelfHostedRunnersForOrg.md b/docs/actions/listSelfHostedRunnersForOrg.md index 6d5b39f97..419a22bae 100644 --- a/docs/actions/listSelfHostedRunnersForOrg.md +++ b/docs/actions/listSelfHostedRunnersForOrg.md @@ -31,10 +31,12 @@ octokit.rest.actions.listSelfHostedRunnersForOrg({ orgyes +The organization name. The name is not case sensitive. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/actions/listSelfHostedRunnersForRepo.md b/docs/actions/listSelfHostedRunnersForRepo.md index edf2ce60b..5b00b3783 100644 --- a/docs/actions/listSelfHostedRunnersForRepo.md +++ b/docs/actions/listSelfHostedRunnersForRepo.md @@ -30,13 +30,17 @@ octokit.rest.actions.listSelfHostedRunnersForRepo({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/actions/listWorkflowRunArtifacts.md b/docs/actions/listWorkflowRunArtifacts.md index c8838748b..e1c211ce1 100644 --- a/docs/actions/listWorkflowRunArtifacts.md +++ b/docs/actions/listWorkflowRunArtifacts.md @@ -31,18 +31,22 @@ octokit.rest.actions.listWorkflowRunArtifacts({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + run_idyes -The id of the workflow run. +The unique identifier of the workflow run. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/actions/listWorkflowRuns.md b/docs/actions/listWorkflowRuns.md index 2f38c8079..ffd71b0c0 100644 --- a/docs/actions/listWorkflowRuns.md +++ b/docs/actions/listWorkflowRuns.md @@ -33,9 +33,13 @@ octokit.rest.actions.listWorkflowRuns({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + workflow_idyes @@ -54,7 +58,7 @@ Returns workflow runs associated with a branch. Use the name of the branch of th eventno -Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." +Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." statusno @@ -64,7 +68,7 @@ Returns workflow runs with the check run `status` or `conclusion` that you speci per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno @@ -74,11 +78,18 @@ Page number of the results to fetch. createdno +Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." + exclude_pull_requestsno If `true` pull requests are omitted from the response (empty array). + +check_suite_idno + +Returns workflow runs with the `check_suite_id` that you specify. + diff --git a/docs/actions/listWorkflowRunsForRepo.md b/docs/actions/listWorkflowRunsForRepo.md index ccc972213..f8b82a79b 100644 --- a/docs/actions/listWorkflowRunsForRepo.md +++ b/docs/actions/listWorkflowRunsForRepo.md @@ -32,9 +32,13 @@ octokit.rest.actions.listWorkflowRunsForRepo({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + actorno @@ -48,7 +52,7 @@ Returns workflow runs associated with a branch. Use the name of the branch of th eventno -Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." +Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." statusno @@ -58,7 +62,7 @@ Returns workflow runs with the check run `status` or `conclusion` that you speci per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno @@ -68,11 +72,18 @@ Page number of the results to fetch. createdno +Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." + exclude_pull_requestsno If `true` pull requests are omitted from the response (empty array). + +check_suite_idno + +Returns workflow runs with the `check_suite_id` that you specify. + diff --git a/docs/actions/reRunJobForWorkflowRun.md b/docs/actions/reRunJobForWorkflowRun.md new file mode 100644 index 000000000..4662259da --- /dev/null +++ b/docs/actions/reRunJobForWorkflowRun.md @@ -0,0 +1,55 @@ +--- +name: Re-run a job from a workflow run +example: octokit.rest.actions.reRunJobForWorkflowRun({ owner, repo, job_id }) +route: POST /repos/{owner}/{repo}/actions/jobs/{job_id}/rerun +scope: actions +type: API method +--- + +# Re-run a job from a workflow run + +Re-run a job and its dependent jobs in a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + +```js +octokit.rest.actions.reRunJobForWorkflowRun({ + owner, + repo, + job_id, +}); +``` + +## Parameters + + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
job_idyes + +The unique identifier of the job. + +
enable_debug_loggingno + +Whether to enable debug logging for the re-run. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#re-run-job-for-workflow-run). diff --git a/docs/actions/reRunWorkflow.md b/docs/actions/reRunWorkflow.md new file mode 100644 index 000000000..34a3b3bd9 --- /dev/null +++ b/docs/actions/reRunWorkflow.md @@ -0,0 +1,55 @@ +--- +name: Re-run a workflow +example: octokit.rest.actions.reRunWorkflow({ owner, repo, run_id }) +route: POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun +scope: actions +type: API method +--- + +# Re-run a workflow + +Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + +```js +octokit.rest.actions.reRunWorkflow({ + owner, + repo, + run_id, +}); +``` + +## Parameters + + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
run_idyes + +The unique identifier of the workflow run. + +
enable_debug_loggingno + +Whether to enable debug logging for the re-run. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#re-run-a-workflow). diff --git a/docs/actions/reRunWorkflowFailedJobs.md b/docs/actions/reRunWorkflowFailedJobs.md new file mode 100644 index 000000000..ead879d67 --- /dev/null +++ b/docs/actions/reRunWorkflowFailedJobs.md @@ -0,0 +1,55 @@ +--- +name: Re-run failed jobs from a workflow run +example: octokit.rest.actions.reRunWorkflowFailedJobs({ owner, repo, run_id }) +route: POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs +scope: actions +type: API method +--- + +# Re-run failed jobs from a workflow run + +Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. + +```js +octokit.rest.actions.reRunWorkflowFailedJobs({ + owner, + repo, + run_id, +}); +``` + +## Parameters + + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
run_idyes + +The unique identifier of the workflow run. + +
enable_debug_loggingno + +Whether to enable debug logging for the re-run. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#re-run-workflow-failed-jobs). diff --git a/docs/actions/removeAllCustomLabelsFromSelfHostedRunnerForOrg.md b/docs/actions/removeAllCustomLabelsFromSelfHostedRunnerForOrg.md new file mode 100644 index 000000000..9c30aca40 --- /dev/null +++ b/docs/actions/removeAllCustomLabelsFromSelfHostedRunnerForOrg.md @@ -0,0 +1,47 @@ +--- +name: Remove all custom labels from a self-hosted runner for an organization +example: octokit.rest.actions.removeAllCustomLabelsFromSelfHostedRunnerForOrg({ org, runner_id }) +route: DELETE /orgs/{org}/actions/runners/{runner_id}/labels +scope: actions +type: API method +--- + +# Remove all custom labels from a self-hosted runner for an organization + +Remove all custom labels from a self-hosted runner configured in an +organization. Returns the remaining read-only labels from the runner. + +You must authenticate using an access token with the `admin:org` scope to use this endpoint. + +```js +octokit.rest.actions.removeAllCustomLabelsFromSelfHostedRunnerForOrg({ + org, + runner_id, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
runner_idyes + +Unique identifier of the self-hosted runner. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization). diff --git a/docs/actions/removeAllCustomLabelsFromSelfHostedRunnerForRepo.md b/docs/actions/removeAllCustomLabelsFromSelfHostedRunnerForRepo.md new file mode 100644 index 000000000..9b0dd0cc9 --- /dev/null +++ b/docs/actions/removeAllCustomLabelsFromSelfHostedRunnerForRepo.md @@ -0,0 +1,54 @@ +--- +name: Remove all custom labels from a self-hosted runner for a repository +example: octokit.rest.actions.removeAllCustomLabelsFromSelfHostedRunnerForRepo({ owner, repo, runner_id }) +route: DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}/labels +scope: actions +type: API method +--- + +# Remove all custom labels from a self-hosted runner for a repository + +Remove all custom labels from a self-hosted runner configured in a +repository. Returns the remaining read-only labels from the runner. + +You must authenticate using an access token with the `repo` scope to use this +endpoint. + +```js +octokit.rest.actions.removeAllCustomLabelsFromSelfHostedRunnerForRepo({ + owner, + repo, + runner_id, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
runner_idyes + +Unique identifier of the self-hosted runner. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository). diff --git a/docs/actions/removeCustomLabelFromSelfHostedRunnerForOrg.md b/docs/actions/removeCustomLabelFromSelfHostedRunnerForOrg.md new file mode 100644 index 000000000..96232f495 --- /dev/null +++ b/docs/actions/removeCustomLabelFromSelfHostedRunnerForOrg.md @@ -0,0 +1,56 @@ +--- +name: Remove a custom label from a self-hosted runner for an organization +example: octokit.rest.actions.removeCustomLabelFromSelfHostedRunnerForOrg({ org, runner_id, name }) +route: DELETE /orgs/{org}/actions/runners/{runner_id}/labels/{name} +scope: actions +type: API method +--- + +# Remove a custom label from a self-hosted runner for an organization + +Remove a custom label from a self-hosted runner configured +in an organization. Returns the remaining labels from the runner. + +This endpoint returns a `404 Not Found` status if the custom label is not +present on the runner. + +You must authenticate using an access token with the `admin:org` scope to use this endpoint. + +```js +octokit.rest.actions.removeCustomLabelFromSelfHostedRunnerForOrg({ + org, + runner_id, + name, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
runner_idyes + +Unique identifier of the self-hosted runner. + +
nameyes + +The name of a self-hosted runner's custom label. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization). diff --git a/docs/actions/removeCustomLabelFromSelfHostedRunnerForRepo.md b/docs/actions/removeCustomLabelFromSelfHostedRunnerForRepo.md new file mode 100644 index 000000000..10fe8e915 --- /dev/null +++ b/docs/actions/removeCustomLabelFromSelfHostedRunnerForRepo.md @@ -0,0 +1,63 @@ +--- +name: Remove a custom label from a self-hosted runner for a repository +example: octokit.rest.actions.removeCustomLabelFromSelfHostedRunnerForRepo({ owner, repo, runner_id, name }) +route: DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name} +scope: actions +type: API method +--- + +# Remove a custom label from a self-hosted runner for a repository + +Remove a custom label from a self-hosted runner configured +in a repository. Returns the remaining labels from the runner. + +This endpoint returns a `404 Not Found` status if the custom label is not +present on the runner. + +You must authenticate using an access token with the `repo` scope to use this +endpoint. + +```js +octokit.rest.actions.removeCustomLabelFromSelfHostedRunnerForRepo({ + owner, + repo, + runner_id, + name, +}); +``` + +## Parameters + + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
runner_idyes + +Unique identifier of the self-hosted runner. + +
nameyes + +The name of a self-hosted runner's custom label. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository). diff --git a/docs/actions/removeSelectedRepoFromOrgSecret.md b/docs/actions/removeSelectedRepoFromOrgSecret.md index 3087c01e7..03d423d65 100644 --- a/docs/actions/removeSelectedRepoFromOrgSecret.md +++ b/docs/actions/removeSelectedRepoFromOrgSecret.md @@ -31,10 +31,12 @@ octokit.rest.actions.removeSelectedRepoFromOrgSecret({ orgyes +The organization name. The name is not case sensitive. + secret_nameyes -secret_name parameter +The name of the secret. repository_idyes diff --git a/docs/actions/reviewPendingDeploymentsForRun.md b/docs/actions/reviewPendingDeploymentsForRun.md index 887bc489d..dfe9cb06a 100644 --- a/docs/actions/reviewPendingDeploymentsForRun.md +++ b/docs/actions/reviewPendingDeploymentsForRun.md @@ -36,13 +36,17 @@ octokit.rest.actions.reviewPendingDeploymentsForRun({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + run_idyes -The id of the workflow run. +The unique identifier of the workflow run. environment_idsyes @@ -52,7 +56,7 @@ The list of environment ids to approve or reject stateyes -Whether to approve or reject deployment to the specified environments. Must be one of: `approved` or `rejected` +Whether to approve or reject deployment to the specified environments. commentyes diff --git a/docs/actions/setAllowedActionsOrganization.md b/docs/actions/setAllowedActionsOrganization.md index 8e67274e8..b2e40390b 100644 --- a/docs/actions/setAllowedActionsOrganization.md +++ b/docs/actions/setAllowedActionsOrganization.md @@ -1,16 +1,16 @@ --- -name: Set allowed actions for an organization +name: Set allowed actions and reusable workflows for an organization example: octokit.rest.actions.setAllowedActionsOrganization({ org }) route: PUT /orgs/{org}/actions/permissions/selected-actions scope: actions type: API method --- -# Set allowed actions for an organization +# Set allowed actions and reusable workflows for an organization -Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." +Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." -If the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings. +If the organization belongs to an enterprise that has `selected` actions and reusable workflows set at the enterprise level, then you cannot override any of the enterprise's allowed actions and reusable workflows settings. To use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the organization. @@ -35,6 +35,8 @@ octokit.rest.actions.setAllowedActionsOrganization({ orgyes +The organization name. The name is not case sensitive. + github_owned_allowedno @@ -43,12 +45,12 @@ Whether GitHub-owned actions are allowed. For example, this includes the actions verified_allowedno -Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators. +Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators. patterns_allowedno -Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`." +Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`." diff --git a/docs/actions/setAllowedActionsRepository.md b/docs/actions/setAllowedActionsRepository.md index 2df8cd6bf..82521c436 100644 --- a/docs/actions/setAllowedActionsRepository.md +++ b/docs/actions/setAllowedActionsRepository.md @@ -1,16 +1,16 @@ --- -name: Set allowed actions for a repository +name: Set allowed actions and reusable workflows for a repository example: octokit.rest.actions.setAllowedActionsRepository({ owner, repo }) route: PUT /repos/{owner}/{repo}/actions/permissions/selected-actions scope: actions type: API method --- -# Set allowed actions for a repository +# Set allowed actions and reusable workflows for a repository -Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." +Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." -If the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings. +If the repository belongs to an organization or enterprise that has `selected` actions and reusable workflows set at the organization or enterprise levels, then you cannot override any of the allowed actions and reusable workflows settings. To use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories. @@ -36,9 +36,13 @@ octokit.rest.actions.setAllowedActionsRepository({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + github_owned_allowedno @@ -47,12 +51,12 @@ Whether GitHub-owned actions are allowed. For example, this includes the actions verified_allowedno -Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators. +Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators. patterns_allowedno -Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`." +Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`." diff --git a/docs/actions/setCustomLabelsForSelfHostedRunnerForOrg.md b/docs/actions/setCustomLabelsForSelfHostedRunnerForOrg.md new file mode 100644 index 000000000..8b14d6a3a --- /dev/null +++ b/docs/actions/setCustomLabelsForSelfHostedRunnerForOrg.md @@ -0,0 +1,53 @@ +--- +name: Set custom labels for a self-hosted runner for an organization +example: octokit.rest.actions.setCustomLabelsForSelfHostedRunnerForOrg({ org, runner_id, labels }) +route: PUT /orgs/{org}/actions/runners/{runner_id}/labels +scope: actions +type: API method +--- + +# Set custom labels for a self-hosted runner for an organization + +Remove all previous custom labels and set the new custom labels for a specific +self-hosted runner configured in an organization. + +You must authenticate using an access token with the `admin:org` scope to use this endpoint. + +```js +octokit.rest.actions.setCustomLabelsForSelfHostedRunnerForOrg({ + org, + runner_id, + labels, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
runner_idyes + +Unique identifier of the self-hosted runner. + +
labelsyes + +The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-an-organization). diff --git a/docs/actions/setCustomLabelsForSelfHostedRunnerForRepo.md b/docs/actions/setCustomLabelsForSelfHostedRunnerForRepo.md new file mode 100644 index 000000000..7077b733b --- /dev/null +++ b/docs/actions/setCustomLabelsForSelfHostedRunnerForRepo.md @@ -0,0 +1,60 @@ +--- +name: Set custom labels for a self-hosted runner for a repository +example: octokit.rest.actions.setCustomLabelsForSelfHostedRunnerForRepo({ owner, repo, runner_id, labels }) +route: PUT /repos/{owner}/{repo}/actions/runners/{runner_id}/labels +scope: actions +type: API method +--- + +# Set custom labels for a self-hosted runner for a repository + +Remove all previous custom labels and set the new custom labels for a specific +self-hosted runner configured in a repository. + +You must authenticate using an access token with the `repo` scope to use this +endpoint. + +```js +octokit.rest.actions.setCustomLabelsForSelfHostedRunnerForRepo({ + owner, + repo, + runner_id, + labels, +}); +``` + +## Parameters + + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
runner_idyes + +Unique identifier of the self-hosted runner. + +
labelsyes + +The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-a-repository). diff --git a/docs/actions/setGithubActionsDefaultWorkflowPermissionsEnterprise.md b/docs/actions/setGithubActionsDefaultWorkflowPermissionsEnterprise.md new file mode 100644 index 000000000..95c993a98 --- /dev/null +++ b/docs/actions/setGithubActionsDefaultWorkflowPermissionsEnterprise.md @@ -0,0 +1,53 @@ +--- +name: Set default workflow permissions for an enterprise +example: octokit.rest.actions.setGithubActionsDefaultWorkflowPermissionsEnterprise({ enterprise }) +route: PUT /enterprises/{enterprise}/actions/permissions/workflow +scope: actions +type: API method +--- + +# Set default workflow permissions for an enterprise + +Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, and sets +whether GitHub Actions can submit approving pull request reviews. For more information, see +"[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." + +You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. +GitHub Apps must have the `enterprise_administration:write` permission to use this endpoint. + +```js +octokit.rest.actions.setGithubActionsDefaultWorkflowPermissionsEnterprise({ + enterprise, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
enterpriseyes + +The slug version of the enterprise name. You can also substitute this value with the enterprise id. + +
default_workflow_permissionsno + +The default workflow permissions granted to the GITHUB_TOKEN when running workflows. + +
can_approve_pull_request_reviewsno + +Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#set-default-workflow-permissions-for-an-enterprise). diff --git a/docs/actions/setGithubActionsDefaultWorkflowPermissionsOrganization.md b/docs/actions/setGithubActionsDefaultWorkflowPermissionsOrganization.md new file mode 100644 index 000000000..46841676f --- /dev/null +++ b/docs/actions/setGithubActionsDefaultWorkflowPermissionsOrganization.md @@ -0,0 +1,52 @@ +--- +name: Set default workflow permissions for an organization +example: octokit.rest.actions.setGithubActionsDefaultWorkflowPermissionsOrganization({ org }) +route: PUT /orgs/{org}/actions/permissions/workflow +scope: actions +type: API method +--- + +# Set default workflow permissions for an organization + +Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions +can submit approving pull request reviews. For more information, see +"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + +You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + +```js +octokit.rest.actions.setGithubActionsDefaultWorkflowPermissionsOrganization({ + org, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
default_workflow_permissionsno + +The default workflow permissions granted to the GITHUB_TOKEN when running workflows. + +
can_approve_pull_request_reviewsno + +Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#set-default-workflow-permissions). diff --git a/docs/actions/setGithubActionsDefaultWorkflowPermissionsRepository.md b/docs/actions/setGithubActionsDefaultWorkflowPermissionsRepository.md new file mode 100644 index 000000000..82d1560a8 --- /dev/null +++ b/docs/actions/setGithubActionsDefaultWorkflowPermissionsRepository.md @@ -0,0 +1,58 @@ +--- +name: Set default workflow permissions for a repository +example: octokit.rest.actions.setGithubActionsDefaultWorkflowPermissionsRepository({ owner, repo }) +route: PUT /repos/{owner}/{repo}/actions/permissions/workflow +scope: actions +type: API method +--- + +# Set default workflow permissions for a repository + +Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions +can submit approving pull request reviews. +For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + +You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API. + +```js +octokit.rest.actions.setGithubActionsDefaultWorkflowPermissionsRepository({ + owner, + repo, +}); +``` + +## Parameters + + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
default_workflow_permissionsno + +The default workflow permissions granted to the GITHUB_TOKEN when running workflows. + +
can_approve_pull_request_reviewsno + +Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#set-default-workflow-permissions-for-a-repository). diff --git a/docs/actions/setGithubActionsPermissionsOrganization.md b/docs/actions/setGithubActionsPermissionsOrganization.md index e6d2a6f49..19b105236 100644 --- a/docs/actions/setGithubActionsPermissionsOrganization.md +++ b/docs/actions/setGithubActionsPermissionsOrganization.md @@ -8,9 +8,9 @@ type: API method # Set GitHub Actions permissions for an organization -Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization. +Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. -If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization. +If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions and reusable workflows, then you cannot override them for the organization. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. @@ -34,15 +34,17 @@ octokit.rest.actions.setGithubActionsPermissionsOrganization({ orgyes +The organization name. The name is not case sensitive. + enabled_repositoriesyes -The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`. +The policy that controls the repositories in the organization that are allowed to run GitHub Actions. allowed_actionsno -The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`. +The permissions policy that controls the actions and reusable workflows that are allowed to run. diff --git a/docs/actions/setGithubActionsPermissionsRepository.md b/docs/actions/setGithubActionsPermissionsRepository.md index f63c26cee..6bdb36013 100644 --- a/docs/actions/setGithubActionsPermissionsRepository.md +++ b/docs/actions/setGithubActionsPermissionsRepository.md @@ -8,9 +8,9 @@ type: API method # Set GitHub Actions permissions for a repository -Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. +Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository. -If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository. +If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions and reusable workflows, then you cannot override them for the repository. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. @@ -35,9 +35,13 @@ octokit.rest.actions.setGithubActionsPermissionsRepository({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + enabledyes @@ -46,7 +50,7 @@ Whether GitHub Actions is enabled on the repository. allowed_actionsno -The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`. +The permissions policy that controls the actions and reusable workflows that are allowed to run. diff --git a/docs/actions/setSelectedReposForOrgSecret.md b/docs/actions/setSelectedReposForOrgSecret.md index 57ff0e661..b19bf3ded 100644 --- a/docs/actions/setSelectedReposForOrgSecret.md +++ b/docs/actions/setSelectedReposForOrgSecret.md @@ -31,10 +31,12 @@ octokit.rest.actions.setSelectedReposForOrgSecret({ orgyes +The organization name. The name is not case sensitive. + secret_nameyes -secret_name parameter +The name of the secret. selected_repository_idsyes diff --git a/docs/actions/setSelectedRepositoriesEnabledGithubActionsOrganization.md b/docs/actions/setSelectedRepositoriesEnabledGithubActionsOrganization.md index ad454ac2e..d28f294cf 100644 --- a/docs/actions/setSelectedRepositoriesEnabledGithubActionsOrganization.md +++ b/docs/actions/setSelectedRepositoriesEnabledGithubActionsOrganization.md @@ -32,6 +32,8 @@ octokit.rest.actions.setSelectedRepositoriesEnabledGithubActionsOrganization({ orgyes +The organization name. The name is not case sensitive. + selected_repository_idsyes diff --git a/docs/actions/setWorkflowAccessToRepository.md b/docs/actions/setWorkflowAccessToRepository.md new file mode 100644 index 000000000..367ac1d38 --- /dev/null +++ b/docs/actions/setWorkflowAccessToRepository.md @@ -0,0 +1,55 @@ +--- +name: Set the level of access for workflows outside of the repository +example: octokit.rest.actions.setWorkflowAccessToRepository({ owner, repo, access_level }) +route: PUT /repos/{owner}/{repo}/actions/permissions/access +scope: actions +type: API method +--- + +# Set the level of access for workflows outside of the repository + +Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. +This endpoint only applies to internal repositories. For more information, see "[Managing GitHub Actions settings for a repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." + +You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the +repository `administration` permission to use this endpoint. + +```js +octokit.rest.actions.setWorkflowAccessToRepository({ + owner, + repo, + access_level, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
access_levelyes + +Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the +repository. `none` means access is only possible from workflows in this repository. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#set-workflow-access-to-a-repository). diff --git a/docs/activity/checkRepoIsStarredByAuthenticatedUser.md b/docs/activity/checkRepoIsStarredByAuthenticatedUser.md index d51d644ac..893983b26 100644 --- a/docs/activity/checkRepoIsStarredByAuthenticatedUser.md +++ b/docs/activity/checkRepoIsStarredByAuthenticatedUser.md @@ -28,9 +28,13 @@ octokit.rest.activity.checkRepoIsStarredByAuthenticatedUser({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/activity/deleteRepoSubscription.md b/docs/activity/deleteRepoSubscription.md index e6a328a70..d518a2c8e 100644 --- a/docs/activity/deleteRepoSubscription.md +++ b/docs/activity/deleteRepoSubscription.md @@ -30,9 +30,13 @@ octokit.rest.activity.deleteRepoSubscription({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/activity/deleteThreadSubscription.md b/docs/activity/deleteThreadSubscription.md index 74afb7e40..963298876 100644 --- a/docs/activity/deleteThreadSubscription.md +++ b/docs/activity/deleteThreadSubscription.md @@ -29,7 +29,7 @@ octokit.rest.activity.deleteThreadSubscription({ thread_idyes -thread_id parameter +The unique identifier of the thread. diff --git a/docs/activity/getRepoSubscription.md b/docs/activity/getRepoSubscription.md index e40fef111..0b33ac9e0 100644 --- a/docs/activity/getRepoSubscription.md +++ b/docs/activity/getRepoSubscription.md @@ -28,9 +28,13 @@ octokit.rest.activity.getRepoSubscription({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/activity/getThread.md b/docs/activity/getThread.md index 471461c5f..b697e45ac 100644 --- a/docs/activity/getThread.md +++ b/docs/activity/getThread.md @@ -27,7 +27,7 @@ octokit.rest.activity.getThread({ thread_idyes -thread_id parameter +The unique identifier of the thread. diff --git a/docs/activity/getThreadSubscriptionForAuthenticatedUser.md b/docs/activity/getThreadSubscriptionForAuthenticatedUser.md index 35cb225ad..fdd8d2bbb 100644 --- a/docs/activity/getThreadSubscriptionForAuthenticatedUser.md +++ b/docs/activity/getThreadSubscriptionForAuthenticatedUser.md @@ -31,7 +31,7 @@ octokit.rest.activity.getThreadSubscriptionForAuthenticatedUser({ thread_idyes -thread_id parameter +The unique identifier of the thread. diff --git a/docs/activity/listEventsForAuthenticatedUser.md b/docs/activity/listEventsForAuthenticatedUser.md index b48ca60ee..e2f4412e1 100644 --- a/docs/activity/listEventsForAuthenticatedUser.md +++ b/docs/activity/listEventsForAuthenticatedUser.md @@ -29,10 +29,12 @@ octokit.rest.activity.listEventsForAuthenticatedUser({ usernameyes +The handle for the GitHub user account. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/activity/listNotificationsForAuthenticatedUser.md b/docs/activity/listNotificationsForAuthenticatedUser.md index 009cbd4cc..c007b3edf 100644 --- a/docs/activity/listNotificationsForAuthenticatedUser.md +++ b/docs/activity/listNotificationsForAuthenticatedUser.md @@ -47,7 +47,7 @@ Only show notifications updated before the given time. This is a timestamp in [I per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/activity/listOrgEventsForAuthenticatedUser.md b/docs/activity/listOrgEventsForAuthenticatedUser.md index 1ab1356b5..92cecdb03 100644 --- a/docs/activity/listOrgEventsForAuthenticatedUser.md +++ b/docs/activity/listOrgEventsForAuthenticatedUser.md @@ -30,13 +30,17 @@ octokit.rest.activity.listOrgEventsForAuthenticatedUser({ usernameyes +The handle for the GitHub user account. + orgyes +The organization name. The name is not case sensitive. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/activity/listPublicEvents.md b/docs/activity/listPublicEvents.md index 860a3619a..e538fb21e 100644 --- a/docs/activity/listPublicEvents.md +++ b/docs/activity/listPublicEvents.md @@ -27,7 +27,7 @@ octokit.rest.activity.listPublicEvents(); per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/activity/listPublicEventsForRepoNetwork.md b/docs/activity/listPublicEventsForRepoNetwork.md index 632a306d7..f7f8bb07b 100644 --- a/docs/activity/listPublicEventsForRepoNetwork.md +++ b/docs/activity/listPublicEventsForRepoNetwork.md @@ -28,13 +28,17 @@ octokit.rest.activity.listPublicEventsForRepoNetwork({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/activity/listPublicEventsForUser.md b/docs/activity/listPublicEventsForUser.md index 09e8a1ea4..6804c84ed 100644 --- a/docs/activity/listPublicEventsForUser.md +++ b/docs/activity/listPublicEventsForUser.md @@ -27,10 +27,12 @@ octokit.rest.activity.listPublicEventsForUser({ usernameyes +The handle for the GitHub user account. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/activity/listPublicOrgEvents.md b/docs/activity/listPublicOrgEvents.md index 06b5ef617..7935dc63a 100644 --- a/docs/activity/listPublicOrgEvents.md +++ b/docs/activity/listPublicOrgEvents.md @@ -27,10 +27,12 @@ octokit.rest.activity.listPublicOrgEvents({ orgyes +The organization name. The name is not case sensitive. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/activity/listReceivedEventsForUser.md b/docs/activity/listReceivedEventsForUser.md index a6deffe18..ab2e147f5 100644 --- a/docs/activity/listReceivedEventsForUser.md +++ b/docs/activity/listReceivedEventsForUser.md @@ -29,10 +29,12 @@ octokit.rest.activity.listReceivedEventsForUser({ usernameyes +The handle for the GitHub user account. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/activity/listReceivedPublicEventsForUser.md b/docs/activity/listReceivedPublicEventsForUser.md index 7f98a5443..e317ecae6 100644 --- a/docs/activity/listReceivedPublicEventsForUser.md +++ b/docs/activity/listReceivedPublicEventsForUser.md @@ -27,10 +27,12 @@ octokit.rest.activity.listReceivedPublicEventsForUser({ usernameyes +The handle for the GitHub user account. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/activity/listRepoEvents.md b/docs/activity/listRepoEvents.md index b258e3359..6a8d32a1e 100644 --- a/docs/activity/listRepoEvents.md +++ b/docs/activity/listRepoEvents.md @@ -28,13 +28,17 @@ octokit.rest.activity.listRepoEvents({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/activity/listRepoNotificationsForAuthenticatedUser.md b/docs/activity/listRepoNotificationsForAuthenticatedUser.md index 010a88691..2cc602636 100644 --- a/docs/activity/listRepoNotificationsForAuthenticatedUser.md +++ b/docs/activity/listRepoNotificationsForAuthenticatedUser.md @@ -30,9 +30,13 @@ octokit.rest.activity.listRepoNotificationsForAuthenticatedUser({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + allno @@ -56,7 +60,7 @@ Only show notifications updated before the given time. This is a timestamp in [I per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/activity/listReposStarredByAuthenticatedUser.md b/docs/activity/listReposStarredByAuthenticatedUser.md index f69c9cbb0..34af2dbee 100644 --- a/docs/activity/listReposStarredByAuthenticatedUser.md +++ b/docs/activity/listReposStarredByAuthenticatedUser.md @@ -29,17 +29,17 @@ octokit.rest.activity.listReposStarredByAuthenticatedUser(); sortno -One of `created` (when the repository was starred) or `updated` (when it was last pushed to). +The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. directionno -One of `asc` (ascending) or `desc` (descending). +The direction to sort the results by. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/activity/listReposStarredByUser.md b/docs/activity/listReposStarredByUser.md index ab6c0c055..40e95fb38 100644 --- a/docs/activity/listReposStarredByUser.md +++ b/docs/activity/listReposStarredByUser.md @@ -31,20 +31,22 @@ octokit.rest.activity.listReposStarredByUser({ usernameyes +The handle for the GitHub user account. + sortno -One of `created` (when the repository was starred) or `updated` (when it was last pushed to). +The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. directionno -One of `asc` (ascending) or `desc` (descending). +The direction to sort the results by. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/activity/listReposWatchedByUser.md b/docs/activity/listReposWatchedByUser.md index bece8d892..4857b105a 100644 --- a/docs/activity/listReposWatchedByUser.md +++ b/docs/activity/listReposWatchedByUser.md @@ -29,10 +29,12 @@ octokit.rest.activity.listReposWatchedByUser({ usernameyes +The handle for the GitHub user account. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/activity/listStargazersForRepo.md b/docs/activity/listStargazersForRepo.md index 1b949fbcd..a734d29c4 100644 --- a/docs/activity/listStargazersForRepo.md +++ b/docs/activity/listStargazersForRepo.md @@ -32,13 +32,17 @@ octokit.rest.activity.listStargazersForRepo({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/activity/listWatchedReposForAuthenticatedUser.md b/docs/activity/listWatchedReposForAuthenticatedUser.md index befad754e..17d55c39a 100644 --- a/docs/activity/listWatchedReposForAuthenticatedUser.md +++ b/docs/activity/listWatchedReposForAuthenticatedUser.md @@ -27,7 +27,7 @@ octokit.rest.activity.listWatchedReposForAuthenticatedUser(); per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/activity/listWatchersForRepo.md b/docs/activity/listWatchersForRepo.md index d3a65f32c..714d8e1ae 100644 --- a/docs/activity/listWatchersForRepo.md +++ b/docs/activity/listWatchersForRepo.md @@ -30,13 +30,17 @@ octokit.rest.activity.listWatchersForRepo({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/activity/markRepoNotificationsAsRead.md b/docs/activity/markRepoNotificationsAsRead.md index be36756ef..b6cae2b07 100644 --- a/docs/activity/markRepoNotificationsAsRead.md +++ b/docs/activity/markRepoNotificationsAsRead.md @@ -30,9 +30,13 @@ octokit.rest.activity.markRepoNotificationsAsRead({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + last_read_atno diff --git a/docs/activity/markThreadAsRead.md b/docs/activity/markThreadAsRead.md index f514458a4..7e0e7b8c8 100644 --- a/docs/activity/markThreadAsRead.md +++ b/docs/activity/markThreadAsRead.md @@ -27,7 +27,7 @@ octokit.rest.activity.markThreadAsRead({ thread_idyes -thread_id parameter +The unique identifier of the thread. diff --git a/docs/activity/setRepoSubscription.md b/docs/activity/setRepoSubscription.md index 75441266f..c82fa20e4 100644 --- a/docs/activity/setRepoSubscription.md +++ b/docs/activity/setRepoSubscription.md @@ -30,9 +30,13 @@ octokit.rest.activity.setRepoSubscription({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + subscribedno diff --git a/docs/activity/setThreadSubscription.md b/docs/activity/setThreadSubscription.md index 9cf61524c..b8ae9164c 100644 --- a/docs/activity/setThreadSubscription.md +++ b/docs/activity/setThreadSubscription.md @@ -33,7 +33,7 @@ octokit.rest.activity.setThreadSubscription({ thread_idyes -thread_id parameter +The unique identifier of the thread. ignoredno diff --git a/docs/activity/starRepoForAuthenticatedUser.md b/docs/activity/starRepoForAuthenticatedUser.md index a7d0159ec..29acab1cb 100644 --- a/docs/activity/starRepoForAuthenticatedUser.md +++ b/docs/activity/starRepoForAuthenticatedUser.md @@ -30,9 +30,13 @@ octokit.rest.activity.starRepoForAuthenticatedUser({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/activity/unstarRepoForAuthenticatedUser.md b/docs/activity/unstarRepoForAuthenticatedUser.md index e0ab0aec2..9d5699433 100644 --- a/docs/activity/unstarRepoForAuthenticatedUser.md +++ b/docs/activity/unstarRepoForAuthenticatedUser.md @@ -28,9 +28,13 @@ octokit.rest.activity.unstarRepoForAuthenticatedUser({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/apps/addRepoToInstallation.md b/docs/apps/addRepoToInstallation.md index d142527f4..29292fdab 100644 --- a/docs/apps/addRepoToInstallation.md +++ b/docs/apps/addRepoToInstallation.md @@ -34,11 +34,13 @@ octokit.rest.apps.addRepoToInstallation({ installation_idyes -installation_id parameter +The unique identifier of the installation. repository_idyes +The unique identifier of the repository. + diff --git a/docs/apps/addRepoToInstallationForAuthenticatedUser.md b/docs/apps/addRepoToInstallationForAuthenticatedUser.md index b1b7d32bd..a81399591 100644 --- a/docs/apps/addRepoToInstallationForAuthenticatedUser.md +++ b/docs/apps/addRepoToInstallationForAuthenticatedUser.md @@ -32,11 +32,13 @@ octokit.rest.apps.addRepoToInstallationForAuthenticatedUser({ installation_idyes -installation_id parameter +The unique identifier of the installation. repository_idyes +The unique identifier of the repository. + diff --git a/docs/apps/checkToken.md b/docs/apps/checkToken.md index 836bf235e..b6ca4ecd8 100644 --- a/docs/apps/checkToken.md +++ b/docs/apps/checkToken.md @@ -30,7 +30,7 @@ octokit.rest.apps.checkToken({ client_idyes -The client ID of your GitHub app. +The client ID of the GitHub app. access_tokenyes diff --git a/docs/apps/createContentAttachment.md b/docs/apps/createContentAttachment.md deleted file mode 100644 index 81c3ac5a5..000000000 --- a/docs/apps/createContentAttachment.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -name: Create a content attachment -example: octokit.rest.apps.createContentAttachment({ content_reference_id, title, body }) -route: POST /content_references/{content_reference_id}/attachments -scope: apps -type: API method ---- - -# Create a content attachment - -**Deprecated:** use `apps.createContentAttachmentForRepo()` (`POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments`) instead. Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment. - -The app must create a content attachment within six hours of the content reference URL being posted. See "[Using content attachments](https://docs.github.com/apps/using-content-attachments/)" for details about content attachments. - -You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. - -```js -octokit.rest.apps.createContentAttachment({ - content_reference_id, - title, - body, -}); -``` - -## Parameters - - - - - - - - - - - - - - -
namerequireddescription
content_reference_idyes - -
titleyes - -The title of the attachment - -
bodyyes - -The body of the attachment - -
- -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#create-a-content-attachment). diff --git a/docs/apps/createContentAttachmentForRepo.md b/docs/apps/createContentAttachmentForRepo.md deleted file mode 100644 index f24566a8a..000000000 --- a/docs/apps/createContentAttachmentForRepo.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -name: Create a content attachment -example: octokit.rest.apps.createContentAttachmentForRepo({ owner, repo, content_reference_id, title, body }) -route: POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments -scope: apps -type: API method ---- - -# Create a content attachment - -Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment. - -The app must create a content attachment within six hours of the content reference URL being posted. See "[Using content attachments](https://docs.github.com/apps/using-content-attachments/)" for details about content attachments. - -You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. - -```js -octokit.rest.apps.createContentAttachmentForRepo({ - owner, - repo, - content_reference_id, - title, - body, -}); -``` - -## Parameters - - - - - - - - - - - - - - - - -
namerequireddescription
owneryes - -The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event. - -
repoyes - -The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event. - -
content_reference_idyes - -The `id` of the `content_reference` event. - -
titleyes - -The title of the attachment - -
bodyyes - -The body of the attachment - -
- -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#create-a-content-attachment). diff --git a/docs/apps/createInstallationAccessToken.md b/docs/apps/createInstallationAccessToken.md index ee4c26d15..294496b1f 100644 --- a/docs/apps/createInstallationAccessToken.md +++ b/docs/apps/createInstallationAccessToken.md @@ -31,7 +31,7 @@ octokit.rest.apps.createInstallationAccessToken({ installation_idyes -installation_id parameter +The unique identifier of the installation. repositoriesno @@ -51,157 +51,152 @@ The permissions granted to the user-to-server access token. permissions.actionsno -The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Can be one of: `read` or `write`. +The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. permissions.administrationno -The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. Can be one of: `read` or `write`. +The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. permissions.checksno -The level of permission to grant the access token for checks on code. Can be one of: `read` or `write`. - - -permissions.content_referencesno - -The level of permission to grant the access token for notification of content references and creation content attachments. Can be one of: `read` or `write`. +The level of permission to grant the access token for checks on code. permissions.contentsno -The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. Can be one of: `read` or `write`. +The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. permissions.deploymentsno -The level of permission to grant the access token for deployments and deployment statuses. Can be one of: `read` or `write`. +The level of permission to grant the access token for deployments and deployment statuses. permissions.environmentsno -The level of permission to grant the access token for managing repository environments. Can be one of: `read` or `write`. +The level of permission to grant the access token for managing repository environments. permissions.issuesno -The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. Can be one of: `read` or `write`. +The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. permissions.metadatano -The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. Can be one of: `read` or `write`. +The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. permissions.packagesno -The level of permission to grant the access token for packages published to GitHub Packages. Can be one of: `read` or `write`. +The level of permission to grant the access token for packages published to GitHub Packages. permissions.pagesno -The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. Can be one of: `read` or `write`. +The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. permissions.pull_requestsno -The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. Can be one of: `read` or `write`. +The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. permissions.repository_hooksno -The level of permission to grant the access token to manage the post-receive hooks for a repository. Can be one of: `read` or `write`. +The level of permission to grant the access token to manage the post-receive hooks for a repository. permissions.repository_projectsno -The level of permission to grant the access token to manage repository projects, columns, and cards. Can be one of: `read`, `write`, or `admin`. +The level of permission to grant the access token to manage repository projects, columns, and cards. permissions.secret_scanning_alertsno -The level of permission to grant the access token to view and manage secret scanning alerts. Can be one of: `read` or `write`. +The level of permission to grant the access token to view and manage secret scanning alerts. permissions.secretsno -The level of permission to grant the access token to manage repository secrets. Can be one of: `read` or `write`. +The level of permission to grant the access token to manage repository secrets. permissions.security_eventsno -The level of permission to grant the access token to view and manage security events like code scanning alerts. Can be one of: `read` or `write`. +The level of permission to grant the access token to view and manage security events like code scanning alerts. permissions.single_fileno -The level of permission to grant the access token to manage just a single file. Can be one of: `read` or `write`. +The level of permission to grant the access token to manage just a single file. permissions.statusesno -The level of permission to grant the access token for commit statuses. Can be one of: `read` or `write`. +The level of permission to grant the access token for commit statuses. permissions.vulnerability_alertsno -The level of permission to grant the access token to retrieve Dependabot alerts. Can be one of: `read`. +The level of permission to grant the access token to manage Dependabot alerts. permissions.workflowsno -The level of permission to grant the access token to update GitHub Actions workflow files. Can be one of: `write`. +The level of permission to grant the access token to update GitHub Actions workflow files. permissions.membersno -The level of permission to grant the access token for organization teams and members. Can be one of: `read` or `write`. +The level of permission to grant the access token for organization teams and members. permissions.organization_administrationno -The level of permission to grant the access token to manage access to an organization. Can be one of: `read` or `write`. +The level of permission to grant the access token to manage access to an organization. permissions.organization_hooksno -The level of permission to grant the access token to manage the post-receive hooks for an organization. Can be one of: `read` or `write`. +The level of permission to grant the access token to manage the post-receive hooks for an organization. permissions.organization_planno -The level of permission to grant the access token for viewing an organization's plan. Can be one of: `read`. +The level of permission to grant the access token for viewing an organization's plan. permissions.organization_projectsno -The level of permission to grant the access token to manage organization projects, columns, and cards. Can be one of: `read`, `write`, or `admin`. +The level of permission to grant the access token to manage organization projects and projects beta (where available). permissions.organization_packagesno -The level of permission to grant the access token for organization packages published to GitHub Packages. Can be one of: `read` or `write`. +The level of permission to grant the access token for organization packages published to GitHub Packages. permissions.organization_secretsno -The level of permission to grant the access token to manage organization secrets. Can be one of: `read` or `write`. +The level of permission to grant the access token to manage organization secrets. permissions.organization_self_hosted_runnersno -The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. Can be one of: `read` or `write`. +The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. permissions.organization_user_blockingno -The level of permission to grant the access token to view and manage users blocked by the organization. Can be one of: `read` or `write`. +The level of permission to grant the access token to view and manage users blocked by the organization. permissions.team_discussionsno -The level of permission to grant the access token to manage team discussions and related comments. Can be one of: `read` or `write`. +The level of permission to grant the access token to manage team discussions and related comments. diff --git a/docs/apps/deleteAuthorization.md b/docs/apps/deleteAuthorization.md index dfcc9a9e4..bf0bbeb8a 100644 --- a/docs/apps/deleteAuthorization.md +++ b/docs/apps/deleteAuthorization.md @@ -31,7 +31,7 @@ octokit.rest.apps.deleteAuthorization({ client_idyes -The client ID of your GitHub app. +The client ID of the GitHub app. access_tokenyes diff --git a/docs/apps/deleteInstallation.md b/docs/apps/deleteInstallation.md index 059002ddc..9f76e9e2c 100644 --- a/docs/apps/deleteInstallation.md +++ b/docs/apps/deleteInstallation.md @@ -31,7 +31,7 @@ octokit.rest.apps.deleteInstallation({ installation_idyes -installation_id parameter +The unique identifier of the installation. diff --git a/docs/apps/deleteToken.md b/docs/apps/deleteToken.md index 968ee7e6e..ebfc61a6e 100644 --- a/docs/apps/deleteToken.md +++ b/docs/apps/deleteToken.md @@ -30,7 +30,7 @@ octokit.rest.apps.deleteToken({ client_idyes -The client ID of your GitHub app. +The client ID of the GitHub app. access_tokenyes diff --git a/docs/apps/getBySlug.md b/docs/apps/getBySlug.md index cd646d787..15a4fc9df 100644 --- a/docs/apps/getBySlug.md +++ b/docs/apps/getBySlug.md @@ -10,7 +10,7 @@ type: API method **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). -If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. +If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. ```js octokit.rest.apps.getBySlug({ diff --git a/docs/apps/getInstallation.md b/docs/apps/getInstallation.md index 02c29424b..e904a4770 100644 --- a/docs/apps/getInstallation.md +++ b/docs/apps/getInstallation.md @@ -8,7 +8,7 @@ type: API method # Get an installation for the authenticated app -Enables an authenticated GitHub App to find an installation's information using the installation id. The installation's account type (`target_type`) will be either an organization or a user account, depending which account the repository belongs to. +Enables an authenticated GitHub App to find an installation's information using the installation id. You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. @@ -31,7 +31,7 @@ octokit.rest.apps.getInstallation({ installation_idyes -installation_id parameter +The unique identifier of the installation. diff --git a/docs/apps/getOrgInstallation.md b/docs/apps/getOrgInstallation.md index 6aedbe388..3dcb432e6 100644 --- a/docs/apps/getOrgInstallation.md +++ b/docs/apps/getOrgInstallation.md @@ -31,6 +31,8 @@ octokit.rest.apps.getOrgInstallation({ orgyes +The organization name. The name is not case sensitive. + diff --git a/docs/apps/getRepoInstallation.md b/docs/apps/getRepoInstallation.md index a6c07a471..675760c00 100644 --- a/docs/apps/getRepoInstallation.md +++ b/docs/apps/getRepoInstallation.md @@ -32,9 +32,13 @@ octokit.rest.apps.getRepoInstallation({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/apps/getUserInstallation.md b/docs/apps/getUserInstallation.md index f965f459b..5368e1d22 100644 --- a/docs/apps/getUserInstallation.md +++ b/docs/apps/getUserInstallation.md @@ -31,6 +31,8 @@ octokit.rest.apps.getUserInstallation({ usernameyes +The handle for the GitHub user account. + diff --git a/docs/apps/listAccountsForPlan.md b/docs/apps/listAccountsForPlan.md index ddd094b0a..600d146e7 100644 --- a/docs/apps/listAccountsForPlan.md +++ b/docs/apps/listAccountsForPlan.md @@ -31,22 +31,22 @@ octokit.rest.apps.listAccountsForPlan({ plan_idyes -plan_id parameter +The unique identifier of the plan. sortno -One of `created` (when the repository was starred) or `updated` (when it was last pushed to). +The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. directionno -To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. +To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/apps/listAccountsForPlanStubbed.md b/docs/apps/listAccountsForPlanStubbed.md index 4d4a93d6c..979a1ffc9 100644 --- a/docs/apps/listAccountsForPlanStubbed.md +++ b/docs/apps/listAccountsForPlanStubbed.md @@ -31,22 +31,22 @@ octokit.rest.apps.listAccountsForPlanStubbed({ plan_idyes -plan_id parameter +The unique identifier of the plan. sortno -One of `created` (when the repository was starred) or `updated` (when it was last pushed to). +The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. directionno -To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. +To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/apps/listInstallationReposForAuthenticatedUser.md b/docs/apps/listInstallationReposForAuthenticatedUser.md index 828a126c2..2320b1583 100644 --- a/docs/apps/listInstallationReposForAuthenticatedUser.md +++ b/docs/apps/listInstallationReposForAuthenticatedUser.md @@ -35,12 +35,12 @@ octokit.rest.apps.listInstallationReposForAuthenticatedUser({ installation_idyes -installation_id parameter +The unique identifier of the installation. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/apps/listInstallations.md b/docs/apps/listInstallations.md index 9cd228a8b..7c39682ef 100644 --- a/docs/apps/listInstallations.md +++ b/docs/apps/listInstallations.md @@ -29,7 +29,7 @@ octokit.rest.apps.listInstallations(); per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/apps/listInstallationsForAuthenticatedUser.md b/docs/apps/listInstallationsForAuthenticatedUser.md index 7ef5b1592..39660af69 100644 --- a/docs/apps/listInstallationsForAuthenticatedUser.md +++ b/docs/apps/listInstallationsForAuthenticatedUser.md @@ -33,7 +33,7 @@ octokit.rest.apps.listInstallationsForAuthenticatedUser(); per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/apps/listPlans.md b/docs/apps/listPlans.md index d06eb6e36..931a420b9 100644 --- a/docs/apps/listPlans.md +++ b/docs/apps/listPlans.md @@ -29,7 +29,7 @@ octokit.rest.apps.listPlans(); per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/apps/listPlansStubbed.md b/docs/apps/listPlansStubbed.md index be711a135..88a4e12da 100644 --- a/docs/apps/listPlansStubbed.md +++ b/docs/apps/listPlansStubbed.md @@ -29,7 +29,7 @@ octokit.rest.apps.listPlansStubbed(); per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/apps/listReposAccessibleToInstallation.md b/docs/apps/listReposAccessibleToInstallation.md index afb938f5c..1679aea5a 100644 --- a/docs/apps/listReposAccessibleToInstallation.md +++ b/docs/apps/listReposAccessibleToInstallation.md @@ -29,7 +29,7 @@ octokit.rest.apps.listReposAccessibleToInstallation(); per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/apps/listSubscriptionsForAuthenticatedUser.md b/docs/apps/listSubscriptionsForAuthenticatedUser.md index 9113e1969..b8cdb92c2 100644 --- a/docs/apps/listSubscriptionsForAuthenticatedUser.md +++ b/docs/apps/listSubscriptionsForAuthenticatedUser.md @@ -27,7 +27,7 @@ octokit.rest.apps.listSubscriptionsForAuthenticatedUser(); per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/apps/listSubscriptionsForAuthenticatedUserStubbed.md b/docs/apps/listSubscriptionsForAuthenticatedUserStubbed.md index 1e87c9935..64d37496d 100644 --- a/docs/apps/listSubscriptionsForAuthenticatedUserStubbed.md +++ b/docs/apps/listSubscriptionsForAuthenticatedUserStubbed.md @@ -27,7 +27,7 @@ octokit.rest.apps.listSubscriptionsForAuthenticatedUserStubbed(); per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/apps/listWebhookDeliveries.md b/docs/apps/listWebhookDeliveries.md index 3647b895b..14297e948 100644 --- a/docs/apps/listWebhookDeliveries.md +++ b/docs/apps/listWebhookDeliveries.md @@ -29,7 +29,7 @@ octokit.rest.apps.listWebhookDeliveries(); per_pageno -Results per page (max 100) +The number of results per page (max 100). cursorno diff --git a/docs/apps/removeRepoFromInstallation.md b/docs/apps/removeRepoFromInstallation.md index c32c42c4d..d90ead3ac 100644 --- a/docs/apps/removeRepoFromInstallation.md +++ b/docs/apps/removeRepoFromInstallation.md @@ -34,11 +34,13 @@ octokit.rest.apps.removeRepoFromInstallation({ installation_idyes -installation_id parameter +The unique identifier of the installation. repository_idyes +The unique identifier of the repository. + diff --git a/docs/apps/removeRepoFromInstallationForAuthenticatedUser.md b/docs/apps/removeRepoFromInstallationForAuthenticatedUser.md index 1fa66c83e..fe349979d 100644 --- a/docs/apps/removeRepoFromInstallationForAuthenticatedUser.md +++ b/docs/apps/removeRepoFromInstallationForAuthenticatedUser.md @@ -32,11 +32,13 @@ octokit.rest.apps.removeRepoFromInstallationForAuthenticatedUser({ installation_idyes -installation_id parameter +The unique identifier of the installation. repository_idyes +The unique identifier of the repository. + diff --git a/docs/apps/resetToken.md b/docs/apps/resetToken.md index e8cc53870..0ba925916 100644 --- a/docs/apps/resetToken.md +++ b/docs/apps/resetToken.md @@ -30,7 +30,7 @@ octokit.rest.apps.resetToken({ client_idyes -The client ID of your GitHub app. +The client ID of the GitHub app. access_tokenyes diff --git a/docs/apps/scopeToken.md b/docs/apps/scopeToken.md index d028628ad..22ab3771d 100644 --- a/docs/apps/scopeToken.md +++ b/docs/apps/scopeToken.md @@ -30,7 +30,7 @@ octokit.rest.apps.scopeToken({ client_idyes -The client ID of your GitHub app. +The client ID of the GitHub app. access_tokenyes @@ -65,157 +65,152 @@ The permissions granted to the user-to-server access token. permissions.actionsno -The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Can be one of: `read` or `write`. +The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. permissions.administrationno -The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. Can be one of: `read` or `write`. +The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. permissions.checksno -The level of permission to grant the access token for checks on code. Can be one of: `read` or `write`. - - -permissions.content_referencesno - -The level of permission to grant the access token for notification of content references and creation content attachments. Can be one of: `read` or `write`. +The level of permission to grant the access token for checks on code. permissions.contentsno -The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. Can be one of: `read` or `write`. +The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. permissions.deploymentsno -The level of permission to grant the access token for deployments and deployment statuses. Can be one of: `read` or `write`. +The level of permission to grant the access token for deployments and deployment statuses. permissions.environmentsno -The level of permission to grant the access token for managing repository environments. Can be one of: `read` or `write`. +The level of permission to grant the access token for managing repository environments. permissions.issuesno -The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. Can be one of: `read` or `write`. +The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. permissions.metadatano -The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. Can be one of: `read` or `write`. +The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. permissions.packagesno -The level of permission to grant the access token for packages published to GitHub Packages. Can be one of: `read` or `write`. +The level of permission to grant the access token for packages published to GitHub Packages. permissions.pagesno -The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. Can be one of: `read` or `write`. +The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. permissions.pull_requestsno -The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. Can be one of: `read` or `write`. +The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. permissions.repository_hooksno -The level of permission to grant the access token to manage the post-receive hooks for a repository. Can be one of: `read` or `write`. +The level of permission to grant the access token to manage the post-receive hooks for a repository. permissions.repository_projectsno -The level of permission to grant the access token to manage repository projects, columns, and cards. Can be one of: `read`, `write`, or `admin`. +The level of permission to grant the access token to manage repository projects, columns, and cards. permissions.secret_scanning_alertsno -The level of permission to grant the access token to view and manage secret scanning alerts. Can be one of: `read` or `write`. +The level of permission to grant the access token to view and manage secret scanning alerts. permissions.secretsno -The level of permission to grant the access token to manage repository secrets. Can be one of: `read` or `write`. +The level of permission to grant the access token to manage repository secrets. permissions.security_eventsno -The level of permission to grant the access token to view and manage security events like code scanning alerts. Can be one of: `read` or `write`. +The level of permission to grant the access token to view and manage security events like code scanning alerts. permissions.single_fileno -The level of permission to grant the access token to manage just a single file. Can be one of: `read` or `write`. +The level of permission to grant the access token to manage just a single file. permissions.statusesno -The level of permission to grant the access token for commit statuses. Can be one of: `read` or `write`. +The level of permission to grant the access token for commit statuses. permissions.vulnerability_alertsno -The level of permission to grant the access token to retrieve Dependabot alerts. Can be one of: `read`. +The level of permission to grant the access token to manage Dependabot alerts. permissions.workflowsno -The level of permission to grant the access token to update GitHub Actions workflow files. Can be one of: `write`. +The level of permission to grant the access token to update GitHub Actions workflow files. permissions.membersno -The level of permission to grant the access token for organization teams and members. Can be one of: `read` or `write`. +The level of permission to grant the access token for organization teams and members. permissions.organization_administrationno -The level of permission to grant the access token to manage access to an organization. Can be one of: `read` or `write`. +The level of permission to grant the access token to manage access to an organization. permissions.organization_hooksno -The level of permission to grant the access token to manage the post-receive hooks for an organization. Can be one of: `read` or `write`. +The level of permission to grant the access token to manage the post-receive hooks for an organization. permissions.organization_planno -The level of permission to grant the access token for viewing an organization's plan. Can be one of: `read`. +The level of permission to grant the access token for viewing an organization's plan. permissions.organization_projectsno -The level of permission to grant the access token to manage organization projects, columns, and cards. Can be one of: `read`, `write`, or `admin`. +The level of permission to grant the access token to manage organization projects and projects beta (where available). permissions.organization_packagesno -The level of permission to grant the access token for organization packages published to GitHub Packages. Can be one of: `read` or `write`. +The level of permission to grant the access token for organization packages published to GitHub Packages. permissions.organization_secretsno -The level of permission to grant the access token to manage organization secrets. Can be one of: `read` or `write`. +The level of permission to grant the access token to manage organization secrets. permissions.organization_self_hosted_runnersno -The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. Can be one of: `read` or `write`. +The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. permissions.organization_user_blockingno -The level of permission to grant the access token to view and manage users blocked by the organization. Can be one of: `read` or `write`. +The level of permission to grant the access token to view and manage users blocked by the organization. permissions.team_discussionsno -The level of permission to grant the access token to manage team discussions and related comments. Can be one of: `read` or `write`. +The level of permission to grant the access token to manage team discussions and related comments. diff --git a/docs/apps/suspendInstallation.md b/docs/apps/suspendInstallation.md index 92bea7442..c38305c24 100644 --- a/docs/apps/suspendInstallation.md +++ b/docs/apps/suspendInstallation.md @@ -31,7 +31,7 @@ octokit.rest.apps.suspendInstallation({ installation_idyes -installation_id parameter +The unique identifier of the installation. diff --git a/docs/apps/unsuspendInstallation.md b/docs/apps/unsuspendInstallation.md index 6fd1cf91a..218539c44 100644 --- a/docs/apps/unsuspendInstallation.md +++ b/docs/apps/unsuspendInstallation.md @@ -31,7 +31,7 @@ octokit.rest.apps.unsuspendInstallation({ installation_idyes -installation_id parameter +The unique identifier of the installation. diff --git a/docs/billing/getGithubActionsBillingOrg.md b/docs/billing/getGithubActionsBillingOrg.md index 1e3aec2aa..b5776518c 100644 --- a/docs/billing/getGithubActionsBillingOrg.md +++ b/docs/billing/getGithubActionsBillingOrg.md @@ -10,7 +10,7 @@ type: API method Gets the summary of the free and paid GitHub Actions minutes used. -Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". +Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". Access tokens must have the `repo` or `admin:org` scope. @@ -33,6 +33,8 @@ octokit.rest.billing.getGithubActionsBillingOrg({ orgyes +The organization name. The name is not case sensitive. + diff --git a/docs/billing/getGithubActionsBillingUser.md b/docs/billing/getGithubActionsBillingUser.md index f1f033fc9..4f77295ed 100644 --- a/docs/billing/getGithubActionsBillingUser.md +++ b/docs/billing/getGithubActionsBillingUser.md @@ -10,7 +10,7 @@ type: API method Gets the summary of the free and paid GitHub Actions minutes used. -Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". +Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". Access tokens must have the `user` scope. @@ -33,6 +33,8 @@ octokit.rest.billing.getGithubActionsBillingUser({ usernameyes +The handle for the GitHub user account. + diff --git a/docs/billing/getGithubAdvancedSecurityBillingGhe.md b/docs/billing/getGithubAdvancedSecurityBillingGhe.md new file mode 100644 index 000000000..9e54894e9 --- /dev/null +++ b/docs/billing/getGithubAdvancedSecurityBillingGhe.md @@ -0,0 +1,49 @@ +--- +name: Get GitHub Advanced Security active committers for an enterprise +example: octokit.rest.billing.getGithubAdvancedSecurityBillingGhe({ enterprise }) +route: GET /enterprises/{enterprise}/settings/billing/advanced-security +scope: billing +type: API method +--- + +# Get GitHub Advanced Security active committers for an enterprise + +Gets the GitHub Advanced Security active committers for an enterprise per repository. +Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository. + +```js +octokit.rest.billing.getGithubAdvancedSecurityBillingGhe({ + enterprise, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
enterpriseyes + +The slug version of the enterprise name. You can also substitute this value with the enterprise id. + +
per_pageno + +The number of results per page (max 100). + +
pageno + +Page number of the results to fetch. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/billing#export-advanced-security-active-committers-data-for-enterprise). diff --git a/docs/billing/getGithubAdvancedSecurityBillingOrg.md b/docs/billing/getGithubAdvancedSecurityBillingOrg.md new file mode 100644 index 000000000..4a79b930e --- /dev/null +++ b/docs/billing/getGithubAdvancedSecurityBillingOrg.md @@ -0,0 +1,50 @@ +--- +name: Get GitHub Advanced Security active committers for an organization +example: octokit.rest.billing.getGithubAdvancedSecurityBillingOrg({ org }) +route: GET /orgs/{org}/settings/billing/advanced-security +scope: billing +type: API method +--- + +# Get GitHub Advanced Security active committers for an organization + +Gets the GitHub Advanced Security active committers for an organization per repository. +Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of advanced_security_committers for each repository. +If this organization defers to an enterprise for billing, the total_advanced_security_committers returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level. + +```js +octokit.rest.billing.getGithubAdvancedSecurityBillingOrg({ + org, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
per_pageno + +The number of results per page (max 100). + +
pageno + +Page number of the results to fetch. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/billing#get-github-advanced-security-active-committers-for-an-organization). diff --git a/docs/billing/getGithubPackagesBillingOrg.md b/docs/billing/getGithubPackagesBillingOrg.md index 72d46891c..a71c765a0 100644 --- a/docs/billing/getGithubPackagesBillingOrg.md +++ b/docs/billing/getGithubPackagesBillingOrg.md @@ -10,7 +10,7 @@ type: API method Gets the free and paid storage used for GitHub Packages in gigabytes. -Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." +Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." Access tokens must have the `repo` or `admin:org` scope. @@ -33,6 +33,8 @@ octokit.rest.billing.getGithubPackagesBillingOrg({ orgyes +The organization name. The name is not case sensitive. + diff --git a/docs/billing/getGithubPackagesBillingUser.md b/docs/billing/getGithubPackagesBillingUser.md index 372dd3f3b..73ed09eb0 100644 --- a/docs/billing/getGithubPackagesBillingUser.md +++ b/docs/billing/getGithubPackagesBillingUser.md @@ -10,7 +10,7 @@ type: API method Gets the free and paid storage used for GitHub Packages in gigabytes. -Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." +Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." Access tokens must have the `user` scope. @@ -33,6 +33,8 @@ octokit.rest.billing.getGithubPackagesBillingUser({ usernameyes +The handle for the GitHub user account. + diff --git a/docs/billing/getSharedStorageBillingOrg.md b/docs/billing/getSharedStorageBillingOrg.md index 503f8a36a..6a99e5449 100644 --- a/docs/billing/getSharedStorageBillingOrg.md +++ b/docs/billing/getSharedStorageBillingOrg.md @@ -8,9 +8,9 @@ type: API method # Get shared storage billing for an organization -Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. +Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. -Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." +Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." Access tokens must have the `repo` or `admin:org` scope. @@ -33,6 +33,8 @@ octokit.rest.billing.getSharedStorageBillingOrg({ orgyes +The organization name. The name is not case sensitive. + diff --git a/docs/billing/getSharedStorageBillingUser.md b/docs/billing/getSharedStorageBillingUser.md index 54b8c3f43..4dd8cc2fc 100644 --- a/docs/billing/getSharedStorageBillingUser.md +++ b/docs/billing/getSharedStorageBillingUser.md @@ -8,9 +8,9 @@ type: API method # Get shared storage billing for a user -Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. +Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. -Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." +Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." Access tokens must have the `user` scope. @@ -33,6 +33,8 @@ octokit.rest.billing.getSharedStorageBillingUser({ usernameyes +The handle for the GitHub user account. + diff --git a/docs/checks/create.md b/docs/checks/create.md index 27b25c5d8..cb450c8fe 100644 --- a/docs/checks/create.md +++ b/docs/checks/create.md @@ -34,9 +34,13 @@ octokit.rest.checks.create({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + statusno diff --git a/docs/checks/createSuite.md b/docs/checks/createSuite.md index 402d82430..08c97c150 100644 --- a/docs/checks/createSuite.md +++ b/docs/checks/createSuite.md @@ -33,9 +33,13 @@ octokit.rest.checks.createSuite({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + head_shayes diff --git a/docs/checks/get.md b/docs/checks/get.md index afe4e825a..a799a1b8f 100644 --- a/docs/checks/get.md +++ b/docs/checks/get.md @@ -33,13 +33,17 @@ octokit.rest.checks.get({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + check_run_idyes -check_run_id parameter +The unique identifier of the check run. diff --git a/docs/checks/getSuite.md b/docs/checks/getSuite.md index c6b286ef7..64d546e74 100644 --- a/docs/checks/getSuite.md +++ b/docs/checks/getSuite.md @@ -33,13 +33,17 @@ octokit.rest.checks.getSuite({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + check_suite_idyes -check_suite_id parameter +The unique identifier of the check suite. diff --git a/docs/checks/listAnnotations.md b/docs/checks/listAnnotations.md index edd6f0b4a..b0f5b4f8a 100644 --- a/docs/checks/listAnnotations.md +++ b/docs/checks/listAnnotations.md @@ -31,18 +31,22 @@ octokit.rest.checks.listAnnotations({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + check_run_idyes -check_run_id parameter +The unique identifier of the check run. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/checks/listForRef.md b/docs/checks/listForRef.md index 97907ecde..f2a2a60a1 100644 --- a/docs/checks/listForRef.md +++ b/docs/checks/listForRef.md @@ -33,9 +33,13 @@ octokit.rest.checks.listForRef({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + refyes @@ -49,17 +53,17 @@ Returns check runs with the specified `name`. statusno -Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. +Returns check runs with the specified `status`. filterno -Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. +Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/checks/listForSuite.md b/docs/checks/listForSuite.md index 1d446451a..4e087db92 100644 --- a/docs/checks/listForSuite.md +++ b/docs/checks/listForSuite.md @@ -33,13 +33,17 @@ octokit.rest.checks.listForSuite({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + check_suite_idyes -check_suite_id parameter +The unique identifier of the check suite. check_nameno @@ -49,17 +53,17 @@ Returns check runs with the specified `name`. statusno -Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. +Returns check runs with the specified `status`. filterno -Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. +Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/checks/listSuitesForRef.md b/docs/checks/listSuitesForRef.md index 153a6f64c..7f54cda3c 100644 --- a/docs/checks/listSuitesForRef.md +++ b/docs/checks/listSuitesForRef.md @@ -33,9 +33,13 @@ octokit.rest.checks.listSuitesForRef({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + refyes @@ -54,7 +58,7 @@ Returns check runs with the specified `name`. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/checks/rerequestRun.md b/docs/checks/rerequestRun.md index c3006bc77..ef2f90764 100644 --- a/docs/checks/rerequestRun.md +++ b/docs/checks/rerequestRun.md @@ -33,13 +33,17 @@ octokit.rest.checks.rerequestRun({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + check_run_idyes -check_run_id parameter +The unique identifier of the check run. diff --git a/docs/checks/rerequestSuite.md b/docs/checks/rerequestSuite.md index ed4f2ccac..31f067cd9 100644 --- a/docs/checks/rerequestSuite.md +++ b/docs/checks/rerequestSuite.md @@ -33,13 +33,17 @@ octokit.rest.checks.rerequestSuite({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + check_suite_idyes -check_suite_id parameter +The unique identifier of the check suite. diff --git a/docs/checks/setSuitesPreferences.md b/docs/checks/setSuitesPreferences.md index 8058cfb45..9e868ae8e 100644 --- a/docs/checks/setSuitesPreferences.md +++ b/docs/checks/setSuitesPreferences.md @@ -32,9 +32,13 @@ auto_trigger_checks[].setting owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + auto_trigger_checksno diff --git a/docs/checks/update.md b/docs/checks/update.md index 75e9fcf48..d9e62f2e0 100644 --- a/docs/checks/update.md +++ b/docs/checks/update.md @@ -44,13 +44,17 @@ actions[].identifier owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + check_run_idyes -check_run_id parameter +The unique identifier of the check run. nameno @@ -75,12 +79,12 @@ This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format statusno -The current status. Can be one of `queued`, `in_progress`, or `completed`. +The current status. conclusionno -**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. +**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. @@ -111,7 +115,7 @@ Can contain Markdown. output.annotationsno -Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see "[About status checks](https://help.github.com/articles/about-status-checks#checks)". See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details. +Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details. output.annotations[].pathyes @@ -141,7 +145,7 @@ The end column of the annotation. Annotations only support `start_column` and `e output.annotations[].annotation_levelyes -The level of the annotation. Can be one of `notice`, `warning`, or `failure`. +The level of the annotation. output.annotations[].messageyes diff --git a/docs/codeScanning/deleteAnalysis.md b/docs/codeScanning/deleteAnalysis.md index 30e039d22..949e2c3a2 100644 --- a/docs/codeScanning/deleteAnalysis.md +++ b/docs/codeScanning/deleteAnalysis.md @@ -10,7 +10,7 @@ type: API method Deletes a specified code scanning analysis from a repository. For private repositories, you must use an access token with the `repo` scope. For public repositories, -you must use an access token with `public_repo` and `repo:security_events` scopes. +you must use an access token with `public_repo` scope. GitHub Apps must have the `security_events` write permission to use this endpoint. You can delete one analysis at a time. @@ -42,13 +42,13 @@ Analysis specified is not deletable. ``` The response from a successful `DELETE` operation provides you with -two alternative URLs for deleting the next analysis in the set -(see the example default response below). +two alternative URLs for deleting the next analysis in the set: +`next_analysis_url` and `confirm_delete_url`. Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis -in the set. This is a useful option if you want to preserve at least one analysis +in a set. This is a useful option if you want to preserve at least one analysis for the specified tool in your repository. Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool. -When you delete the last analysis in a set the value of `next_analysis_url` and `confirm_delete_url` +When you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url` in the 200 response is `null`. As an example of the deletion process, @@ -58,9 +58,11 @@ to analyze the code in a repository. This tool has added 15 analyses: You therefore have two separate sets of analyses for this tool. You've now decided that you want to remove all of the analyses for the tool. To do this you must make 15 separate deletion requests. -To start, you must find the deletable analysis for one of the sets, -step through deleting the analyses in that set, -and then repeat the process for the second set. +To start, you must find an analysis that's identified as deletable. +Each set of analyses always has one that's identified as deletable. +Having found the deletable analysis for one of the two sets, +delete this analysis and then continue deleting the next analysis in the set until they're all deleted. +Then repeat the process for the second set. The procedure therefore consists of a nested loop: **Outer loop**: @@ -96,9 +98,13 @@ octokit.rest.codeScanning.deleteAnalysis({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + analysis_idyes diff --git a/docs/codeScanning/getAlert.md b/docs/codeScanning/getAlert.md index 8ef5f7609..52c904543 100644 --- a/docs/codeScanning/getAlert.md +++ b/docs/codeScanning/getAlert.md @@ -8,7 +8,7 @@ type: API method # Get a code scanning alert -Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint. +Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. **Deprecation notice**: The instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by `instances_url`. @@ -34,9 +34,13 @@ octokit.rest.codeScanning.getAlert({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + alert_numberyes diff --git a/docs/codeScanning/getAnalysis.md b/docs/codeScanning/getAnalysis.md index 77292ce54..13fb77642 100644 --- a/docs/codeScanning/getAnalysis.md +++ b/docs/codeScanning/getAnalysis.md @@ -9,7 +9,8 @@ type: API method # Get a code scanning analysis for a repository Gets a specified code scanning analysis for a repository. -You must use an access token with the `security_events` scope to use this endpoint. +You must use an access token with the `security_events` scope to use this endpoint with private repos, +the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. The default JSON response contains fields that describe the analysis. @@ -48,9 +49,13 @@ octokit.rest.codeScanning.getAnalysis({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + analysis_idyes diff --git a/docs/codeScanning/getSarif.md b/docs/codeScanning/getSarif.md index f6e7d1a07..ccaebd989 100644 --- a/docs/codeScanning/getSarif.md +++ b/docs/codeScanning/getSarif.md @@ -8,7 +8,7 @@ type: API method # Get information about a SARIF upload -Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint. +Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. ```js octokit.rest.codeScanning.getSarif({ @@ -31,9 +31,13 @@ octokit.rest.codeScanning.getSarif({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + sarif_idyes diff --git a/docs/codeScanning/listAlertInstances.md b/docs/codeScanning/listAlertInstances.md index ea99e9d9b..54bd1f11b 100644 --- a/docs/codeScanning/listAlertInstances.md +++ b/docs/codeScanning/listAlertInstances.md @@ -8,7 +8,10 @@ type: API method # List instances of a code scanning alert -Lists all instances of the specified code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint. +Lists all instances of the specified code scanning alert. +You must use an access token with the `security_events` scope to use this endpoint with private repos, +the `public_repo` scope also grants permission to read security events on public repos only. +GitHub Apps must have the `security_events` read permission to use this endpoint. ```js octokit.rest.codeScanning.listAlertInstances({ @@ -31,9 +34,13 @@ octokit.rest.codeScanning.listAlertInstances({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + alert_numberyes @@ -47,7 +54,7 @@ Page number of the results to fetch. per_pageno -Results per page (max 100) +The number of results per page (max 100). refno diff --git a/docs/codeScanning/listAlertsForOrg.md b/docs/codeScanning/listAlertsForOrg.md new file mode 100644 index 000000000..8a44250ba --- /dev/null +++ b/docs/codeScanning/listAlertsForOrg.md @@ -0,0 +1,87 @@ +--- +name: List code scanning alerts for an organization +example: octokit.rest.codeScanning.listAlertsForOrg({ org }) +route: GET /orgs/{org}/code-scanning/alerts +scope: codeScanning +type: API method +--- + +# List code scanning alerts for an organization + +Lists all code scanning alerts for the default branch (usually `main` +or `master`) for all eligible repositories in an organization. +To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. + +GitHub Apps must have the `security_events` read permission to use this endpoint. + +```js +octokit.rest.codeScanning.listAlertsForOrg({ + org, +}); +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
tool_nameno + +The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. + +
tool_guidno + +The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. + +
beforeno + +A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. + +
afterno + +A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. + +
pageno + +Page number of the results to fetch. + +
per_pageno + +The number of results per page (max 100). + +
directionno + +The direction to sort the results by. + +
stateno + +Set to `open`, `closed`, `fixed`, or `dismissed` to list code scanning alerts in a specific state. + +
sortno + +The property by which to sort the results. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/code-scanning#list-code-scanning-alerts-by-organization). diff --git a/docs/codeScanning/listAlertsForRepo.md b/docs/codeScanning/listAlertsForRepo.md index 621820c0a..bc434c750 100644 --- a/docs/codeScanning/listAlertsForRepo.md +++ b/docs/codeScanning/listAlertsForRepo.md @@ -10,8 +10,9 @@ type: API method Lists all open code scanning alerts for the default branch (usually `main` or `master`). You must use an access token with the `security_events` scope to use -this endpoint. GitHub Apps must have the `security_events` read permission to use -this endpoint. +this endpoint with private repos, the `public_repo` scope also grants permission to read +security events on public repos only. GitHub Apps must have the `security_events` read +permission to use this endpoint. The response includes a `most_recent_instance` object. This provides details of the most recent instance of this alert @@ -38,9 +39,13 @@ octokit.rest.codeScanning.listAlertsForRepo({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + tool_nameno @@ -59,17 +64,27 @@ Page number of the results to fetch. per_pageno -Results per page (max 100) +The number of results per page (max 100). refno The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. + +directionno + +The direction to sort the results by. + + +sortno + +The property by which to sort the results. + stateno -Set to `open`, `fixed`, or `dismissed` to list code scanning alerts in a specific state. +Set to `open`, `closed, `fixed`, or `dismissed` to list code scanning alerts in a specific state. diff --git a/docs/codeScanning/listAlertsInstances.md b/docs/codeScanning/listAlertsInstances.md index e9ddef9db..60e1b2e40 100644 --- a/docs/codeScanning/listAlertsInstances.md +++ b/docs/codeScanning/listAlertsInstances.md @@ -10,7 +10,10 @@ type: API method **Deprecated:** This method has been renamed to codeScanning.listAlertInstances -Lists all instances of the specified code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint. +Lists all instances of the specified code scanning alert. +You must use an access token with the `security_events` scope to use this endpoint with private repos, +the `public_repo` scope also grants permission to read security events on public repos only. +GitHub Apps must have the `security_events` read permission to use this endpoint. ```js octokit.rest.codeScanning.listAlertsInstances({ @@ -33,9 +36,13 @@ octokit.rest.codeScanning.listAlertsInstances({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + alert_numberyes @@ -49,7 +56,7 @@ Page number of the results to fetch. per_pageno -Results per page (max 100) +The number of results per page (max 100). refno diff --git a/docs/codeScanning/listRecentAnalyses.md b/docs/codeScanning/listRecentAnalyses.md index 607531b51..1719efd8e 100644 --- a/docs/codeScanning/listRecentAnalyses.md +++ b/docs/codeScanning/listRecentAnalyses.md @@ -19,7 +19,8 @@ that were run in the analysis. For very old analyses this data is not available, and `0` is returned in this field. -You must use an access token with the `security_events` scope to use this endpoint. +You must use an access token with the `security_events` scope to use this endpoint with private repos, +the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. **Deprecation notice**: @@ -45,9 +46,13 @@ octokit.rest.codeScanning.listRecentAnalyses({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + tool_nameno @@ -66,7 +71,7 @@ Page number of the results to fetch. per_pageno -Results per page (max 100) +The number of results per page (max 100). refno diff --git a/docs/codeScanning/updateAlert.md b/docs/codeScanning/updateAlert.md index 92f32a763..d9a0f6fca 100644 --- a/docs/codeScanning/updateAlert.md +++ b/docs/codeScanning/updateAlert.md @@ -8,7 +8,7 @@ type: API method # Update a code scanning alert -Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint. +Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. ```js octokit.rest.codeScanning.updateAlert({ @@ -32,9 +32,13 @@ octokit.rest.codeScanning.updateAlert({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + alert_numberyes @@ -43,12 +47,17 @@ The number that identifies an alert. You can find this at the end of the URL for stateyes -Sets the state of the code scanning alert. Can be one of `open` or `dismissed`. You must provide `dismissed_reason` when you set the state to `dismissed`. +Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`. dismissed_reasonno -**Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. +**Required when the state is dismissed.** The reason for dismissing or closing the alert. + + +dismissed_commentno + +The dismissal comment associated with the dismissal of the alert. diff --git a/docs/codeScanning/uploadSarif.md b/docs/codeScanning/uploadSarif.md index ca747f1c6..bc610adf8 100644 --- a/docs/codeScanning/uploadSarif.md +++ b/docs/codeScanning/uploadSarif.md @@ -8,7 +8,7 @@ type: API method # Upload an analysis as SARIF data -Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint. +Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. There are two places where you can upload code scanning results. @@ -50,9 +50,13 @@ octokit.rest.codeScanning.uploadSarif({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + commit_shayes diff --git a/docs/codespaces/addRepositoryForSecretForAuthenticatedUser.md b/docs/codespaces/addRepositoryForSecretForAuthenticatedUser.md new file mode 100644 index 000000000..68a9373f8 --- /dev/null +++ b/docs/codespaces/addRepositoryForSecretForAuthenticatedUser.md @@ -0,0 +1,44 @@ +--- +name: Add a selected repository to a user secret +example: octokit.rest.codespaces.addRepositoryForSecretForAuthenticatedUser({ secret_name, repository_id }) +route: PUT /user/codespaces/secrets/{secret_name}/repositories/{repository_id} +scope: codespaces +type: API method +--- + +# Add a selected repository to a user secret + +Adds a repository to the selected repositories for a user's codespace secret. +You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. +GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on the referenced repository to use this endpoint. + +```js +octokit.rest.codespaces.addRepositoryForSecretForAuthenticatedUser({ + secret_name, + repository_id, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
secret_nameyes + +The name of the secret. + +
repository_idyes + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#add-a-selected-repository-to-a-user-secret). diff --git a/docs/codespaces/codespaceMachinesForAuthenticatedUser.md b/docs/codespaces/codespaceMachinesForAuthenticatedUser.md new file mode 100644 index 000000000..b1ca8094b --- /dev/null +++ b/docs/codespaces/codespaceMachinesForAuthenticatedUser.md @@ -0,0 +1,42 @@ +--- +name: List machine types for a codespace +example: octokit.rest.codespaces.codespaceMachinesForAuthenticatedUser({ codespace_name }) +route: GET /user/codespaces/{codespace_name}/machines +scope: codespaces +type: API method +--- + +# List machine types for a codespace + +List the machine types a codespace can transition to use. + +You must authenticate using an access token with the `codespace` scope to use this endpoint. + +GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint. + +```js +octokit.rest.codespaces.codespaceMachinesForAuthenticatedUser({ + codespace_name, +}); +``` + +## Parameters + + + + + + + + + + + + +
namerequireddescription
codespace_nameyes + +The name of the codespace. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#list-machine-types-for-a-codespace). diff --git a/docs/codespaces/createForAuthenticatedUser.md b/docs/codespaces/createForAuthenticatedUser.md new file mode 100644 index 000000000..5547f3cb0 --- /dev/null +++ b/docs/codespaces/createForAuthenticatedUser.md @@ -0,0 +1,107 @@ +--- +name: Create a codespace for the authenticated user +example: octokit.rest.codespaces.createForAuthenticatedUser({ repository_id, pull_request, pull_request.pull_request_number, pull_request.repository_id }) +route: POST /user/codespaces +scope: codespaces +type: API method +--- + +# Create a codespace for the authenticated user + +Creates a new codespace, owned by the authenticated user. + +This endpoint requires either a `repository_id` OR a `pull_request` but not both. + +You must authenticate using an access token with the `codespace` scope to use this endpoint. + +GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + +```js +octokit.rest.codespaces.createForAuthenticatedUser({ + repository_id, +pull_request, +pull_request.pull_request_number, +pull_request.repository_id + }) +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + + +
namerequireddescription
repository_idyes + +Repository id for this codespace + +
refno + +Git ref (typically a branch name) for this codespace + +
locationno + +Location for this codespace. Assigned by IP if not provided + +
client_ipno + +IP for location auto-detection when proxying a request + +
machineno + +Machine type to use for this codespace + +
devcontainer_pathno + +Path to devcontainer.json config to use for this codespace + +
multi_repo_permissions_opt_outno + +Whether to authorize requested permissions from devcontainer.json + +
working_directoryno + +Working directory for this codespace + +
idle_timeout_minutesno + +Time in minutes before codespace stops from inactivity + +
display_nameno + +Display name for this codespace + +
pull_requestyes + +Pull request number for this codespace + +
pull_request.pull_request_numberyes + +Pull request number + +
pull_request.repository_idyes + +Repository id for this codespace + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#create-a-codespace-for-the-authenticated-user). diff --git a/docs/codespaces/createOrUpdateRepoSecret.md b/docs/codespaces/createOrUpdateRepoSecret.md new file mode 100644 index 000000000..09738145c --- /dev/null +++ b/docs/codespaces/createOrUpdateRepoSecret.md @@ -0,0 +1,133 @@ +--- +name: Create or update a repository secret +example: octokit.rest.codespaces.createOrUpdateRepoSecret({ owner, repo, secret_name }) +route: PUT /repos/{owner}/{repo}/codespaces/secrets/{secret_name} +scope: codespaces +type: API method +--- + +# Create or update a repository secret + +Creates or updates a repository secret with an encrypted value. Encrypt your secret using +[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access +token with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets` repository +permission to use this endpoint. + +#### Example of encrypting a secret using Node.js + +Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. + +``` +const sodium = require('tweetsodium'); + +const key = "base64-encoded-public-key"; +const value = "plain-text-secret"; + +// Convert the message and key to Uint8Array's (Buffer implements that interface) +const messageBytes = Buffer.from(value); +const keyBytes = Buffer.from(key, 'base64'); + +// Encrypt using LibSodium. +const encryptedBytes = sodium.seal(messageBytes, keyBytes); + +// Base64 the encrypted secret +const encrypted = Buffer.from(encryptedBytes).toString('base64'); + +console.log(encrypted); +``` + +#### Example of encrypting a secret using Python + +Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. + +``` +from base64 import b64encode +from nacl import encoding, public + +def encrypt(public_key: str, secret_value: str) -> str: + """Encrypt a Unicode string using the public key.""" + public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) + sealed_box = public.SealedBox(public_key) + encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) + return b64encode(encrypted).decode("utf-8") +``` + +#### Example of encrypting a secret using C# + +Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + +``` +var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); +var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); + +var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); + +Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); +``` + +#### Example of encrypting a secret using Ruby + +Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + +```ruby +require "rbnacl" +require "base64" + +key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") +public_key = RbNaCl::PublicKey.new(key) + +box = RbNaCl::Boxes::Sealed.from_public_key(public_key) +encrypted_secret = box.encrypt("my_secret") + +# Print the base64 encoded secret +puts Base64.strict_encode64(encrypted_secret) +``` + +```js +octokit.rest.codespaces.createOrUpdateRepoSecret({ + owner, + repo, + secret_name, +}); +``` + +## Parameters + + + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
secret_nameyes + +The name of the secret. + +
encrypted_valueno + +Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/codespaces#get-a-repository-public-key) endpoint. + +
key_idno + +ID of the key you used to encrypt the secret. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#create-or-update-a-repository-secret). diff --git a/docs/codespaces/createOrUpdateSecretForAuthenticatedUser.md b/docs/codespaces/createOrUpdateSecretForAuthenticatedUser.md new file mode 100644 index 000000000..080dfe265 --- /dev/null +++ b/docs/codespaces/createOrUpdateSecretForAuthenticatedUser.md @@ -0,0 +1,129 @@ +--- +name: Create or update a secret for the authenticated user +example: octokit.rest.codespaces.createOrUpdateSecretForAuthenticatedUser({ secret_name, key_id }) +route: PUT /user/codespaces/secrets/{secret_name} +scope: codespaces +type: API method +--- + +# Create or update a secret for the authenticated user + +Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using +[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). + +You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint. + +GitHub Apps must have read access to the `codespaces_user_secrets` user permission and `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + +#### Example encrypting a secret using Node.js + +Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. + +``` +const sodium = require('tweetsodium'); + +const key = "base64-encoded-public-key"; +const value = "plain-text-secret"; + +// Convert the message and key to Uint8Array's (Buffer implements that interface) +const messageBytes = Buffer.from(value); +const keyBytes = Buffer.from(key, 'base64'); + +// Encrypt using LibSodium. +const encryptedBytes = sodium.seal(messageBytes, keyBytes); + +// Base64 the encrypted secret +const encrypted = Buffer.from(encryptedBytes).toString('base64'); + +console.log(encrypted); +``` + +#### Example encrypting a secret using Python + +Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. + +``` +from base64 import b64encode +from nacl import encoding, public + +def encrypt(public_key: str, secret_value: str) -> str: + """Encrypt a Unicode string using the public key.""" + public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) + sealed_box = public.SealedBox(public_key) + encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) + return b64encode(encrypted).decode("utf-8") +``` + +#### Example encrypting a secret using C# + +Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + +``` +var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); +var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); + +var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); + +Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); +``` + +#### Example encrypting a secret using Ruby + +Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + +```ruby +require "rbnacl" +require "base64" + +key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") +public_key = RbNaCl::PublicKey.new(key) + +box = RbNaCl::Boxes::Sealed.from_public_key(public_key) +encrypted_secret = box.encrypt("my_secret") + +# Print the base64 encoded secret +puts Base64.strict_encode64(encrypted_secret) +``` + +```js +octokit.rest.codespaces.createOrUpdateSecretForAuthenticatedUser({ + secret_name, + key_id, +}); +``` + +## Parameters + + + + + + + + + + + + + + + +
namerequireddescription
secret_nameyes + +The name of the secret. + +
encrypted_valueno + +Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/reference/codespaces#get-the-public-key-for-the-authenticated-user) endpoint. + +
key_idyes + +ID of the key you used to encrypt the secret. + +
selected_repository_idsno + +An array of repository ids that can access the user secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret), [Set selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#set-selected-repositories-for-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret) endpoints. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#create-or-update-a-secret-for-the-authenticated-user). diff --git a/docs/codespaces/createWithPrForAuthenticatedUser.md b/docs/codespaces/createWithPrForAuthenticatedUser.md new file mode 100644 index 000000000..2c7eac13e --- /dev/null +++ b/docs/codespaces/createWithPrForAuthenticatedUser.md @@ -0,0 +1,94 @@ +--- +name: Create a codespace from a pull request +example: octokit.rest.codespaces.createWithPrForAuthenticatedUser({ owner, repo, pull_number }) +route: POST /repos/{owner}/{repo}/pulls/{pull_number}/codespaces +scope: codespaces +type: API method +--- + +# Create a codespace from a pull request + +Creates a codespace owned by the authenticated user for the specified pull request. + +You must authenticate using an access token with the `codespace` scope to use this endpoint. + +GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + +```js +octokit.rest.codespaces.createWithPrForAuthenticatedUser({ + owner, + repo, + pull_number, +}); +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
pull_numberyes + +The number that identifies the pull request. + +
locationno + +Location for this codespace. Assigned by IP if not provided + +
client_ipno + +IP for location auto-detection when proxying a request + +
machineno + +Machine type to use for this codespace + +
devcontainer_pathno + +Path to devcontainer.json config to use for this codespace + +
multi_repo_permissions_opt_outno + +Whether to authorize requested permissions from devcontainer.json + +
working_directoryno + +Working directory for this codespace + +
idle_timeout_minutesno + +Time in minutes before codespace stops from inactivity + +
display_nameno + +Display name for this codespace + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#create-a-codespace-from-a-pull-request). diff --git a/docs/codespaces/createWithRepoForAuthenticatedUser.md b/docs/codespaces/createWithRepoForAuthenticatedUser.md new file mode 100644 index 000000000..5b321eae7 --- /dev/null +++ b/docs/codespaces/createWithRepoForAuthenticatedUser.md @@ -0,0 +1,93 @@ +--- +name: Create a codespace in a repository +example: octokit.rest.codespaces.createWithRepoForAuthenticatedUser({ owner, repo }) +route: POST /repos/{owner}/{repo}/codespaces +scope: codespaces +type: API method +--- + +# Create a codespace in a repository + +Creates a codespace owned by the authenticated user in the specified repository. + +You must authenticate using an access token with the `codespace` scope to use this endpoint. + +GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + +```js +octokit.rest.codespaces.createWithRepoForAuthenticatedUser({ + owner, + repo, +}); +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
refno + +Git ref (typically a branch name) for this codespace + +
locationno + +Location for this codespace. Assigned by IP if not provided + +
client_ipno + +IP for location auto-detection when proxying a request + +
machineno + +Machine type to use for this codespace + +
devcontainer_pathno + +Path to devcontainer.json config to use for this codespace + +
multi_repo_permissions_opt_outno + +Whether to authorize requested permissions from devcontainer.json + +
working_directoryno + +Working directory for this codespace + +
idle_timeout_minutesno + +Time in minutes before codespace stops from inactivity + +
display_nameno + +Display name for this codespace + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#create-a-codespace-in-a-repository). diff --git a/docs/codespaces/deleteForAuthenticatedUser.md b/docs/codespaces/deleteForAuthenticatedUser.md new file mode 100644 index 000000000..862054716 --- /dev/null +++ b/docs/codespaces/deleteForAuthenticatedUser.md @@ -0,0 +1,42 @@ +--- +name: Delete a codespace for the authenticated user +example: octokit.rest.codespaces.deleteForAuthenticatedUser({ codespace_name }) +route: DELETE /user/codespaces/{codespace_name} +scope: codespaces +type: API method +--- + +# Delete a codespace for the authenticated user + +Deletes a user's codespace. + +You must authenticate using an access token with the `codespace` scope to use this endpoint. + +GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + +```js +octokit.rest.codespaces.deleteForAuthenticatedUser({ + codespace_name, +}); +``` + +## Parameters + + + + + + + + + + + + +
namerequireddescription
codespace_nameyes + +The name of the codespace. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#delete-a-codespace-for-the-authenticated-user). diff --git a/docs/codespaces/deleteRepoSecret.md b/docs/codespaces/deleteRepoSecret.md new file mode 100644 index 000000000..a407fbae3 --- /dev/null +++ b/docs/codespaces/deleteRepoSecret.md @@ -0,0 +1,50 @@ +--- +name: Delete a repository secret +example: octokit.rest.codespaces.deleteRepoSecret({ owner, repo, secret_name }) +route: DELETE /repos/{owner}/{repo}/codespaces/secrets/{secret_name} +scope: codespaces +type: API method +--- + +# Delete a repository secret + +Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint. + +```js +octokit.rest.codespaces.deleteRepoSecret({ + owner, + repo, + secret_name, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
secret_nameyes + +The name of the secret. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#delete-a-repository-secret). diff --git a/docs/codespaces/deleteSecretForAuthenticatedUser.md b/docs/codespaces/deleteSecretForAuthenticatedUser.md new file mode 100644 index 000000000..e4a83d231 --- /dev/null +++ b/docs/codespaces/deleteSecretForAuthenticatedUser.md @@ -0,0 +1,42 @@ +--- +name: Delete a secret for the authenticated user +example: octokit.rest.codespaces.deleteSecretForAuthenticatedUser({ secret_name }) +route: DELETE /user/codespaces/secrets/{secret_name} +scope: codespaces +type: API method +--- + +# Delete a secret for the authenticated user + +Deletes a secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. + +You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + +GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. + +```js +octokit.rest.codespaces.deleteSecretForAuthenticatedUser({ + secret_name, +}); +``` + +## Parameters + + + + + + + + + + + + +
namerequireddescription
secret_nameyes + +The name of the secret. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#delete-a-secret-for-the-authenticated-user). diff --git a/docs/codespaces/exportForAuthenticatedUser.md b/docs/codespaces/exportForAuthenticatedUser.md new file mode 100644 index 000000000..0d4edf9e7 --- /dev/null +++ b/docs/codespaces/exportForAuthenticatedUser.md @@ -0,0 +1,42 @@ +--- +name: Export a codespace for the authenticated user +example: octokit.rest.codespaces.exportForAuthenticatedUser({ codespace_name }) +route: POST /user/codespaces/{codespace_name}/exports +scope: codespaces +type: API method +--- + +# Export a codespace for the authenticated user + +Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored. + +You must authenticate using a personal access token with the `codespace` scope to use this endpoint. + +GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + +```js +octokit.rest.codespaces.exportForAuthenticatedUser({ + codespace_name, +}); +``` + +## Parameters + + + + + + + + + + + + +
namerequireddescription
codespace_nameyes + +The name of the codespace. + +
+ +See also: [GitHub Developer Guide documentation](). diff --git a/docs/codespaces/getExportDetailsForAuthenticatedUser.md b/docs/codespaces/getExportDetailsForAuthenticatedUser.md new file mode 100644 index 000000000..8b4355bee --- /dev/null +++ b/docs/codespaces/getExportDetailsForAuthenticatedUser.md @@ -0,0 +1,48 @@ +--- +name: Get details about a codespace export +example: octokit.rest.codespaces.getExportDetailsForAuthenticatedUser({ codespace_name, export_id }) +route: GET /user/codespaces/{codespace_name}/exports/{export_id} +scope: codespaces +type: API method +--- + +# Get details about a codespace export + +Gets information about an export of a codespace. + +You must authenticate using a personal access token with the `codespace` scope to use this endpoint. + +GitHub Apps must have read access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + +```js +octokit.rest.codespaces.getExportDetailsForAuthenticatedUser({ + codespace_name, + export_id, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
codespace_nameyes + +The name of the codespace. + +
export_idyes + +The ID of the export operation, or `latest`. Currently only `latest` is currently supported. + +
+ +See also: [GitHub Developer Guide documentation](). diff --git a/docs/codespaces/getForAuthenticatedUser.md b/docs/codespaces/getForAuthenticatedUser.md new file mode 100644 index 000000000..a8808af23 --- /dev/null +++ b/docs/codespaces/getForAuthenticatedUser.md @@ -0,0 +1,42 @@ +--- +name: Get a codespace for the authenticated user +example: octokit.rest.codespaces.getForAuthenticatedUser({ codespace_name }) +route: GET /user/codespaces/{codespace_name} +scope: codespaces +type: API method +--- + +# Get a codespace for the authenticated user + +Gets information about a user's codespace. + +You must authenticate using an access token with the `codespace` scope to use this endpoint. + +GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. + +```js +octokit.rest.codespaces.getForAuthenticatedUser({ + codespace_name, +}); +``` + +## Parameters + + + + + + + + + + + + +
namerequireddescription
codespace_nameyes + +The name of the codespace. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#get-a-codespace-for-the-authenticated-user). diff --git a/docs/codespaces/getPublicKeyForAuthenticatedUser.md b/docs/codespaces/getPublicKeyForAuthenticatedUser.md new file mode 100644 index 000000000..168c15184 --- /dev/null +++ b/docs/codespaces/getPublicKeyForAuthenticatedUser.md @@ -0,0 +1,25 @@ +--- +name: Get public key for the authenticated user +example: octokit.rest.codespaces.getPublicKeyForAuthenticatedUser() +route: GET /user/codespaces/secrets/public-key +scope: codespaces +type: API method +--- + +# Get public key for the authenticated user + +Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. + +You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + +GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + +```js +octokit.rest.codespaces.getPublicKeyForAuthenticatedUser(); +``` + +## Parameters + +This endpoint has no parameters + +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#get-public-key-for-the-authenticated-user). diff --git a/docs/codespaces/getRepoPublicKey.md b/docs/codespaces/getRepoPublicKey.md new file mode 100644 index 000000000..b5ec7cb04 --- /dev/null +++ b/docs/codespaces/getRepoPublicKey.md @@ -0,0 +1,44 @@ +--- +name: Get a repository public key +example: octokit.rest.codespaces.getRepoPublicKey({ owner, repo }) +route: GET /repos/{owner}/{repo}/codespaces/secrets/public-key +scope: codespaces +type: API method +--- + +# Get a repository public key + +Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint. + +```js +octokit.rest.codespaces.getRepoPublicKey({ + owner, + repo, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#get-a-repository-public-key). diff --git a/docs/codespaces/getRepoSecret.md b/docs/codespaces/getRepoSecret.md new file mode 100644 index 000000000..08a3528c3 --- /dev/null +++ b/docs/codespaces/getRepoSecret.md @@ -0,0 +1,50 @@ +--- +name: Get a repository secret +example: octokit.rest.codespaces.getRepoSecret({ owner, repo, secret_name }) +route: GET /repos/{owner}/{repo}/codespaces/secrets/{secret_name} +scope: codespaces +type: API method +--- + +# Get a repository secret + +Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint. + +```js +octokit.rest.codespaces.getRepoSecret({ + owner, + repo, + secret_name, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
secret_nameyes + +The name of the secret. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#get-a-repository-secret). diff --git a/docs/codespaces/getSecretForAuthenticatedUser.md b/docs/codespaces/getSecretForAuthenticatedUser.md new file mode 100644 index 000000000..92207b503 --- /dev/null +++ b/docs/codespaces/getSecretForAuthenticatedUser.md @@ -0,0 +1,42 @@ +--- +name: Get a secret for the authenticated user +example: octokit.rest.codespaces.getSecretForAuthenticatedUser({ secret_name }) +route: GET /user/codespaces/secrets/{secret_name} +scope: codespaces +type: API method +--- + +# Get a secret for the authenticated user + +Gets a secret available to a user's codespaces without revealing its encrypted value. + +You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + +GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + +```js +octokit.rest.codespaces.getSecretForAuthenticatedUser({ + secret_name, +}); +``` + +## Parameters + + + + + + + + + + + + +
namerequireddescription
secret_nameyes + +The name of the secret. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#get-a-secret-for-the-authenticated-user). diff --git a/docs/codespaces/listDevcontainersInRepositoryForAuthenticatedUser.md b/docs/codespaces/listDevcontainersInRepositoryForAuthenticatedUser.md new file mode 100644 index 000000000..4094a3d83 --- /dev/null +++ b/docs/codespaces/listDevcontainersInRepositoryForAuthenticatedUser.md @@ -0,0 +1,59 @@ +--- +name: List devcontainer configurations in a repository for the authenticated user +example: octokit.rest.codespaces.listDevcontainersInRepositoryForAuthenticatedUser({ owner, repo }) +route: GET /repos/{owner}/{repo}/codespaces/devcontainers +scope: codespaces +type: API method +--- + +# List devcontainer configurations in a repository for the authenticated user + +Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files +specify launchpoint configurations for codespaces created within the repository. + +You must authenticate using an access token with the `codespace` scope to use this endpoint. + +GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint. + +```js +octokit.rest.codespaces.listDevcontainersInRepositoryForAuthenticatedUser({ + owner, + repo, +}); +``` + +## Parameters + + + + + + + + + + + + + + + +
namerequireddescription
per_pageno + +The number of results per page (max 100). + +
pageno + +Page number of the results to fetch. + +
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#list-devcontainers-in-a-repository-for-the-authenticated-user). diff --git a/docs/codespaces/listForAuthenticatedUser.md b/docs/codespaces/listForAuthenticatedUser.md new file mode 100644 index 000000000..69b561743 --- /dev/null +++ b/docs/codespaces/listForAuthenticatedUser.md @@ -0,0 +1,50 @@ +--- +name: List codespaces for the authenticated user +example: octokit.rest.codespaces.listForAuthenticatedUser() +route: GET /user/codespaces +scope: codespaces +type: API method +--- + +# List codespaces for the authenticated user + +Lists the authenticated user's codespaces. + +You must authenticate using an access token with the `codespace` scope to use this endpoint. + +GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. + +```js +octokit.rest.codespaces.listForAuthenticatedUser(); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
per_pageno + +The number of results per page (max 100). + +
pageno + +Page number of the results to fetch. + +
repository_idno + +ID of the Repository to filter on + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#list-codespaces-for-the-authenticated-user). diff --git a/docs/codespaces/listInRepositoryForAuthenticatedUser.md b/docs/codespaces/listInRepositoryForAuthenticatedUser.md new file mode 100644 index 000000000..79171ec6a --- /dev/null +++ b/docs/codespaces/listInRepositoryForAuthenticatedUser.md @@ -0,0 +1,58 @@ +--- +name: List codespaces in a repository for the authenticated user +example: octokit.rest.codespaces.listInRepositoryForAuthenticatedUser({ owner, repo }) +route: GET /repos/{owner}/{repo}/codespaces +scope: codespaces +type: API method +--- + +# List codespaces in a repository for the authenticated user + +Lists the codespaces associated to a specified repository and the authenticated user. + +You must authenticate using an access token with the `codespace` scope to use this endpoint. + +GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. + +```js +octokit.rest.codespaces.listInRepositoryForAuthenticatedUser({ + owner, + repo, +}); +``` + +## Parameters + + + + + + + + + + + + + + + +
namerequireddescription
per_pageno + +The number of results per page (max 100). + +
pageno + +Page number of the results to fetch. + +
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#list-codespaces-in-a-repository-for-the-authenticated-user). diff --git a/docs/codespaces/listRepoSecrets.md b/docs/codespaces/listRepoSecrets.md new file mode 100644 index 000000000..55151bf18 --- /dev/null +++ b/docs/codespaces/listRepoSecrets.md @@ -0,0 +1,54 @@ +--- +name: List repository secrets +example: octokit.rest.codespaces.listRepoSecrets({ owner, repo }) +route: GET /repos/{owner}/{repo}/codespaces/secrets +scope: codespaces +type: API method +--- + +# List repository secrets + +Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint. + +```js +octokit.rest.codespaces.listRepoSecrets({ + owner, + repo, +}); +``` + +## Parameters + + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
per_pageno + +The number of results per page (max 100). + +
pageno + +Page number of the results to fetch. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#list-repository-secrets). diff --git a/docs/codespaces/listRepositoriesForSecretForAuthenticatedUser.md b/docs/codespaces/listRepositoriesForSecretForAuthenticatedUser.md new file mode 100644 index 000000000..fc553b519 --- /dev/null +++ b/docs/codespaces/listRepositoriesForSecretForAuthenticatedUser.md @@ -0,0 +1,42 @@ +--- +name: List selected repositories for a user secret +example: octokit.rest.codespaces.listRepositoriesForSecretForAuthenticatedUser({ secret_name }) +route: GET /user/codespaces/secrets/{secret_name}/repositories +scope: codespaces +type: API method +--- + +# List selected repositories for a user secret + +List the repositories that have been granted the ability to use a user's codespace secret. + +You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + +GitHub Apps must have read access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + +```js +octokit.rest.codespaces.listRepositoriesForSecretForAuthenticatedUser({ + secret_name, +}); +``` + +## Parameters + + + + + + + + + + + + +
namerequireddescription
secret_nameyes + +The name of the secret. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret). diff --git a/docs/codespaces/listSecretsForAuthenticatedUser.md b/docs/codespaces/listSecretsForAuthenticatedUser.md new file mode 100644 index 000000000..6ef47f5d6 --- /dev/null +++ b/docs/codespaces/listSecretsForAuthenticatedUser.md @@ -0,0 +1,46 @@ +--- +name: List secrets for the authenticated user +example: octokit.rest.codespaces.listSecretsForAuthenticatedUser() +route: GET /user/codespaces/secrets +scope: codespaces +type: API method +--- + +# List secrets for the authenticated user + +Lists all secrets available for a user's Codespaces without revealing their +encrypted values. + +You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + +GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + +```js +octokit.rest.codespaces.listSecretsForAuthenticatedUser(); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
per_pageno + +The number of results per page (max 100). + +
pageno + +Page number of the results to fetch. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#list-secrets-for-the-authenticated-user). diff --git a/docs/codespaces/removeRepositoryForSecretForAuthenticatedUser.md b/docs/codespaces/removeRepositoryForSecretForAuthenticatedUser.md new file mode 100644 index 000000000..68f77823c --- /dev/null +++ b/docs/codespaces/removeRepositoryForSecretForAuthenticatedUser.md @@ -0,0 +1,44 @@ +--- +name: Remove a selected repository from a user secret +example: octokit.rest.codespaces.removeRepositoryForSecretForAuthenticatedUser({ secret_name, repository_id }) +route: DELETE /user/codespaces/secrets/{secret_name}/repositories/{repository_id} +scope: codespaces +type: API method +--- + +# Remove a selected repository from a user secret + +Removes a repository from the selected repositories for a user's codespace secret. +You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. +GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. + +```js +octokit.rest.codespaces.removeRepositoryForSecretForAuthenticatedUser({ + secret_name, + repository_id, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
secret_nameyes + +The name of the secret. + +
repository_idyes + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret). diff --git a/docs/codespaces/repoMachinesForAuthenticatedUser.md b/docs/codespaces/repoMachinesForAuthenticatedUser.md new file mode 100644 index 000000000..357f2afeb --- /dev/null +++ b/docs/codespaces/repoMachinesForAuthenticatedUser.md @@ -0,0 +1,58 @@ +--- +name: List available machine types for a repository +example: octokit.rest.codespaces.repoMachinesForAuthenticatedUser({ owner, repo }) +route: GET /repos/{owner}/{repo}/codespaces/machines +scope: codespaces +type: API method +--- + +# List available machine types for a repository + +List the machine types available for a given repository based on its configuration. + +You must authenticate using an access token with the `codespace` scope to use this endpoint. + +GitHub Apps must have write access to the `codespaces_metadata` repository permission to use this endpoint. + +```js +octokit.rest.codespaces.repoMachinesForAuthenticatedUser({ + owner, + repo, +}); +``` + +## Parameters + + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
locationno + +The location to check for available machines. Assigned by IP if not provided. + +
client_ipno + +IP for location auto-detection when proxying a request + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#list-available-machine-types-for-a-repository). diff --git a/docs/codespaces/setRepositoriesForSecretForAuthenticatedUser.md b/docs/codespaces/setRepositoriesForSecretForAuthenticatedUser.md new file mode 100644 index 000000000..be55870be --- /dev/null +++ b/docs/codespaces/setRepositoriesForSecretForAuthenticatedUser.md @@ -0,0 +1,48 @@ +--- +name: Set selected repositories for a user secret +example: octokit.rest.codespaces.setRepositoriesForSecretForAuthenticatedUser({ secret_name, selected_repository_ids }) +route: PUT /user/codespaces/secrets/{secret_name}/repositories +scope: codespaces +type: API method +--- + +# Set selected repositories for a user secret + +Select the repositories that will use a user's codespace secret. + +You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + +GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + +```js +octokit.rest.codespaces.setRepositoriesForSecretForAuthenticatedUser({ + secret_name, + selected_repository_ids, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
secret_nameyes + +The name of the secret. + +
selected_repository_idsyes + +An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret), [Add a selected repository to a user secret](https://docs.github.com/rest/reference/codespaces#add-a-selected-repository-to-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret) endpoints. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#set-selected-repositories-for-a-user-secret). diff --git a/docs/codespaces/startForAuthenticatedUser.md b/docs/codespaces/startForAuthenticatedUser.md new file mode 100644 index 000000000..a2511d425 --- /dev/null +++ b/docs/codespaces/startForAuthenticatedUser.md @@ -0,0 +1,42 @@ +--- +name: Start a codespace for the authenticated user +example: octokit.rest.codespaces.startForAuthenticatedUser({ codespace_name }) +route: POST /user/codespaces/{codespace_name}/start +scope: codespaces +type: API method +--- + +# Start a codespace for the authenticated user + +Starts a user's codespace. + +You must authenticate using an access token with the `codespace` scope to use this endpoint. + +GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + +```js +octokit.rest.codespaces.startForAuthenticatedUser({ + codespace_name, +}); +``` + +## Parameters + + + + + + + + + + + + +
namerequireddescription
codespace_nameyes + +The name of the codespace. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#start-a-codespace-for-the-authenticated-user). diff --git a/docs/codespaces/stopForAuthenticatedUser.md b/docs/codespaces/stopForAuthenticatedUser.md new file mode 100644 index 000000000..cec008f16 --- /dev/null +++ b/docs/codespaces/stopForAuthenticatedUser.md @@ -0,0 +1,42 @@ +--- +name: Stop a codespace for the authenticated user +example: octokit.rest.codespaces.stopForAuthenticatedUser({ codespace_name }) +route: POST /user/codespaces/{codespace_name}/stop +scope: codespaces +type: API method +--- + +# Stop a codespace for the authenticated user + +Stops a user's codespace. + +You must authenticate using an access token with the `codespace` scope to use this endpoint. + +GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + +```js +octokit.rest.codespaces.stopForAuthenticatedUser({ + codespace_name, +}); +``` + +## Parameters + + + + + + + + + + + + +
namerequireddescription
codespace_nameyes + +The name of the codespace. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#stop-a-codespace-for-the-authenticated-user). diff --git a/docs/codespaces/updateForAuthenticatedUser.md b/docs/codespaces/updateForAuthenticatedUser.md new file mode 100644 index 000000000..673cb607d --- /dev/null +++ b/docs/codespaces/updateForAuthenticatedUser.md @@ -0,0 +1,59 @@ +--- +name: Update a codespace for the authenticated user +example: octokit.rest.codespaces.updateForAuthenticatedUser({ codespace_name }) +route: PATCH /user/codespaces/{codespace_name} +scope: codespaces +type: API method +--- + +# Update a codespace for the authenticated user + +Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint. + +If you specify a new machine type it will be applied the next time your codespace is started. + +You must authenticate using an access token with the `codespace` scope to use this endpoint. + +GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + +```js +octokit.rest.codespaces.updateForAuthenticatedUser({ + codespace_name, +}); +``` + +## Parameters + + + + + + + + + + + + + + + +
namerequireddescription
codespace_nameyes + +The name of the codespace. + +
machineno + +A valid machine to transition this codespace to. + +
display_nameno + +Display name for this codespace + +
recent_foldersno + +Recently opened folders inside the codespace. It is currently used by the clients to determine the folder path to load the codespace in. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#update-a-codespace-for-the-authenticated-user). diff --git a/docs/dependabot/addSelectedRepoToOrgSecret.md b/docs/dependabot/addSelectedRepoToOrgSecret.md new file mode 100644 index 000000000..6523c3e72 --- /dev/null +++ b/docs/dependabot/addSelectedRepoToOrgSecret.md @@ -0,0 +1,48 @@ +--- +name: Add selected repository to an organization secret +example: octokit.rest.dependabot.addSelectedRepoToOrgSecret({ org, secret_name, repository_id }) +route: PUT /orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id} +scope: dependabot +type: API method +--- + +# Add selected repository to an organization secret + +Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + +```js +octokit.rest.dependabot.addSelectedRepoToOrgSecret({ + org, + secret_name, + repository_id, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
secret_nameyes + +The name of the secret. + +
repository_idyes + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependabot#add-selected-repository-to-an-organization-secret). diff --git a/docs/dependabot/createOrUpdateOrgSecret.md b/docs/dependabot/createOrUpdateOrgSecret.md new file mode 100644 index 000000000..0bbb4123c --- /dev/null +++ b/docs/dependabot/createOrUpdateOrgSecret.md @@ -0,0 +1,138 @@ +--- +name: Create or update an organization secret +example: octokit.rest.dependabot.createOrUpdateOrgSecret({ org, secret_name, visibility }) +route: PUT /orgs/{org}/dependabot/secrets/{secret_name} +scope: dependabot +type: API method +--- + +# Create or update an organization secret + +Creates or updates an organization secret with an encrypted value. Encrypt your secret using +[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access +token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization +permission to use this endpoint. + +#### Example encrypting a secret using Node.js + +Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. + +``` +const sodium = require('tweetsodium'); + +const key = "base64-encoded-public-key"; +const value = "plain-text-secret"; + +// Convert the message and key to Uint8Array's (Buffer implements that interface) +const messageBytes = Buffer.from(value); +const keyBytes = Buffer.from(key, 'base64'); + +// Encrypt using LibSodium. +const encryptedBytes = sodium.seal(messageBytes, keyBytes); + +// Base64 the encrypted secret +const encrypted = Buffer.from(encryptedBytes).toString('base64'); + +console.log(encrypted); +``` + +#### Example encrypting a secret using Python + +Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. + +``` +from base64 import b64encode +from nacl import encoding, public + +def encrypt(public_key: str, secret_value: str) -> str: + """Encrypt a Unicode string using the public key.""" + public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) + sealed_box = public.SealedBox(public_key) + encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) + return b64encode(encrypted).decode("utf-8") +``` + +#### Example encrypting a secret using C# + +Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + +``` +var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); +var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); + +var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); + +Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); +``` + +#### Example encrypting a secret using Ruby + +Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + +```ruby +require "rbnacl" +require "base64" + +key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") +public_key = RbNaCl::PublicKey.new(key) + +box = RbNaCl::Boxes::Sealed.from_public_key(public_key) +encrypted_secret = box.encrypt("my_secret") + +# Print the base64 encoded secret +puts Base64.strict_encode64(encrypted_secret) +``` + +```js +octokit.rest.dependabot.createOrUpdateOrgSecret({ + org, + secret_name, + visibility, +}); +``` + +## Parameters + + + + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
secret_nameyes + +The name of the secret. + +
encrypted_valueno + +Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/dependabot#get-an-organization-public-key) endpoint. + +
key_idno + +ID of the key you used to encrypt the secret. + +
visibilityyes + +Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret. + +
selected_repository_idsno + +An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). diff --git a/docs/dependabot/createOrUpdateRepoSecret.md b/docs/dependabot/createOrUpdateRepoSecret.md new file mode 100644 index 000000000..d0f2c6d68 --- /dev/null +++ b/docs/dependabot/createOrUpdateRepoSecret.md @@ -0,0 +1,133 @@ +--- +name: Create or update a repository secret +example: octokit.rest.dependabot.createOrUpdateRepoSecret({ owner, repo, secret_name }) +route: PUT /repos/{owner}/{repo}/dependabot/secrets/{secret_name} +scope: dependabot +type: API method +--- + +# Create or update a repository secret + +Creates or updates a repository secret with an encrypted value. Encrypt your secret using +[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access +token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository +permission to use this endpoint. + +#### Example encrypting a secret using Node.js + +Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. + +``` +const sodium = require('tweetsodium'); + +const key = "base64-encoded-public-key"; +const value = "plain-text-secret"; + +// Convert the message and key to Uint8Array's (Buffer implements that interface) +const messageBytes = Buffer.from(value); +const keyBytes = Buffer.from(key, 'base64'); + +// Encrypt using LibSodium. +const encryptedBytes = sodium.seal(messageBytes, keyBytes); + +// Base64 the encrypted secret +const encrypted = Buffer.from(encryptedBytes).toString('base64'); + +console.log(encrypted); +``` + +#### Example encrypting a secret using Python + +Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. + +``` +from base64 import b64encode +from nacl import encoding, public + +def encrypt(public_key: str, secret_value: str) -> str: + """Encrypt a Unicode string using the public key.""" + public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) + sealed_box = public.SealedBox(public_key) + encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) + return b64encode(encrypted).decode("utf-8") +``` + +#### Example encrypting a secret using C# + +Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + +``` +var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); +var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); + +var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); + +Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); +``` + +#### Example encrypting a secret using Ruby + +Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + +```ruby +require "rbnacl" +require "base64" + +key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") +public_key = RbNaCl::PublicKey.new(key) + +box = RbNaCl::Boxes::Sealed.from_public_key(public_key) +encrypted_secret = box.encrypt("my_secret") + +# Print the base64 encoded secret +puts Base64.strict_encode64(encrypted_secret) +``` + +```js +octokit.rest.dependabot.createOrUpdateRepoSecret({ + owner, + repo, + secret_name, +}); +``` + +## Parameters + + + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
secret_nameyes + +The name of the secret. + +
encrypted_valueno + +Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/dependabot#get-a-repository-public-key) endpoint. + +
key_idno + +ID of the key you used to encrypt the secret. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependabot#create-or-update-a-repository-secret). diff --git a/docs/dependabot/deleteOrgSecret.md b/docs/dependabot/deleteOrgSecret.md new file mode 100644 index 000000000..a23038de6 --- /dev/null +++ b/docs/dependabot/deleteOrgSecret.md @@ -0,0 +1,44 @@ +--- +name: Delete an organization secret +example: octokit.rest.dependabot.deleteOrgSecret({ org, secret_name }) +route: DELETE /orgs/{org}/dependabot/secrets/{secret_name} +scope: dependabot +type: API method +--- + +# Delete an organization secret + +Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + +```js +octokit.rest.dependabot.deleteOrgSecret({ + org, + secret_name, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
secret_nameyes + +The name of the secret. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependabot#delete-an-organization-secret). diff --git a/docs/dependabot/deleteRepoSecret.md b/docs/dependabot/deleteRepoSecret.md new file mode 100644 index 000000000..b37286c3a --- /dev/null +++ b/docs/dependabot/deleteRepoSecret.md @@ -0,0 +1,50 @@ +--- +name: Delete a repository secret +example: octokit.rest.dependabot.deleteRepoSecret({ owner, repo, secret_name }) +route: DELETE /repos/{owner}/{repo}/dependabot/secrets/{secret_name} +scope: dependabot +type: API method +--- + +# Delete a repository secret + +Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + +```js +octokit.rest.dependabot.deleteRepoSecret({ + owner, + repo, + secret_name, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
secret_nameyes + +The name of the secret. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependabot#delete-a-repository-secret). diff --git a/docs/dependabot/getOrgPublicKey.md b/docs/dependabot/getOrgPublicKey.md new file mode 100644 index 000000000..5a85dfc9d --- /dev/null +++ b/docs/dependabot/getOrgPublicKey.md @@ -0,0 +1,38 @@ +--- +name: Get an organization public key +example: octokit.rest.dependabot.getOrgPublicKey({ org }) +route: GET /orgs/{org}/dependabot/secrets/public-key +scope: dependabot +type: API method +--- + +# Get an organization public key + +Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + +```js +octokit.rest.dependabot.getOrgPublicKey({ + org, +}); +``` + +## Parameters + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependabot#get-an-organization-public-key). diff --git a/docs/dependabot/getOrgSecret.md b/docs/dependabot/getOrgSecret.md new file mode 100644 index 000000000..5689d35db --- /dev/null +++ b/docs/dependabot/getOrgSecret.md @@ -0,0 +1,44 @@ +--- +name: Get an organization secret +example: octokit.rest.dependabot.getOrgSecret({ org, secret_name }) +route: GET /orgs/{org}/dependabot/secrets/{secret_name} +scope: dependabot +type: API method +--- + +# Get an organization secret + +Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + +```js +octokit.rest.dependabot.getOrgSecret({ + org, + secret_name, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
secret_nameyes + +The name of the secret. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependabot#get-an-organization-secret). diff --git a/docs/dependabot/getRepoPublicKey.md b/docs/dependabot/getRepoPublicKey.md new file mode 100644 index 000000000..886fb6a1e --- /dev/null +++ b/docs/dependabot/getRepoPublicKey.md @@ -0,0 +1,44 @@ +--- +name: Get a repository public key +example: octokit.rest.dependabot.getRepoPublicKey({ owner, repo }) +route: GET /repos/{owner}/{repo}/dependabot/secrets/public-key +scope: dependabot +type: API method +--- + +# Get a repository public key + +Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + +```js +octokit.rest.dependabot.getRepoPublicKey({ + owner, + repo, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependabot#get-a-repository-public-key). diff --git a/docs/dependabot/getRepoSecret.md b/docs/dependabot/getRepoSecret.md new file mode 100644 index 000000000..41bf0dc1d --- /dev/null +++ b/docs/dependabot/getRepoSecret.md @@ -0,0 +1,50 @@ +--- +name: Get a repository secret +example: octokit.rest.dependabot.getRepoSecret({ owner, repo, secret_name }) +route: GET /repos/{owner}/{repo}/dependabot/secrets/{secret_name} +scope: dependabot +type: API method +--- + +# Get a repository secret + +Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + +```js +octokit.rest.dependabot.getRepoSecret({ + owner, + repo, + secret_name, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
secret_nameyes + +The name of the secret. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependabot#get-a-repository-secret). diff --git a/docs/dependabot/listOrgSecrets.md b/docs/dependabot/listOrgSecrets.md new file mode 100644 index 000000000..77cdfc939 --- /dev/null +++ b/docs/dependabot/listOrgSecrets.md @@ -0,0 +1,48 @@ +--- +name: List organization secrets +example: octokit.rest.dependabot.listOrgSecrets({ org }) +route: GET /orgs/{org}/dependabot/secrets +scope: dependabot +type: API method +--- + +# List organization secrets + +Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + +```js +octokit.rest.dependabot.listOrgSecrets({ + org, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
per_pageno + +The number of results per page (max 100). + +
pageno + +Page number of the results to fetch. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependabot#list-organization-secrets). diff --git a/docs/dependabot/listRepoSecrets.md b/docs/dependabot/listRepoSecrets.md new file mode 100644 index 000000000..42b0ebfdb --- /dev/null +++ b/docs/dependabot/listRepoSecrets.md @@ -0,0 +1,54 @@ +--- +name: List repository secrets +example: octokit.rest.dependabot.listRepoSecrets({ owner, repo }) +route: GET /repos/{owner}/{repo}/dependabot/secrets +scope: dependabot +type: API method +--- + +# List repository secrets + +Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + +```js +octokit.rest.dependabot.listRepoSecrets({ + owner, + repo, +}); +``` + +## Parameters + + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
per_pageno + +The number of results per page (max 100). + +
pageno + +Page number of the results to fetch. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependabot#list-repository-secrets). diff --git a/docs/dependabot/listSelectedReposForOrgSecret.md b/docs/dependabot/listSelectedReposForOrgSecret.md new file mode 100644 index 000000000..797546ae4 --- /dev/null +++ b/docs/dependabot/listSelectedReposForOrgSecret.md @@ -0,0 +1,54 @@ +--- +name: List selected repositories for an organization secret +example: octokit.rest.dependabot.listSelectedReposForOrgSecret({ org, secret_name }) +route: GET /orgs/{org}/dependabot/secrets/{secret_name}/repositories +scope: dependabot +type: API method +--- + +# List selected repositories for an organization secret + +Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + +```js +octokit.rest.dependabot.listSelectedReposForOrgSecret({ + org, + secret_name, +}); +``` + +## Parameters + + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
secret_nameyes + +The name of the secret. + +
pageno + +Page number of the results to fetch. + +
per_pageno + +The number of results per page (max 100). + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependabot#list-selected-repositories-for-an-organization-secret). diff --git a/docs/dependabot/removeSelectedRepoFromOrgSecret.md b/docs/dependabot/removeSelectedRepoFromOrgSecret.md new file mode 100644 index 000000000..38824d0b0 --- /dev/null +++ b/docs/dependabot/removeSelectedRepoFromOrgSecret.md @@ -0,0 +1,48 @@ +--- +name: Remove selected repository from an organization secret +example: octokit.rest.dependabot.removeSelectedRepoFromOrgSecret({ org, secret_name, repository_id }) +route: DELETE /orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id} +scope: dependabot +type: API method +--- + +# Remove selected repository from an organization secret + +Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + +```js +octokit.rest.dependabot.removeSelectedRepoFromOrgSecret({ + org, + secret_name, + repository_id, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
secret_nameyes + +The name of the secret. + +
repository_idyes + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret). diff --git a/docs/dependabot/setSelectedReposForOrgSecret.md b/docs/dependabot/setSelectedReposForOrgSecret.md new file mode 100644 index 000000000..f8133ad3b --- /dev/null +++ b/docs/dependabot/setSelectedReposForOrgSecret.md @@ -0,0 +1,50 @@ +--- +name: Set selected repositories for an organization secret +example: octokit.rest.dependabot.setSelectedReposForOrgSecret({ org, secret_name, selected_repository_ids }) +route: PUT /orgs/{org}/dependabot/secrets/{secret_name}/repositories +scope: dependabot +type: API method +--- + +# Set selected repositories for an organization secret + +Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + +```js +octokit.rest.dependabot.setSelectedReposForOrgSecret({ + org, + secret_name, + selected_repository_ids, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
secret_nameyes + +The name of the secret. + +
selected_repository_idsyes + +An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret). diff --git a/docs/dependencyGraph/diffRange.md b/docs/dependencyGraph/diffRange.md new file mode 100644 index 000000000..b6c426974 --- /dev/null +++ b/docs/dependencyGraph/diffRange.md @@ -0,0 +1,55 @@ +--- +name: Get a diff of the dependencies between commits +example: octokit.rest.dependencyGraph.diffRange({ owner, repo, basehead }) +route: GET /repos/{owner}/{repo}/dependency-graph/compare/{basehead} +scope: dependencyGraph +type: API method +--- + +# Get a diff of the dependencies between commits + +Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits. + +```js +octokit.rest.dependencyGraph.diffRange({ + owner, + repo, + basehead, +}); +``` + +## Parameters + + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
baseheadyes + +The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their corresponding HEAD commits, and an appropriate merge base will be determined. This parameter expects the format `{base}...{head}`. + +
nameno + +The full path, relative to the repository root, of the dependency manifest file. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependency-graph#get-a-diff-of-the-dependencies-between-commits). diff --git a/docs/enterpriseAdmin/addCustomLabelsToSelfHostedRunnerForEnterprise.md b/docs/enterpriseAdmin/addCustomLabelsToSelfHostedRunnerForEnterprise.md new file mode 100644 index 000000000..001c95c37 --- /dev/null +++ b/docs/enterpriseAdmin/addCustomLabelsToSelfHostedRunnerForEnterprise.md @@ -0,0 +1,52 @@ +--- +name: Add custom labels to a self-hosted runner for an enterprise +example: octokit.rest.enterpriseAdmin.addCustomLabelsToSelfHostedRunnerForEnterprise({ enterprise, runner_id, labels }) +route: POST /enterprises/{enterprise}/actions/runners/{runner_id}/labels +scope: enterpriseAdmin +type: API method +--- + +# Add custom labels to a self-hosted runner for an enterprise + +Add custom labels to a self-hosted runner configured in an enterprise. + +You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + +```js +octokit.rest.enterpriseAdmin.addCustomLabelsToSelfHostedRunnerForEnterprise({ + enterprise, + runner_id, + labels, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
enterpriseyes + +The slug version of the enterprise name. You can also substitute this value with the enterprise id. + +
runner_idyes + +Unique identifier of the self-hosted runner. + +
labelsyes + +The names of the custom labels to add to the runner. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise). diff --git a/docs/enterpriseAdmin/disableSelectedOrganizationGithubActionsEnterprise.md b/docs/enterpriseAdmin/disableSelectedOrganizationGithubActionsEnterprise.md index 92da80d5d..27ef28c06 100644 --- a/docs/enterpriseAdmin/disableSelectedOrganizationGithubActionsEnterprise.md +++ b/docs/enterpriseAdmin/disableSelectedOrganizationGithubActionsEnterprise.md @@ -39,10 +39,10 @@ The slug version of the enterprise name. You can also substitute this value with org_idyes -Unique identifier of an organization. +The unique identifier of the organization. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/enterprise-admin#disable-a-selected-organization-for-github-actions-in-an-enterprise). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#disable-a-selected-organization-for-github-actions-in-an-enterprise). diff --git a/docs/enterpriseAdmin/enableSelectedOrganizationGithubActionsEnterprise.md b/docs/enterpriseAdmin/enableSelectedOrganizationGithubActionsEnterprise.md index 18df7c25a..00d325d39 100644 --- a/docs/enterpriseAdmin/enableSelectedOrganizationGithubActionsEnterprise.md +++ b/docs/enterpriseAdmin/enableSelectedOrganizationGithubActionsEnterprise.md @@ -37,10 +37,10 @@ The slug version of the enterprise name. You can also substitute this value with org_idyes -Unique identifier of an organization. +The unique identifier of the organization. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/enterprise-admin#enable-a-selected-organization-for-github-actions-in-an-enterprise). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#enable-a-selected-organization-for-github-actions-in-an-enterprise). diff --git a/docs/enterpriseAdmin/getAllowedActionsEnterprise.md b/docs/enterpriseAdmin/getAllowedActionsEnterprise.md index 10208949a..d083b9dde 100644 --- a/docs/enterpriseAdmin/getAllowedActionsEnterprise.md +++ b/docs/enterpriseAdmin/getAllowedActionsEnterprise.md @@ -1,14 +1,14 @@ --- -name: Get allowed actions for an enterprise +name: Get allowed actions and reusable workflows for an enterprise example: octokit.rest.enterpriseAdmin.getAllowedActionsEnterprise({ enterprise }) route: GET /enterprises/{enterprise}/actions/permissions/selected-actions scope: enterpriseAdmin type: API method --- -# Get allowed actions for an enterprise +# Get allowed actions and reusable workflows for an enterprise -Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." +Gets the selected actions and reusable workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. @@ -37,4 +37,4 @@ The slug version of the enterprise name. You can also substitute this value with -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/enterprise-admin#get-allowed-actions-for-an-enterprise). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-allowed-actions-for-an-enterprise). diff --git a/docs/enterpriseAdmin/getGithubActionsPermissionsEnterprise.md b/docs/enterpriseAdmin/getGithubActionsPermissionsEnterprise.md index eee891efe..2cb8fb6b5 100644 --- a/docs/enterpriseAdmin/getGithubActionsPermissionsEnterprise.md +++ b/docs/enterpriseAdmin/getGithubActionsPermissionsEnterprise.md @@ -8,7 +8,7 @@ type: API method # Get GitHub Actions permissions for an enterprise -Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. +Gets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise. You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. @@ -37,4 +37,4 @@ The slug version of the enterprise name. You can also substitute this value with -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/enterprise-admin#get-github-actions-permissions-for-an-enterprise). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-github-actions-permissions-for-an-enterprise). diff --git a/docs/enterpriseAdmin/getServerStatistics.md b/docs/enterpriseAdmin/getServerStatistics.md new file mode 100644 index 000000000..5bc0b7401 --- /dev/null +++ b/docs/enterpriseAdmin/getServerStatistics.md @@ -0,0 +1,57 @@ +--- +name: Get GitHub Enterprise Server statistics +example: octokit.rest.enterpriseAdmin.getServerStatistics({ enterprise_or_org }) +route: GET /enterprise-installation/{enterprise_or_org}/server-statistics +scope: enterpriseAdmin +type: API method +--- + +# Get GitHub Enterprise Server statistics + +Returns aggregate usage metrics for your GitHub Enterprise Server 3.5+ instance for a specified time period up to 365 days. + +To use this endpoint, your GitHub Enterprise Server instance must be connected to GitHub Enterprise Cloud using GitHub Connect. You must enable Server Statistics, and for the API request provide your enterprise account name or organization name connected to the GitHub Enterprise Server. For more information, see "[Enabling Server Statistics for your enterprise](/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise)" in the GitHub Enterprise Server documentation. + +You'll need to use a personal access token: + +- If you connected your GitHub Enterprise Server to an enterprise account and enabled Server Statistics, you'll need a personal access token with the `read:enterprise` permission. +- If you connected your GitHub Enterprise Server to an organization account and enabled Server Statistics, you'll need a personal access token with the `read:org` permission. + +For more information on creating a personal access token, see "[Creating a personal access token](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." + +```js +octokit.rest.enterpriseAdmin.getServerStatistics({ + enterprise_or_org, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
enterprise_or_orgyes + +The slug version of the enterprise name or the login of an organization. + +
date_startno + +A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. + +
date_endno + +A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/enterprise-admin#get-github-enterprise-server-statistics). diff --git a/docs/enterpriseAdmin/listLabelsForSelfHostedRunnerForEnterprise.md b/docs/enterpriseAdmin/listLabelsForSelfHostedRunnerForEnterprise.md new file mode 100644 index 000000000..e1ea31a1e --- /dev/null +++ b/docs/enterpriseAdmin/listLabelsForSelfHostedRunnerForEnterprise.md @@ -0,0 +1,46 @@ +--- +name: List labels for a self-hosted runner for an enterprise +example: octokit.rest.enterpriseAdmin.listLabelsForSelfHostedRunnerForEnterprise({ enterprise, runner_id }) +route: GET /enterprises/{enterprise}/actions/runners/{runner_id}/labels +scope: enterpriseAdmin +type: API method +--- + +# List labels for a self-hosted runner for an enterprise + +Lists all labels for a self-hosted runner configured in an enterprise. + +You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + +```js +octokit.rest.enterpriseAdmin.listLabelsForSelfHostedRunnerForEnterprise({ + enterprise, + runner_id, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
enterpriseyes + +The slug version of the enterprise name. You can also substitute this value with the enterprise id. + +
runner_idyes + +Unique identifier of the self-hosted runner. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-an-enterprise). diff --git a/docs/enterpriseAdmin/listSelectedOrganizationsEnabledGithubActionsEnterprise.md b/docs/enterpriseAdmin/listSelectedOrganizationsEnabledGithubActionsEnterprise.md index 1401057fe..62f3356d3 100644 --- a/docs/enterpriseAdmin/listSelectedOrganizationsEnabledGithubActionsEnterprise.md +++ b/docs/enterpriseAdmin/listSelectedOrganizationsEnabledGithubActionsEnterprise.md @@ -38,7 +38,7 @@ The slug version of the enterprise name. You can also substitute this value with per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno @@ -49,4 +49,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/enterprise-admin#list-selected-organizations-enabled-for-github-actions-in-an-enterprise). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#list-selected-organizations-enabled-for-github-actions-in-an-enterprise). diff --git a/docs/enterpriseAdmin/removeAllCustomLabelsFromSelfHostedRunnerForEnterprise.md b/docs/enterpriseAdmin/removeAllCustomLabelsFromSelfHostedRunnerForEnterprise.md new file mode 100644 index 000000000..abe2df37e --- /dev/null +++ b/docs/enterpriseAdmin/removeAllCustomLabelsFromSelfHostedRunnerForEnterprise.md @@ -0,0 +1,49 @@ +--- +name: Remove all custom labels from a self-hosted runner for an enterprise +example: octokit.rest.enterpriseAdmin.removeAllCustomLabelsFromSelfHostedRunnerForEnterprise({ enterprise, runner_id }) +route: DELETE /enterprises/{enterprise}/actions/runners/{runner_id}/labels +scope: enterpriseAdmin +type: API method +--- + +# Remove all custom labels from a self-hosted runner for an enterprise + +Remove all custom labels from a self-hosted runner configured in an +enterprise. Returns the remaining read-only labels from the runner. + +You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + +```js +octokit.rest.enterpriseAdmin.removeAllCustomLabelsFromSelfHostedRunnerForEnterprise( + { + enterprise, + runner_id, + } +); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
enterpriseyes + +The slug version of the enterprise name. You can also substitute this value with the enterprise id. + +
runner_idyes + +Unique identifier of the self-hosted runner. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise). diff --git a/docs/enterpriseAdmin/removeCustomLabelFromSelfHostedRunnerForEnterprise.md b/docs/enterpriseAdmin/removeCustomLabelFromSelfHostedRunnerForEnterprise.md new file mode 100644 index 000000000..964aa1959 --- /dev/null +++ b/docs/enterpriseAdmin/removeCustomLabelFromSelfHostedRunnerForEnterprise.md @@ -0,0 +1,58 @@ +--- +name: Remove a custom label from a self-hosted runner for an enterprise +example: octokit.rest.enterpriseAdmin.removeCustomLabelFromSelfHostedRunnerForEnterprise({ enterprise, runner_id, name }) +route: DELETE /enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name} +scope: enterpriseAdmin +type: API method +--- + +# Remove a custom label from a self-hosted runner for an enterprise + +Remove a custom label from a self-hosted runner configured +in an enterprise. Returns the remaining labels from the runner. + +This endpoint returns a `404 Not Found` status if the custom label is not +present on the runner. + +You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + +```js +octokit.rest.enterpriseAdmin.removeCustomLabelFromSelfHostedRunnerForEnterprise( + { + enterprise, + runner_id, + name, + } +); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
enterpriseyes + +The slug version of the enterprise name. You can also substitute this value with the enterprise id. + +
runner_idyes + +Unique identifier of the self-hosted runner. + +
nameyes + +The name of a self-hosted runner's custom label. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise). diff --git a/docs/enterpriseAdmin/setAllowedActionsEnterprise.md b/docs/enterpriseAdmin/setAllowedActionsEnterprise.md index 2cf31b7a7..c168527ba 100644 --- a/docs/enterpriseAdmin/setAllowedActionsEnterprise.md +++ b/docs/enterpriseAdmin/setAllowedActionsEnterprise.md @@ -1,14 +1,14 @@ --- -name: Set allowed actions for an enterprise +name: Set allowed actions and reusable workflows for an enterprise example: octokit.rest.enterpriseAdmin.setAllowedActionsEnterprise({ enterprise }) route: PUT /enterprises/{enterprise}/actions/permissions/selected-actions scope: enterpriseAdmin type: API method --- -# Set allowed actions for an enterprise +# Set allowed actions and reusable workflows for an enterprise -Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." +Sets the actions and reusable workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. @@ -41,15 +41,15 @@ Whether GitHub-owned actions are allowed. For example, this includes the actions verified_allowedno -Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators. +Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators. patterns_allowedno -Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`." +Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`." -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/enterprise-admin#set-allowed-actions-for-an-enterprise). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#set-allowed-actions-for-an-enterprise). diff --git a/docs/enterpriseAdmin/setCustomLabelsForSelfHostedRunnerForEnterprise.md b/docs/enterpriseAdmin/setCustomLabelsForSelfHostedRunnerForEnterprise.md new file mode 100644 index 000000000..e408e3b9e --- /dev/null +++ b/docs/enterpriseAdmin/setCustomLabelsForSelfHostedRunnerForEnterprise.md @@ -0,0 +1,53 @@ +--- +name: Set custom labels for a self-hosted runner for an enterprise +example: octokit.rest.enterpriseAdmin.setCustomLabelsForSelfHostedRunnerForEnterprise({ enterprise, runner_id, labels }) +route: PUT /enterprises/{enterprise}/actions/runners/{runner_id}/labels +scope: enterpriseAdmin +type: API method +--- + +# Set custom labels for a self-hosted runner for an enterprise + +Remove all previous custom labels and set the new custom labels for a specific +self-hosted runner configured in an enterprise. + +You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + +```js +octokit.rest.enterpriseAdmin.setCustomLabelsForSelfHostedRunnerForEnterprise({ + enterprise, + runner_id, + labels, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
enterpriseyes + +The slug version of the enterprise name. You can also substitute this value with the enterprise id. + +
runner_idyes + +Unique identifier of the self-hosted runner. + +
labelsyes + +The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise). diff --git a/docs/enterpriseAdmin/setGithubActionsPermissionsEnterprise.md b/docs/enterpriseAdmin/setGithubActionsPermissionsEnterprise.md index d327941b4..e42a3b69a 100644 --- a/docs/enterpriseAdmin/setGithubActionsPermissionsEnterprise.md +++ b/docs/enterpriseAdmin/setGithubActionsPermissionsEnterprise.md @@ -8,7 +8,7 @@ type: API method # Set GitHub Actions permissions for an enterprise -Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. +Sets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise. You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. @@ -37,15 +37,15 @@ The slug version of the enterprise name. You can also substitute this value with enabled_organizationsyes -The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`. +The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. allowed_actionsno -The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`. +The permissions policy that controls the actions and reusable workflows that are allowed to run. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/enterprise-admin#set-github-actions-permissions-for-an-enterprise). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#set-github-actions-permissions-for-an-enterprise). diff --git a/docs/enterpriseAdmin/setSelectedOrganizationsEnabledGithubActionsEnterprise.md b/docs/enterpriseAdmin/setSelectedOrganizationsEnabledGithubActionsEnterprise.md index 78626d5da..65496d1f2 100644 --- a/docs/enterpriseAdmin/setSelectedOrganizationsEnabledGithubActionsEnterprise.md +++ b/docs/enterpriseAdmin/setSelectedOrganizationsEnabledGithubActionsEnterprise.md @@ -45,4 +45,4 @@ List of organization IDs to enable for GitHub Actions. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/enterprise-admin#set-selected-organizations-enabled-for-github-actions-in-an-enterprise). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#set-selected-organizations-enabled-for-github-actions-in-an-enterprise). diff --git a/docs/gists/checkIsStarred.md b/docs/gists/checkIsStarred.md index 7a674cdb1..1802a9e2b 100644 --- a/docs/gists/checkIsStarred.md +++ b/docs/gists/checkIsStarred.md @@ -27,7 +27,7 @@ octokit.rest.gists.checkIsStarred({ gist_idyes -gist_id parameter +The unique identifier of the gist. diff --git a/docs/gists/createComment.md b/docs/gists/createComment.md index c310e115a..4402b6d8b 100644 --- a/docs/gists/createComment.md +++ b/docs/gists/createComment.md @@ -28,7 +28,7 @@ octokit.rest.gists.createComment({ gist_idyes -gist_id parameter +The unique identifier of the gist. bodyyes diff --git a/docs/gists/delete.md b/docs/gists/delete.md index 466337ef0..56fa5bb50 100644 --- a/docs/gists/delete.md +++ b/docs/gists/delete.md @@ -27,7 +27,7 @@ octokit.rest.gists.delete({ gist_idyes -gist_id parameter +The unique identifier of the gist. diff --git a/docs/gists/deleteComment.md b/docs/gists/deleteComment.md index 48b164adf..6c5ba2c7e 100644 --- a/docs/gists/deleteComment.md +++ b/docs/gists/deleteComment.md @@ -28,12 +28,12 @@ octokit.rest.gists.deleteComment({ gist_idyes -gist_id parameter +The unique identifier of the gist. comment_idyes -comment_id parameter +The unique identifier of the comment. diff --git a/docs/gists/fork.md b/docs/gists/fork.md index 715e3710e..9ec70089d 100644 --- a/docs/gists/fork.md +++ b/docs/gists/fork.md @@ -29,7 +29,7 @@ octokit.rest.gists.fork({ gist_idyes -gist_id parameter +The unique identifier of the gist. diff --git a/docs/gists/get.md b/docs/gists/get.md index 21c862e40..9fc9b9e52 100644 --- a/docs/gists/get.md +++ b/docs/gists/get.md @@ -27,7 +27,7 @@ octokit.rest.gists.get({ gist_idyes -gist_id parameter +The unique identifier of the gist. diff --git a/docs/gists/getComment.md b/docs/gists/getComment.md index d34f81377..bd7f87788 100644 --- a/docs/gists/getComment.md +++ b/docs/gists/getComment.md @@ -28,12 +28,12 @@ octokit.rest.gists.getComment({ gist_idyes -gist_id parameter +The unique identifier of the gist. comment_idyes -comment_id parameter +The unique identifier of the comment. diff --git a/docs/gists/getRevision.md b/docs/gists/getRevision.md index ba30b3003..cade7f8bf 100644 --- a/docs/gists/getRevision.md +++ b/docs/gists/getRevision.md @@ -28,7 +28,7 @@ octokit.rest.gists.getRevision({ gist_idyes -gist_id parameter +The unique identifier of the gist. shayes diff --git a/docs/gists/list.md b/docs/gists/list.md index a383acc10..deda928d2 100644 --- a/docs/gists/list.md +++ b/docs/gists/list.md @@ -32,7 +32,7 @@ Only show notifications updated after the given time. This is a timestamp in [IS per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/gists/listComments.md b/docs/gists/listComments.md index beec30e2c..2a02869b5 100644 --- a/docs/gists/listComments.md +++ b/docs/gists/listComments.md @@ -27,12 +27,12 @@ octokit.rest.gists.listComments({ gist_idyes -gist_id parameter +The unique identifier of the gist. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/gists/listCommits.md b/docs/gists/listCommits.md index 91908297b..07f8a9c9c 100644 --- a/docs/gists/listCommits.md +++ b/docs/gists/listCommits.md @@ -27,12 +27,12 @@ octokit.rest.gists.listCommits({ gist_idyes -gist_id parameter +The unique identifier of the gist. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/gists/listForUser.md b/docs/gists/listForUser.md index af63066a9..5134ae360 100644 --- a/docs/gists/listForUser.md +++ b/docs/gists/listForUser.md @@ -29,6 +29,8 @@ octokit.rest.gists.listForUser({ usernameyes +The handle for the GitHub user account. + sinceno @@ -37,7 +39,7 @@ Only show notifications updated after the given time. This is a timestamp in [IS per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/gists/listForks.md b/docs/gists/listForks.md index a848566f3..338d0c3a4 100644 --- a/docs/gists/listForks.md +++ b/docs/gists/listForks.md @@ -27,12 +27,12 @@ octokit.rest.gists.listForks({ gist_idyes -gist_id parameter +The unique identifier of the gist. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/gists/listPublic.md b/docs/gists/listPublic.md index 34a2e14b4..4ce81dd93 100644 --- a/docs/gists/listPublic.md +++ b/docs/gists/listPublic.md @@ -34,7 +34,7 @@ Only show notifications updated after the given time. This is a timestamp in [IS per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/gists/listStarred.md b/docs/gists/listStarred.md index cbca74755..81ed2fb5e 100644 --- a/docs/gists/listStarred.md +++ b/docs/gists/listStarred.md @@ -32,7 +32,7 @@ Only show notifications updated after the given time. This is a timestamp in [IS per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/gists/star.md b/docs/gists/star.md index f917d02a1..3d0054a8e 100644 --- a/docs/gists/star.md +++ b/docs/gists/star.md @@ -29,7 +29,7 @@ octokit.rest.gists.star({ gist_idyes -gist_id parameter +The unique identifier of the gist. diff --git a/docs/gists/unstar.md b/docs/gists/unstar.md index 82b46c87d..60c54a948 100644 --- a/docs/gists/unstar.md +++ b/docs/gists/unstar.md @@ -27,7 +27,7 @@ octokit.rest.gists.unstar({ gist_idyes -gist_id parameter +The unique identifier of the gist. diff --git a/docs/gists/update.md b/docs/gists/update.md index 3e0b1970f..73b3055c3 100644 --- a/docs/gists/update.md +++ b/docs/gists/update.md @@ -29,7 +29,7 @@ octokit.rest.gists.update({ gist_idyes -gist_id parameter +The unique identifier of the gist. descriptionno diff --git a/docs/gists/updateComment.md b/docs/gists/updateComment.md index 766655b9b..68cf20c3a 100644 --- a/docs/gists/updateComment.md +++ b/docs/gists/updateComment.md @@ -29,12 +29,12 @@ octokit.rest.gists.updateComment({ gist_idyes -gist_id parameter +The unique identifier of the gist. comment_idyes -comment_id parameter +The unique identifier of the comment. bodyyes diff --git a/docs/git/createBlob.md b/docs/git/createBlob.md index 173a51886..4df0e0576 100644 --- a/docs/git/createBlob.md +++ b/docs/git/createBlob.md @@ -29,9 +29,13 @@ octokit.rest.git.createBlob({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + contentyes diff --git a/docs/git/createCommit.md b/docs/git/createCommit.md index becafab92..e52b15c4d 100644 --- a/docs/git/createCommit.md +++ b/docs/git/createCommit.md @@ -14,12 +14,12 @@ Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-G The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: -| Name | Type | Description | -| ----------- | --------- | ------------------------------------------------------------------------------------------------ | -| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | -| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | -| `signature` | `string` | The signature that was extracted from the commit. | -| `payload` | `string` | The value that was signed. | +| Name | Type | Description | +| ----------- | --------- | ---------------------------------------------------------------------------------------------------- | +| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | +| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | +| `signature` | `string` | The signature that was extracted from the commit. | +| `payload` | `string` | The value that was signed. | These are the possible values for `reason` in the `verification` object: @@ -63,9 +63,13 @@ author.email owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + messageyes diff --git a/docs/git/createRef.md b/docs/git/createRef.md index 547ced6e5..04628596c 100644 --- a/docs/git/createRef.md +++ b/docs/git/createRef.md @@ -32,9 +32,13 @@ octokit.rest.git.createRef({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + refyes diff --git a/docs/git/createTag.md b/docs/git/createTag.md index ea3924643..144689545 100644 --- a/docs/git/createTag.md +++ b/docs/git/createTag.md @@ -65,9 +65,13 @@ tagger.email owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + tagyes diff --git a/docs/git/createTree.md b/docs/git/createTree.md index 8296d212e..c072eca05 100644 --- a/docs/git/createTree.md +++ b/docs/git/createTree.md @@ -33,9 +33,13 @@ octokit.rest.git.createTree({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + treeyes diff --git a/docs/git/deleteRef.md b/docs/git/deleteRef.md index 8d94e6f26..baaa20dc8 100644 --- a/docs/git/deleteRef.md +++ b/docs/git/deleteRef.md @@ -29,9 +29,13 @@ octokit.rest.git.deleteRef({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + refyes diff --git a/docs/git/getBlob.md b/docs/git/getBlob.md index 68910acc7..6be3b9be6 100644 --- a/docs/git/getBlob.md +++ b/docs/git/getBlob.md @@ -33,9 +33,13 @@ octokit.rest.git.getBlob({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + file_shayes diff --git a/docs/git/getCommit.md b/docs/git/getCommit.md index c9ab9cdb2..fc85ea251 100644 --- a/docs/git/getCommit.md +++ b/docs/git/getCommit.md @@ -14,12 +14,12 @@ Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Obje The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: -| Name | Type | Description | -| ----------- | --------- | ------------------------------------------------------------------------------------------------ | -| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | -| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | -| `signature` | `string` | The signature that was extracted from the commit. | -| `payload` | `string` | The value that was signed. | +| Name | Type | Description | +| ----------- | --------- | ---------------------------------------------------------------------------------------------------- | +| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | +| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | +| `signature` | `string` | The signature that was extracted from the commit. | +| `payload` | `string` | The value that was signed. | These are the possible values for `reason` in the `verification` object: @@ -60,13 +60,17 @@ octokit.rest.git.getCommit({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + commit_shayes -commit_sha parameter +The SHA of the commit. diff --git a/docs/git/getRef.md b/docs/git/getRef.md index 53699447f..59d546eb6 100644 --- a/docs/git/getRef.md +++ b/docs/git/getRef.md @@ -33,9 +33,13 @@ octokit.rest.git.getRef({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + refyes diff --git a/docs/git/getTag.md b/docs/git/getTag.md index a76a18128..61c22aa19 100644 --- a/docs/git/getTag.md +++ b/docs/git/getTag.md @@ -58,9 +58,13 @@ octokit.rest.git.getTag({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + tag_shayes diff --git a/docs/git/getTree.md b/docs/git/getTree.md index 7830a7e76..2757ad41c 100644 --- a/docs/git/getTree.md +++ b/docs/git/getTree.md @@ -33,9 +33,13 @@ octokit.rest.git.getTree({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + tree_shayes diff --git a/docs/git/listMatchingRefs.md b/docs/git/listMatchingRefs.md index 0c159fae5..8ceac9ef7 100644 --- a/docs/git/listMatchingRefs.md +++ b/docs/git/listMatchingRefs.md @@ -37,9 +37,13 @@ octokit.rest.git.listMatchingRefs({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + refyes @@ -48,7 +52,7 @@ ref parameter per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/git/updateRef.md b/docs/git/updateRef.md index bb6edf0d9..4928b44dc 100644 --- a/docs/git/updateRef.md +++ b/docs/git/updateRef.md @@ -30,9 +30,13 @@ octokit.rest.git.updateRef({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + refyes diff --git a/docs/interactions/getRestrictionsForOrg.md b/docs/interactions/getRestrictionsForOrg.md index feac9f84b..6b4d1000f 100644 --- a/docs/interactions/getRestrictionsForOrg.md +++ b/docs/interactions/getRestrictionsForOrg.md @@ -29,6 +29,8 @@ octokit.rest.interactions.getRestrictionsForOrg({ orgyes +The organization name. The name is not case sensitive. + diff --git a/docs/interactions/getRestrictionsForRepo.md b/docs/interactions/getRestrictionsForRepo.md index 0849b41c6..558a74a64 100644 --- a/docs/interactions/getRestrictionsForRepo.md +++ b/docs/interactions/getRestrictionsForRepo.md @@ -30,9 +30,13 @@ octokit.rest.interactions.getRestrictionsForRepo({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/interactions/removeRestrictionsForOrg.md b/docs/interactions/removeRestrictionsForOrg.md index 0fea01327..f86789378 100644 --- a/docs/interactions/removeRestrictionsForOrg.md +++ b/docs/interactions/removeRestrictionsForOrg.md @@ -29,6 +29,8 @@ octokit.rest.interactions.removeRestrictionsForOrg({ orgyes +The organization name. The name is not case sensitive. + diff --git a/docs/interactions/removeRestrictionsForRepo.md b/docs/interactions/removeRestrictionsForRepo.md index 4cb578800..8ab5ac6b2 100644 --- a/docs/interactions/removeRestrictionsForRepo.md +++ b/docs/interactions/removeRestrictionsForRepo.md @@ -30,9 +30,13 @@ octokit.rest.interactions.removeRestrictionsForRepo({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/interactions/setRestrictionsForAuthenticatedUser.md b/docs/interactions/setRestrictionsForAuthenticatedUser.md index ce2930ba1..aa1c414a4 100644 --- a/docs/interactions/setRestrictionsForAuthenticatedUser.md +++ b/docs/interactions/setRestrictionsForAuthenticatedUser.md @@ -29,12 +29,12 @@ octokit.rest.interactions.setRestrictionsForAuthenticatedUser({ limityes -The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Can be one of: `existing_users`, `contributors_only`, `collaborators_only`. +The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. expiryno -The duration of the interaction restriction. Can be one of: `one_day`, `three_days`, `one_week`, `one_month`, `six_months`. Default: `one_day`. +The duration of the interaction restriction. Default: `one_day`. diff --git a/docs/interactions/setRestrictionsForOrg.md b/docs/interactions/setRestrictionsForOrg.md index ac5a0a6b4..3dfefb58c 100644 --- a/docs/interactions/setRestrictionsForOrg.md +++ b/docs/interactions/setRestrictionsForOrg.md @@ -30,15 +30,17 @@ octokit.rest.interactions.setRestrictionsForOrg({ orgyes +The organization name. The name is not case sensitive. + limityes -The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Can be one of: `existing_users`, `contributors_only`, `collaborators_only`. +The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. expiryno -The duration of the interaction restriction. Can be one of: `one_day`, `three_days`, `one_week`, `one_month`, `six_months`. Default: `one_day`. +The duration of the interaction restriction. Default: `one_day`. diff --git a/docs/interactions/setRestrictionsForRepo.md b/docs/interactions/setRestrictionsForRepo.md index 9fe5d8660..7f0c81b43 100644 --- a/docs/interactions/setRestrictionsForRepo.md +++ b/docs/interactions/setRestrictionsForRepo.md @@ -31,18 +31,22 @@ octokit.rest.interactions.setRestrictionsForRepo({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + limityes -The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Can be one of: `existing_users`, `contributors_only`, `collaborators_only`. +The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. expiryno -The duration of the interaction restriction. Can be one of: `one_day`, `three_days`, `one_week`, `one_month`, `six_months`. Default: `one_day`. +The duration of the interaction restriction. Default: `one_day`. diff --git a/docs/interactions/setRestrictionsForYourPublicRepos.md b/docs/interactions/setRestrictionsForYourPublicRepos.md index 5fb36c2bc..eaab01084 100644 --- a/docs/interactions/setRestrictionsForYourPublicRepos.md +++ b/docs/interactions/setRestrictionsForYourPublicRepos.md @@ -31,12 +31,12 @@ octokit.rest.interactions.setRestrictionsForYourPublicRepos({ limityes -The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Can be one of: `existing_users`, `contributors_only`, `collaborators_only`. +The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. expiryno -The duration of the interaction restriction. Can be one of: `one_day`, `three_days`, `one_week`, `one_month`, `six_months`. Default: `one_day`. +The duration of the interaction restriction. Default: `one_day`. diff --git a/docs/issues/addAssignees.md b/docs/issues/addAssignees.md index 65768d387..ffcf46a8f 100644 --- a/docs/issues/addAssignees.md +++ b/docs/issues/addAssignees.md @@ -31,13 +31,17 @@ octokit.rest.issues.addAssignees({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + issue_numberyes -issue_number parameter +The number that identifies the issue. assigneesno diff --git a/docs/issues/addLabels.md b/docs/issues/addLabels.md index 2e0909889..6b23d358b 100644 --- a/docs/issues/addLabels.md +++ b/docs/issues/addLabels.md @@ -30,13 +30,17 @@ labels[].name owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + issue_numberyes -issue_number parameter +The number that identifies the issue. labelsno diff --git a/docs/issues/checkUserCanBeAssigned.md b/docs/issues/checkUserCanBeAssigned.md index 2968a9985..c1f013e92 100644 --- a/docs/issues/checkUserCanBeAssigned.md +++ b/docs/issues/checkUserCanBeAssigned.md @@ -35,9 +35,13 @@ octokit.rest.issues.checkUserCanBeAssigned({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + assigneeyes diff --git a/docs/issues/create.md b/docs/issues/create.md index 30ae8b3b1..b5d5caef9 100644 --- a/docs/issues/create.md +++ b/docs/issues/create.md @@ -8,9 +8,9 @@ type: API method # Create an issue -Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. +Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. -This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. +This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. ```js octokit.rest.issues.create({ @@ -33,9 +33,13 @@ octokit.rest.issues.create({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + titleyes diff --git a/docs/issues/createComment.md b/docs/issues/createComment.md index 0b1a424ff..417beb842 100644 --- a/docs/issues/createComment.md +++ b/docs/issues/createComment.md @@ -8,7 +8,7 @@ type: API method # Create an issue comment -This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. +This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. ```js octokit.rest.issues.createComment({ @@ -32,13 +32,17 @@ octokit.rest.issues.createComment({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + issue_numberyes -issue_number parameter +The number that identifies the issue. bodyyes diff --git a/docs/issues/createLabel.md b/docs/issues/createLabel.md index e571aa273..1447f41db 100644 --- a/docs/issues/createLabel.md +++ b/docs/issues/createLabel.md @@ -29,9 +29,13 @@ octokit.rest.issues.createLabel({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + nameyes @@ -45,7 +49,7 @@ The [hexadecimal color code](http://www.color-hex.com/) for the label, without t descriptionno -A short description of the label. +A short description of the label. Must be 100 characters or fewer. diff --git a/docs/issues/createMilestone.md b/docs/issues/createMilestone.md index fdb70d8da..9f69e3a71 100644 --- a/docs/issues/createMilestone.md +++ b/docs/issues/createMilestone.md @@ -29,9 +29,13 @@ octokit.rest.issues.createMilestone({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + titleyes diff --git a/docs/issues/deleteComment.md b/docs/issues/deleteComment.md index acd582356..2a0ad1be3 100644 --- a/docs/issues/deleteComment.md +++ b/docs/issues/deleteComment.md @@ -29,13 +29,17 @@ octokit.rest.issues.deleteComment({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + comment_idyes -comment_id parameter +The unique identifier of the comment. diff --git a/docs/issues/deleteLabel.md b/docs/issues/deleteLabel.md index 8290e2a7f..b862187ae 100644 --- a/docs/issues/deleteLabel.md +++ b/docs/issues/deleteLabel.md @@ -29,9 +29,13 @@ octokit.rest.issues.deleteLabel({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + nameyes diff --git a/docs/issues/deleteMilestone.md b/docs/issues/deleteMilestone.md index 849b12eb0..7a21d7255 100644 --- a/docs/issues/deleteMilestone.md +++ b/docs/issues/deleteMilestone.md @@ -29,13 +29,17 @@ octokit.rest.issues.deleteMilestone({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + milestone_numberyes -milestone_number parameter +The number that identifies the milestone. diff --git a/docs/issues/get.md b/docs/issues/get.md index 53c13176c..a6f350981 100644 --- a/docs/issues/get.md +++ b/docs/issues/get.md @@ -9,7 +9,7 @@ type: API method # Get an issue The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was -[transferred](https://help.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If +[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe @@ -41,13 +41,17 @@ octokit.rest.issues.get({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + issue_numberyes -issue_number parameter +The number that identifies the issue. diff --git a/docs/issues/getComment.md b/docs/issues/getComment.md index b85ba9cc4..50740069e 100644 --- a/docs/issues/getComment.md +++ b/docs/issues/getComment.md @@ -29,13 +29,17 @@ octokit.rest.issues.getComment({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + comment_idyes -comment_id parameter +The unique identifier of the comment. diff --git a/docs/issues/getEvent.md b/docs/issues/getEvent.md index 0092957f6..5c6670064 100644 --- a/docs/issues/getEvent.md +++ b/docs/issues/getEvent.md @@ -29,9 +29,13 @@ octokit.rest.issues.getEvent({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + event_idyes diff --git a/docs/issues/getLabel.md b/docs/issues/getLabel.md index e43242f76..5ec27af74 100644 --- a/docs/issues/getLabel.md +++ b/docs/issues/getLabel.md @@ -29,9 +29,13 @@ octokit.rest.issues.getLabel({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + nameyes diff --git a/docs/issues/getMilestone.md b/docs/issues/getMilestone.md index 182ee101c..e5393ca1b 100644 --- a/docs/issues/getMilestone.md +++ b/docs/issues/getMilestone.md @@ -29,13 +29,17 @@ octokit.rest.issues.getMilestone({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + milestone_numberyes -milestone_number parameter +The number that identifies the milestone. diff --git a/docs/issues/list.md b/docs/issues/list.md index 31b83b80f..93de863a2 100644 --- a/docs/issues/list.md +++ b/docs/issues/list.md @@ -34,12 +34,7 @@ octokit.rest.issues.list(); filterno -Indicates which sorts of issues to return. Can be one of: -\* `assigned`: Issues assigned to you -\* `created`: Issues created by you -\* `mentioned`: Issues mentioning you -\* `subscribed`: Issues you're subscribed to updates for -\* `all` or `repos`: All issues the authenticated user can see, regardless of participation or creation +Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. stateno @@ -59,7 +54,7 @@ What to sort results by. Can be either `created`, `updated`, `comments`. directionno -One of `asc` (ascending) or `desc` (descending). +The direction to sort the results by. sinceno @@ -81,7 +76,7 @@ Only show notifications updated after the given time. This is a timestamp in [IS per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/issues/listAssignees.md b/docs/issues/listAssignees.md index c6eff0a8d..547d02c42 100644 --- a/docs/issues/listAssignees.md +++ b/docs/issues/listAssignees.md @@ -8,7 +8,7 @@ type: API method # List assignees -Lists the [available assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. +Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. ```js octokit.rest.issues.listAssignees({ @@ -30,13 +30,17 @@ octokit.rest.issues.listAssignees({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/issues/listComments.md b/docs/issues/listComments.md index 40ed72f9e..8f8654efc 100644 --- a/docs/issues/listComments.md +++ b/docs/issues/listComments.md @@ -31,13 +31,17 @@ octokit.rest.issues.listComments({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + issue_numberyes -issue_number parameter +The number that identifies the issue. sinceno @@ -47,7 +51,7 @@ Only show notifications updated after the given time. This is a timestamp in [IS per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/issues/listCommentsForRepo.md b/docs/issues/listCommentsForRepo.md index cb725bd11..724b63a01 100644 --- a/docs/issues/listCommentsForRepo.md +++ b/docs/issues/listCommentsForRepo.md @@ -30,13 +30,17 @@ octokit.rest.issues.listCommentsForRepo({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + sortno -One of `created` (when the repository was starred) or `updated` (when it was last pushed to). +The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. directionno @@ -51,7 +55,7 @@ Only show notifications updated after the given time. This is a timestamp in [IS per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/issues/listEvents.md b/docs/issues/listEvents.md index 79ffbb1f9..c952eee5e 100644 --- a/docs/issues/listEvents.md +++ b/docs/issues/listEvents.md @@ -29,18 +29,22 @@ octokit.rest.issues.listEvents({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + issue_numberyes -issue_number parameter +The number that identifies the issue. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/issues/listEventsForRepo.md b/docs/issues/listEventsForRepo.md index 0eb7c9e93..2ea6ccb41 100644 --- a/docs/issues/listEventsForRepo.md +++ b/docs/issues/listEventsForRepo.md @@ -28,13 +28,17 @@ octokit.rest.issues.listEventsForRepo({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/issues/listEventsForTimeline.md b/docs/issues/listEventsForTimeline.md index 9a611a1c6..28f2605e9 100644 --- a/docs/issues/listEventsForTimeline.md +++ b/docs/issues/listEventsForTimeline.md @@ -29,18 +29,22 @@ octokit.rest.issues.listEventsForTimeline({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + issue_numberyes -issue_number parameter +The number that identifies the issue. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/issues/listForAuthenticatedUser.md b/docs/issues/listForAuthenticatedUser.md index 393f1e34b..a403ace07 100644 --- a/docs/issues/listForAuthenticatedUser.md +++ b/docs/issues/listForAuthenticatedUser.md @@ -32,12 +32,7 @@ octokit.rest.issues.listForAuthenticatedUser(); filterno -Indicates which sorts of issues to return. Can be one of: -\* `assigned`: Issues assigned to you -\* `created`: Issues created by you -\* `mentioned`: Issues mentioning you -\* `subscribed`: Issues you're subscribed to updates for -\* `all` or `repos`: All issues the authenticated user can see, regardless of participation or creation +Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. stateno @@ -57,7 +52,7 @@ What to sort results by. Can be either `created`, `updated`, `comments`. directionno -One of `asc` (ascending) or `desc` (descending). +The direction to sort the results by. sinceno @@ -67,7 +62,7 @@ Only show notifications updated after the given time. This is a timestamp in [IS per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/issues/listForOrg.md b/docs/issues/listForOrg.md index 2e1d64140..68f394092 100644 --- a/docs/issues/listForOrg.md +++ b/docs/issues/listForOrg.md @@ -34,15 +34,12 @@ octokit.rest.issues.listForOrg({ orgyes +The organization name. The name is not case sensitive. + filterno -Indicates which sorts of issues to return. Can be one of: -\* `assigned`: Issues assigned to you -\* `created`: Issues created by you -\* `mentioned`: Issues mentioning you -\* `subscribed`: Issues you're subscribed to updates for -\* `all` or `repos`: All issues the authenticated user can see, regardless of participation or creation +Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. stateno @@ -62,7 +59,7 @@ What to sort results by. Can be either `created`, `updated`, `comments`. directionno -One of `asc` (ascending) or `desc` (descending). +The direction to sort the results by. sinceno @@ -72,7 +69,7 @@ Only show notifications updated after the given time. This is a timestamp in [IS per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/issues/listForRepo.md b/docs/issues/listForRepo.md index 01ee70cbe..64798bbee 100644 --- a/docs/issues/listForRepo.md +++ b/docs/issues/listForRepo.md @@ -35,9 +35,13 @@ octokit.rest.issues.listForRepo({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + milestoneno @@ -76,7 +80,7 @@ What to sort results by. Can be either `created`, `updated`, `comments`. directionno -One of `asc` (ascending) or `desc` (descending). +The direction to sort the results by. sinceno @@ -86,7 +90,7 @@ Only show notifications updated after the given time. This is a timestamp in [IS per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/issues/listLabelsForMilestone.md b/docs/issues/listLabelsForMilestone.md index ab10072d7..1540a824a 100644 --- a/docs/issues/listLabelsForMilestone.md +++ b/docs/issues/listLabelsForMilestone.md @@ -29,18 +29,22 @@ octokit.rest.issues.listLabelsForMilestone({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + milestone_numberyes -milestone_number parameter +The number that identifies the milestone. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/issues/listLabelsForRepo.md b/docs/issues/listLabelsForRepo.md index 2ae3abeaa..1a5986997 100644 --- a/docs/issues/listLabelsForRepo.md +++ b/docs/issues/listLabelsForRepo.md @@ -28,13 +28,17 @@ octokit.rest.issues.listLabelsForRepo({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/issues/listLabelsOnIssue.md b/docs/issues/listLabelsOnIssue.md index a83836cb4..975aca259 100644 --- a/docs/issues/listLabelsOnIssue.md +++ b/docs/issues/listLabelsOnIssue.md @@ -29,18 +29,22 @@ octokit.rest.issues.listLabelsOnIssue({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + issue_numberyes -issue_number parameter +The number that identifies the issue. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/issues/listMilestones.md b/docs/issues/listMilestones.md index 422674d3e..43e523593 100644 --- a/docs/issues/listMilestones.md +++ b/docs/issues/listMilestones.md @@ -28,9 +28,13 @@ octokit.rest.issues.listMilestones({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + stateno @@ -49,7 +53,7 @@ The direction of the sort. Either `asc` or `desc`. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/issues/lock.md b/docs/issues/lock.md index 1d4b0826a..36ae3bf8f 100644 --- a/docs/issues/lock.md +++ b/docs/issues/lock.md @@ -33,13 +33,17 @@ octokit.rest.issues.lock({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + issue_numberyes -issue_number parameter +The number that identifies the issue. lock_reasonno diff --git a/docs/issues/removeAllLabels.md b/docs/issues/removeAllLabels.md index 013937313..929c0d855 100644 --- a/docs/issues/removeAllLabels.md +++ b/docs/issues/removeAllLabels.md @@ -29,13 +29,17 @@ octokit.rest.issues.removeAllLabels({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + issue_numberyes -issue_number parameter +The number that identifies the issue. diff --git a/docs/issues/removeAssignees.md b/docs/issues/removeAssignees.md index 21e1f0d94..c8515da71 100644 --- a/docs/issues/removeAssignees.md +++ b/docs/issues/removeAssignees.md @@ -31,13 +31,17 @@ octokit.rest.issues.removeAssignees({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + issue_numberyes -issue_number parameter +The number that identifies the issue. assigneesno diff --git a/docs/issues/removeLabel.md b/docs/issues/removeLabel.md index da569506b..7356a6ee6 100644 --- a/docs/issues/removeLabel.md +++ b/docs/issues/removeLabel.md @@ -32,13 +32,17 @@ octokit.rest.issues.removeLabel({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + issue_numberyes -issue_number parameter +The number that identifies the issue. nameyes diff --git a/docs/issues/setLabels.md b/docs/issues/setLabels.md index ef6ff2759..48164d0ce 100644 --- a/docs/issues/setLabels.md +++ b/docs/issues/setLabels.md @@ -32,13 +32,17 @@ labels[].name owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + issue_numberyes -issue_number parameter +The number that identifies the issue. labelsno diff --git a/docs/issues/unlock.md b/docs/issues/unlock.md index ddc948aa8..75fb3bfc1 100644 --- a/docs/issues/unlock.md +++ b/docs/issues/unlock.md @@ -31,13 +31,17 @@ octokit.rest.issues.unlock({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + issue_numberyes -issue_number parameter +The number that identifies the issue. diff --git a/docs/issues/update.md b/docs/issues/update.md index 5ec0668aa..683cc850e 100644 --- a/docs/issues/update.md +++ b/docs/issues/update.md @@ -31,13 +31,17 @@ octokit.rest.issues.update({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + issue_numberyes -issue_number parameter +The number that identifies the issue. titleno diff --git a/docs/issues/updateComment.md b/docs/issues/updateComment.md index a164f8683..630840dcd 100644 --- a/docs/issues/updateComment.md +++ b/docs/issues/updateComment.md @@ -30,13 +30,17 @@ octokit.rest.issues.updateComment({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + comment_idyes -comment_id parameter +The unique identifier of the comment. bodyyes diff --git a/docs/issues/updateLabel.md b/docs/issues/updateLabel.md index af08cc44f..2726dbe9c 100644 --- a/docs/issues/updateLabel.md +++ b/docs/issues/updateLabel.md @@ -29,9 +29,13 @@ octokit.rest.issues.updateLabel({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + nameyes @@ -48,7 +52,7 @@ The [hexadecimal color code](http://www.color-hex.com/) for the label, without t descriptionno -A short description of the label. +A short description of the label. Must be 100 characters or fewer. diff --git a/docs/issues/updateMilestone.md b/docs/issues/updateMilestone.md index 343f54862..a1f0a61df 100644 --- a/docs/issues/updateMilestone.md +++ b/docs/issues/updateMilestone.md @@ -29,13 +29,17 @@ octokit.rest.issues.updateMilestone({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + milestone_numberyes -milestone_number parameter +The number that identifies the milestone. titleno diff --git a/docs/licenses/getAllCommonlyUsed.md b/docs/licenses/getAllCommonlyUsed.md index 8c7e73a58..7049d9084 100644 --- a/docs/licenses/getAllCommonlyUsed.md +++ b/docs/licenses/getAllCommonlyUsed.md @@ -28,7 +28,7 @@ octokit.rest.licenses.getAllCommonlyUsed(); per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/licenses/getForRepo.md b/docs/licenses/getForRepo.md index 67b407e1d..6566fd633 100644 --- a/docs/licenses/getForRepo.md +++ b/docs/licenses/getForRepo.md @@ -32,9 +32,13 @@ octokit.rest.licenses.getForRepo({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/markdown/render.md b/docs/markdown/render.md index d866b0306..e3a0b1a19 100644 --- a/docs/markdown/render.md +++ b/docs/markdown/render.md @@ -32,12 +32,12 @@ The Markdown text to render in HTML. modeno -The rendering mode. +The rendering mode. Can be either `markdown` or `gfm`. contextno -The repository context to use when creating references in `gfm` mode. +The repository context to use when creating references in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository. diff --git a/docs/meta/get.md b/docs/meta/get.md index 03120c40b..13f79352b 100644 --- a/docs/meta/get.md +++ b/docs/meta/get.md @@ -8,7 +8,7 @@ type: API method # Get GitHub meta information -Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://help.github.com/articles/about-github-s-ip-addresses/)." +Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/)." **Note:** The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses. diff --git a/docs/migrations/cancelImport.md b/docs/migrations/cancelImport.md index ba1a5ccb8..39676caa2 100644 --- a/docs/migrations/cancelImport.md +++ b/docs/migrations/cancelImport.md @@ -30,9 +30,13 @@ octokit.rest.migrations.cancelImport({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/migrations/deleteArchiveForAuthenticatedUser.md b/docs/migrations/deleteArchiveForAuthenticatedUser.md index bf2191410..f7fbcbd88 100644 --- a/docs/migrations/deleteArchiveForAuthenticatedUser.md +++ b/docs/migrations/deleteArchiveForAuthenticatedUser.md @@ -29,7 +29,7 @@ octokit.rest.migrations.deleteArchiveForAuthenticatedUser({ migration_idyes -migration_id parameter +The unique identifier of the migration. diff --git a/docs/migrations/deleteArchiveForOrg.md b/docs/migrations/deleteArchiveForOrg.md index d63aa11d8..85e4c0c7c 100644 --- a/docs/migrations/deleteArchiveForOrg.md +++ b/docs/migrations/deleteArchiveForOrg.md @@ -30,10 +30,12 @@ octokit.rest.migrations.deleteArchiveForOrg({ orgyes +The organization name. The name is not case sensitive. + migration_idyes -migration_id parameter +The unique identifier of the migration. diff --git a/docs/migrations/downloadArchiveForOrg.md b/docs/migrations/downloadArchiveForOrg.md index 59ffed599..d064c5c3a 100644 --- a/docs/migrations/downloadArchiveForOrg.md +++ b/docs/migrations/downloadArchiveForOrg.md @@ -30,10 +30,12 @@ octokit.rest.migrations.downloadArchiveForOrg({ orgyes +The organization name. The name is not case sensitive. + migration_idyes -migration_id parameter +The unique identifier of the migration. diff --git a/docs/migrations/getArchiveForAuthenticatedUser.md b/docs/migrations/getArchiveForAuthenticatedUser.md index 7cd4c94df..ff0e91918 100644 --- a/docs/migrations/getArchiveForAuthenticatedUser.md +++ b/docs/migrations/getArchiveForAuthenticatedUser.md @@ -49,7 +49,7 @@ octokit.rest.migrations.getArchiveForAuthenticatedUser({ migration_idyes -migration_id parameter +The unique identifier of the migration. diff --git a/docs/migrations/getCommitAuthors.md b/docs/migrations/getCommitAuthors.md index dac9acf6e..060790259 100644 --- a/docs/migrations/getCommitAuthors.md +++ b/docs/migrations/getCommitAuthors.md @@ -32,9 +32,13 @@ octokit.rest.migrations.getCommitAuthors({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + sinceno diff --git a/docs/migrations/getImportStatus.md b/docs/migrations/getImportStatus.md index 8d223174c..677207ade 100644 --- a/docs/migrations/getImportStatus.md +++ b/docs/migrations/getImportStatus.md @@ -63,9 +63,13 @@ octokit.rest.migrations.getImportStatus({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/migrations/getLargeFiles.md b/docs/migrations/getLargeFiles.md index 88472fa3a..22d902a31 100644 --- a/docs/migrations/getLargeFiles.md +++ b/docs/migrations/getLargeFiles.md @@ -30,9 +30,13 @@ octokit.rest.migrations.getLargeFiles({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/migrations/getStatusForAuthenticatedUser.md b/docs/migrations/getStatusForAuthenticatedUser.md index 568cddb84..748360b78 100644 --- a/docs/migrations/getStatusForAuthenticatedUser.md +++ b/docs/migrations/getStatusForAuthenticatedUser.md @@ -36,7 +36,7 @@ octokit.rest.migrations.getStatusForAuthenticatedUser({ migration_idyes -migration_id parameter +The unique identifier of the migration. excludeno diff --git a/docs/migrations/getStatusForOrg.md b/docs/migrations/getStatusForOrg.md index 51dcfd078..2dd77c34e 100644 --- a/docs/migrations/getStatusForOrg.md +++ b/docs/migrations/getStatusForOrg.md @@ -37,10 +37,12 @@ octokit.rest.migrations.getStatusForOrg({ orgyes +The organization name. The name is not case sensitive. + migration_idyes -migration_id parameter +The unique identifier of the migration. excludeno diff --git a/docs/migrations/listForAuthenticatedUser.md b/docs/migrations/listForAuthenticatedUser.md index 63c3dfe52..eb6990be9 100644 --- a/docs/migrations/listForAuthenticatedUser.md +++ b/docs/migrations/listForAuthenticatedUser.md @@ -27,7 +27,7 @@ octokit.rest.migrations.listForAuthenticatedUser(); per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/migrations/listForOrg.md b/docs/migrations/listForOrg.md index 6b05a391e..6dcf3f219 100644 --- a/docs/migrations/listForOrg.md +++ b/docs/migrations/listForOrg.md @@ -29,10 +29,12 @@ octokit.rest.migrations.listForOrg({ orgyes +The organization name. The name is not case sensitive. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/migrations/listReposForAuthenticatedUser.md b/docs/migrations/listReposForAuthenticatedUser.md index e3f8a431d..7a3162ad3 100644 --- a/docs/migrations/listReposForAuthenticatedUser.md +++ b/docs/migrations/listReposForAuthenticatedUser.md @@ -29,12 +29,12 @@ octokit.rest.migrations.listReposForAuthenticatedUser({ migration_idyes -migration_id parameter +The unique identifier of the migration. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/migrations/listReposForOrg.md b/docs/migrations/listReposForOrg.md index d24094587..ec798dd3a 100644 --- a/docs/migrations/listReposForOrg.md +++ b/docs/migrations/listReposForOrg.md @@ -30,15 +30,17 @@ octokit.rest.migrations.listReposForOrg({ orgyes +The organization name. The name is not case sensitive. + migration_idyes -migration_id parameter +The unique identifier of the migration. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/migrations/listReposForUser.md b/docs/migrations/listReposForUser.md index 83f330b85..4cc8a90d0 100644 --- a/docs/migrations/listReposForUser.md +++ b/docs/migrations/listReposForUser.md @@ -31,12 +31,12 @@ octokit.rest.migrations.listReposForUser({ migration_idyes -migration_id parameter +The unique identifier of the migration. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/migrations/mapCommitAuthor.md b/docs/migrations/mapCommitAuthor.md index 0c1ed7c63..f58a03576 100644 --- a/docs/migrations/mapCommitAuthor.md +++ b/docs/migrations/mapCommitAuthor.md @@ -31,9 +31,13 @@ octokit.rest.migrations.mapCommitAuthor({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + author_idyes diff --git a/docs/migrations/setLfsPreference.md b/docs/migrations/setLfsPreference.md index 9b4e10fc2..232ba02ad 100644 --- a/docs/migrations/setLfsPreference.md +++ b/docs/migrations/setLfsPreference.md @@ -8,7 +8,7 @@ type: API method # Update Git LFS preference -You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.github.com). You can learn more about our LFS feature and working with large files [on our help site](https://help.github.com/articles/versioning-large-files/). +You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.github.com). You can learn more about our LFS feature and working with large files [on our help site](https://docs.github.com/articles/versioning-large-files/). ```js octokit.rest.migrations.setLfsPreference({ @@ -31,13 +31,17 @@ octokit.rest.migrations.setLfsPreference({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + use_lfsyes -Can be one of `opt_in` (large files will be stored using Git LFS) or `opt_out` (large files will be removed during the import). +Whether to store large files during the import. `opt_in` means large files will be stored using Git LFS. `opt_out` means large files will be removed during the import. diff --git a/docs/migrations/startForAuthenticatedUser.md b/docs/migrations/startForAuthenticatedUser.md index 3f03d6a84..30ee4b5cf 100644 --- a/docs/migrations/startForAuthenticatedUser.md +++ b/docs/migrations/startForAuthenticatedUser.md @@ -31,6 +31,16 @@ octokit.rest.migrations.startForAuthenticatedUser({ Lock the repositories being migrated at the start of the migration + +exclude_metadatano + +Indicates whether metadata should be excluded and only git source should be included for the migration. + + +exclude_git_datano + +Indicates whether the repository git data should be excluded from the migration. + exclude_attachmentsno @@ -46,6 +56,11 @@ Do not include releases in the migration Indicates whether projects owned by the organization or users should be excluded. + +org_metadata_onlyno + +Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags). + excludeno diff --git a/docs/migrations/startForOrg.md b/docs/migrations/startForOrg.md index 19c1603a0..1901fafa0 100644 --- a/docs/migrations/startForOrg.md +++ b/docs/migrations/startForOrg.md @@ -30,6 +30,8 @@ octokit.rest.migrations.startForOrg({ orgyes +The organization name. The name is not case sensitive. + repositoriesyes @@ -40,6 +42,16 @@ A list of arrays indicating which repositories should be migrated. Indicates whether repositories should be locked (to prevent manipulation) while migrating data. + +exclude_metadatano + +Indicates whether metadata should be excluded and only git source should be included for the migration. + + +exclude_git_datano + +Indicates whether the repository git data should be excluded from the migration. + exclude_attachmentsno @@ -55,6 +67,11 @@ Indicates whether releases should be excluded from the migration (to reduce migr Indicates whether projects owned by the organization or users should be excluded. from the migration. + +org_metadata_onlyno + +Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags). + excludeno diff --git a/docs/migrations/startImport.md b/docs/migrations/startImport.md index 681355bac..ace832ee9 100644 --- a/docs/migrations/startImport.md +++ b/docs/migrations/startImport.md @@ -31,9 +31,13 @@ octokit.rest.migrations.startImport({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + vcs_urlyes @@ -42,7 +46,7 @@ The URL of the originating repository. vcsno -The originating VCS type. Can be one of `subversion`, `git`, `mercurial`, or `tfvc`. Please be aware that without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response. +The originating VCS type. Without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response. vcs_usernameno diff --git a/docs/migrations/unlockRepoForAuthenticatedUser.md b/docs/migrations/unlockRepoForAuthenticatedUser.md index e5065b162..b05c6714d 100644 --- a/docs/migrations/unlockRepoForAuthenticatedUser.md +++ b/docs/migrations/unlockRepoForAuthenticatedUser.md @@ -30,7 +30,7 @@ octokit.rest.migrations.unlockRepoForAuthenticatedUser({ migration_idyes -migration_id parameter +The unique identifier of the migration. repo_nameyes diff --git a/docs/migrations/unlockRepoForOrg.md b/docs/migrations/unlockRepoForOrg.md index fed61e2fa..02e555e72 100644 --- a/docs/migrations/unlockRepoForOrg.md +++ b/docs/migrations/unlockRepoForOrg.md @@ -31,10 +31,12 @@ octokit.rest.migrations.unlockRepoForOrg({ orgyes +The organization name. The name is not case sensitive. + migration_idyes -migration_id parameter +The unique identifier of the migration. repo_nameyes diff --git a/docs/migrations/updateImport.md b/docs/migrations/updateImport.md index ed1f375ec..d92650e53 100644 --- a/docs/migrations/updateImport.md +++ b/docs/migrations/updateImport.md @@ -11,6 +11,10 @@ type: API method An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API request. If no parameters are provided, the import will be restarted. +Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will +have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. +You can select the project to import by providing one of the objects in the `project_choices` array in the update request. + ```js octokit.rest.migrations.updateImport({ owner, @@ -31,9 +35,13 @@ octokit.rest.migrations.updateImport({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + vcs_usernameno @@ -47,9 +55,13 @@ The password to provide to the originating repository. vcsno +The type of version control system you are migrating from. + tfvc_projectno +For a tfvc import, the name of the project that is being imported. + diff --git a/docs/orgs/blockUser.md b/docs/orgs/blockUser.md index 302df1702..38dafed23 100644 --- a/docs/orgs/blockUser.md +++ b/docs/orgs/blockUser.md @@ -28,9 +28,13 @@ octokit.rest.orgs.blockUser({ orgyes +The organization name. The name is not case sensitive. + usernameyes +The handle for the GitHub user account. + diff --git a/docs/orgs/cancelInvitation.md b/docs/orgs/cancelInvitation.md index 491a0d243..763443fe1 100644 --- a/docs/orgs/cancelInvitation.md +++ b/docs/orgs/cancelInvitation.md @@ -32,10 +32,12 @@ octokit.rest.orgs.cancelInvitation({ orgyes +The organization name. The name is not case sensitive. + invitation_idyes -invitation_id parameter +The unique identifier of the invitation. diff --git a/docs/orgs/checkBlockedUser.md b/docs/orgs/checkBlockedUser.md index ff0714f63..34afbdb63 100644 --- a/docs/orgs/checkBlockedUser.md +++ b/docs/orgs/checkBlockedUser.md @@ -28,9 +28,13 @@ octokit.rest.orgs.checkBlockedUser({ orgyes +The organization name. The name is not case sensitive. + usernameyes +The handle for the GitHub user account. + diff --git a/docs/orgs/checkMembershipForUser.md b/docs/orgs/checkMembershipForUser.md index 2f6301bba..928e8584f 100644 --- a/docs/orgs/checkMembershipForUser.md +++ b/docs/orgs/checkMembershipForUser.md @@ -30,9 +30,13 @@ octokit.rest.orgs.checkMembershipForUser({ orgyes +The organization name. The name is not case sensitive. + usernameyes +The handle for the GitHub user account. + diff --git a/docs/orgs/checkPublicMembershipForUser.md b/docs/orgs/checkPublicMembershipForUser.md index 95cba59be..588c4481e 100644 --- a/docs/orgs/checkPublicMembershipForUser.md +++ b/docs/orgs/checkPublicMembershipForUser.md @@ -28,9 +28,13 @@ octokit.rest.orgs.checkPublicMembershipForUser({ orgyes +The organization name. The name is not case sensitive. + usernameyes +The handle for the GitHub user account. + diff --git a/docs/orgs/convertMemberToOutsideCollaborator.md b/docs/orgs/convertMemberToOutsideCollaborator.md index bce206817..06e6b88b1 100644 --- a/docs/orgs/convertMemberToOutsideCollaborator.md +++ b/docs/orgs/convertMemberToOutsideCollaborator.md @@ -8,7 +8,7 @@ type: API method # Convert an organization member to outside collaborator -When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://help.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". +When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." ```js octokit.rest.orgs.convertMemberToOutsideCollaborator({ @@ -30,9 +30,18 @@ octokit.rest.orgs.convertMemberToOutsideCollaborator({ orgyes +The organization name. The name is not case sensitive. + usernameyes +The handle for the GitHub user account. + + +asyncno + +When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued. + diff --git a/docs/orgs/createInvitation.md b/docs/orgs/createInvitation.md index 7c96299f8..67d9c742e 100644 --- a/docs/orgs/createInvitation.md +++ b/docs/orgs/createInvitation.md @@ -31,6 +31,8 @@ octokit.rest.orgs.createInvitation({ orgyes +The organization name. The name is not case sensitive. + invitee_idno @@ -44,8 +46,7 @@ octokit.rest.orgs.createInvitation({ roleno -Specify role for new member. Can be one of: -\* `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. +The role for the new member. \* `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. \* `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. \* `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. diff --git a/docs/orgs/createWebhook.md b/docs/orgs/createWebhook.md index c3cbb4bc1..771148eaf 100644 --- a/docs/orgs/createWebhook.md +++ b/docs/orgs/createWebhook.md @@ -32,6 +32,8 @@ config.url orgyes +The organization name. The name is not case sensitive. + nameyes diff --git a/docs/orgs/deleteWebhook.md b/docs/orgs/deleteWebhook.md index 70ff9b792..163aa6a28 100644 --- a/docs/orgs/deleteWebhook.md +++ b/docs/orgs/deleteWebhook.md @@ -28,9 +28,13 @@ octokit.rest.orgs.deleteWebhook({ orgyes +The organization name. The name is not case sensitive. + hook_idyes +The unique identifier of the hook. + diff --git a/docs/orgs/get.md b/docs/orgs/get.md index f70d399dc..1009c4bef 100644 --- a/docs/orgs/get.md +++ b/docs/orgs/get.md @@ -8,7 +8,7 @@ type: API method # Get an organization -To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). +To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below." @@ -31,6 +31,8 @@ octokit.rest.orgs.get({ orgyes +The organization name. The name is not case sensitive. + diff --git a/docs/orgs/getMembershipForAuthenticatedUser.md b/docs/orgs/getMembershipForAuthenticatedUser.md index f034e28b5..43eb8b2be 100644 --- a/docs/orgs/getMembershipForAuthenticatedUser.md +++ b/docs/orgs/getMembershipForAuthenticatedUser.md @@ -27,6 +27,8 @@ octokit.rest.orgs.getMembershipForAuthenticatedUser({ orgyes +The organization name. The name is not case sensitive. + diff --git a/docs/orgs/getMembershipForUser.md b/docs/orgs/getMembershipForUser.md index b2cba1bb7..29b946886 100644 --- a/docs/orgs/getMembershipForUser.md +++ b/docs/orgs/getMembershipForUser.md @@ -30,9 +30,13 @@ octokit.rest.orgs.getMembershipForUser({ orgyes +The organization name. The name is not case sensitive. + usernameyes +The handle for the GitHub user account. + diff --git a/docs/orgs/getWebhook.md b/docs/orgs/getWebhook.md index f52111298..33c3b76b5 100644 --- a/docs/orgs/getWebhook.md +++ b/docs/orgs/getWebhook.md @@ -30,9 +30,13 @@ octokit.rest.orgs.getWebhook({ orgyes +The organization name. The name is not case sensitive. + hook_idyes +The unique identifier of the hook. + diff --git a/docs/orgs/getWebhookConfigForOrg.md b/docs/orgs/getWebhookConfigForOrg.md index 68321a410..0dd48e9a1 100644 --- a/docs/orgs/getWebhookConfigForOrg.md +++ b/docs/orgs/getWebhookConfigForOrg.md @@ -32,9 +32,13 @@ octokit.rest.orgs.getWebhookConfigForOrg({ orgyes +The organization name. The name is not case sensitive. + hook_idyes +The unique identifier of the hook. + diff --git a/docs/orgs/getWebhookDelivery.md b/docs/orgs/getWebhookDelivery.md index 3bcb0c691..0f954820c 100644 --- a/docs/orgs/getWebhookDelivery.md +++ b/docs/orgs/getWebhookDelivery.md @@ -31,9 +31,13 @@ octokit.rest.orgs.getWebhookDelivery({ orgyes +The organization name. The name is not case sensitive. + hook_idyes +The unique identifier of the hook. + delivery_idyes diff --git a/docs/orgs/list.md b/docs/orgs/list.md index 2483df8a3..d10002851 100644 --- a/docs/orgs/list.md +++ b/docs/orgs/list.md @@ -34,7 +34,7 @@ An organization ID. Only return organizations with an ID greater than this ID. per_pageno -Results per page (max 100) +The number of results per page (max 100). diff --git a/docs/orgs/listAppInstallations.md b/docs/orgs/listAppInstallations.md index 63375a788..c3015d8e7 100644 --- a/docs/orgs/listAppInstallations.md +++ b/docs/orgs/listAppInstallations.md @@ -29,10 +29,12 @@ octokit.rest.orgs.listAppInstallations({ orgyes +The organization name. The name is not case sensitive. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/orgs/listBlockedUsers.md b/docs/orgs/listBlockedUsers.md index 255c07786..f35bc4ace 100644 --- a/docs/orgs/listBlockedUsers.md +++ b/docs/orgs/listBlockedUsers.md @@ -29,6 +29,8 @@ octokit.rest.orgs.listBlockedUsers({ orgyes +The organization name. The name is not case sensitive. + diff --git a/docs/orgs/listCustomRoles.md b/docs/orgs/listCustomRoles.md new file mode 100644 index 000000000..db37bf640 --- /dev/null +++ b/docs/orgs/listCustomRoles.md @@ -0,0 +1,39 @@ +--- +name: List custom repository roles in an organization +example: octokit.rest.orgs.listCustomRoles({ organization_id }) +route: GET /organizations/{organization_id}/custom_roles +scope: orgs +type: API method +--- + +# List custom repository roles in an organization + +List the custom repository roles available in this organization. In order to see custom +repository roles in an organization, the authenticated user must be an organization owner. + +For more information on custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". + +```js +octokit.rest.orgs.listCustomRoles({ + organization_id, +}); +``` + +## Parameters + + + + + + + + + + + + +
namerequireddescription
organization_idyes + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#list-custom-repository-roles-in-an-organization). diff --git a/docs/orgs/listFailedInvitations.md b/docs/orgs/listFailedInvitations.md index f130162c3..70f38b834 100644 --- a/docs/orgs/listFailedInvitations.md +++ b/docs/orgs/listFailedInvitations.md @@ -29,10 +29,12 @@ octokit.rest.orgs.listFailedInvitations({ orgyes +The organization name. The name is not case sensitive. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/orgs/listForAuthenticatedUser.md b/docs/orgs/listForAuthenticatedUser.md index 0dcb8f356..e79504825 100644 --- a/docs/orgs/listForAuthenticatedUser.md +++ b/docs/orgs/listForAuthenticatedUser.md @@ -31,7 +31,7 @@ octokit.rest.orgs.listForAuthenticatedUser(); per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/orgs/listForUser.md b/docs/orgs/listForUser.md index f1503fa03..038eb1aa2 100644 --- a/docs/orgs/listForUser.md +++ b/docs/orgs/listForUser.md @@ -8,7 +8,7 @@ type: API method # List organizations for a user -List [public organization memberships](https://help.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user. +List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user. This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead. @@ -31,10 +31,12 @@ octokit.rest.orgs.listForUser({ usernameyes +The handle for the GitHub user account. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/orgs/listInvitationTeams.md b/docs/orgs/listInvitationTeams.md index edfbc8564..e6238734c 100644 --- a/docs/orgs/listInvitationTeams.md +++ b/docs/orgs/listInvitationTeams.md @@ -30,15 +30,17 @@ octokit.rest.orgs.listInvitationTeams({ orgyes +The organization name. The name is not case sensitive. + invitation_idyes -invitation_id parameter +The unique identifier of the invitation. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/orgs/listMembers.md b/docs/orgs/listMembers.md index ffac3263d..5068525c5 100644 --- a/docs/orgs/listMembers.md +++ b/docs/orgs/listMembers.md @@ -29,25 +29,22 @@ octokit.rest.orgs.listMembers({ orgyes +The organization name. The name is not case sensitive. + filterno -Filter members returned in the list. Can be one of: -\* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. -\* `all` - All members the authenticated user can see. +Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. This options is only available for organization owners. roleno -Filter members returned by their role. Can be one of: -\* `all` - All members of the organization, regardless of role. -\* `admin` - Organization owners. -\* `member` - Non-owner organization members. +Filter members returned by their role. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/orgs/listMembershipsForAuthenticatedUser.md b/docs/orgs/listMembershipsForAuthenticatedUser.md index ba90b3806..cbc6a9032 100644 --- a/docs/orgs/listMembershipsForAuthenticatedUser.md +++ b/docs/orgs/listMembershipsForAuthenticatedUser.md @@ -30,7 +30,7 @@ Indicates the state of the memberships to return. Can be either `active` or `pen per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/orgs/listOutsideCollaborators.md b/docs/orgs/listOutsideCollaborators.md index 1edeb1538..a047017cb 100644 --- a/docs/orgs/listOutsideCollaborators.md +++ b/docs/orgs/listOutsideCollaborators.md @@ -29,17 +29,17 @@ octokit.rest.orgs.listOutsideCollaborators({ orgyes +The organization name. The name is not case sensitive. + filterno -Filter the list of outside collaborators. Can be one of: -\* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. -\* `all`: All outside collaborators. +Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/orgs/listPendingInvitations.md b/docs/orgs/listPendingInvitations.md index a81a13067..de7f7eaee 100644 --- a/docs/orgs/listPendingInvitations.md +++ b/docs/orgs/listPendingInvitations.md @@ -29,10 +29,12 @@ octokit.rest.orgs.listPendingInvitations({ orgyes +The organization name. The name is not case sensitive. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/orgs/listPublicMembers.md b/docs/orgs/listPublicMembers.md index 5ab0cbff9..ec24c81f7 100644 --- a/docs/orgs/listPublicMembers.md +++ b/docs/orgs/listPublicMembers.md @@ -29,10 +29,12 @@ octokit.rest.orgs.listPublicMembers({ orgyes +The organization name. The name is not case sensitive. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/orgs/listWebhookDeliveries.md b/docs/orgs/listWebhookDeliveries.md index 1093e179b..9c28459bd 100644 --- a/docs/orgs/listWebhookDeliveries.md +++ b/docs/orgs/listWebhookDeliveries.md @@ -30,13 +30,17 @@ octokit.rest.orgs.listWebhookDeliveries({ orgyes +The organization name. The name is not case sensitive. + hook_idyes +The unique identifier of the hook. + per_pageno -Results per page (max 100) +The number of results per page (max 100). cursorno diff --git a/docs/orgs/listWebhooks.md b/docs/orgs/listWebhooks.md index 9761ded87..9e62dd517 100644 --- a/docs/orgs/listWebhooks.md +++ b/docs/orgs/listWebhooks.md @@ -27,10 +27,12 @@ octokit.rest.orgs.listWebhooks({ orgyes +The organization name. The name is not case sensitive. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/orgs/pingWebhook.md b/docs/orgs/pingWebhook.md index 9a9309116..cef7ca9b6 100644 --- a/docs/orgs/pingWebhook.md +++ b/docs/orgs/pingWebhook.md @@ -30,9 +30,13 @@ octokit.rest.orgs.pingWebhook({ orgyes +The organization name. The name is not case sensitive. + hook_idyes +The unique identifier of the hook. + diff --git a/docs/orgs/redeliverWebhookDelivery.md b/docs/orgs/redeliverWebhookDelivery.md index 101b1954b..2ec8d7fcf 100644 --- a/docs/orgs/redeliverWebhookDelivery.md +++ b/docs/orgs/redeliverWebhookDelivery.md @@ -31,9 +31,13 @@ octokit.rest.orgs.redeliverWebhookDelivery({ orgyes +The organization name. The name is not case sensitive. + hook_idyes +The unique identifier of the hook. + delivery_idyes diff --git a/docs/orgs/removeMember.md b/docs/orgs/removeMember.md index 688e7fac1..4543b9ef2 100644 --- a/docs/orgs/removeMember.md +++ b/docs/orgs/removeMember.md @@ -30,9 +30,13 @@ octokit.rest.orgs.removeMember({ orgyes +The organization name. The name is not case sensitive. + usernameyes +The handle for the GitHub user account. + diff --git a/docs/orgs/removeMembershipForUser.md b/docs/orgs/removeMembershipForUser.md index 0db35f3d7..fb66495e5 100644 --- a/docs/orgs/removeMembershipForUser.md +++ b/docs/orgs/removeMembershipForUser.md @@ -32,9 +32,13 @@ octokit.rest.orgs.removeMembershipForUser({ orgyes +The organization name. The name is not case sensitive. + usernameyes +The handle for the GitHub user account. + diff --git a/docs/orgs/removeOutsideCollaborator.md b/docs/orgs/removeOutsideCollaborator.md index 333c72eb8..4ee65fd4f 100644 --- a/docs/orgs/removeOutsideCollaborator.md +++ b/docs/orgs/removeOutsideCollaborator.md @@ -30,9 +30,13 @@ octokit.rest.orgs.removeOutsideCollaborator({ orgyes +The organization name. The name is not case sensitive. + usernameyes +The handle for the GitHub user account. + diff --git a/docs/orgs/removePublicMembershipForAuthenticatedUser.md b/docs/orgs/removePublicMembershipForAuthenticatedUser.md index 231a2910c..bf00aba0e 100644 --- a/docs/orgs/removePublicMembershipForAuthenticatedUser.md +++ b/docs/orgs/removePublicMembershipForAuthenticatedUser.md @@ -28,9 +28,13 @@ octokit.rest.orgs.removePublicMembershipForAuthenticatedUser({ orgyes +The organization name. The name is not case sensitive. + usernameyes +The handle for the GitHub user account. + diff --git a/docs/orgs/setMembershipForUser.md b/docs/orgs/setMembershipForUser.md index 2933ef7db..52dc0d67b 100644 --- a/docs/orgs/setMembershipForUser.md +++ b/docs/orgs/setMembershipForUser.md @@ -37,9 +37,13 @@ octokit.rest.orgs.setMembershipForUser({ orgyes +The organization name. The name is not case sensitive. + usernameyes +The handle for the GitHub user account. + roleno diff --git a/docs/orgs/setPublicMembershipForAuthenticatedUser.md b/docs/orgs/setPublicMembershipForAuthenticatedUser.md index 1effff39b..35fa342df 100644 --- a/docs/orgs/setPublicMembershipForAuthenticatedUser.md +++ b/docs/orgs/setPublicMembershipForAuthenticatedUser.md @@ -32,9 +32,13 @@ octokit.rest.orgs.setPublicMembershipForAuthenticatedUser({ orgyes +The organization name. The name is not case sensitive. + usernameyes +The handle for the GitHub user account. + diff --git a/docs/orgs/unblockUser.md b/docs/orgs/unblockUser.md index be481b435..a88ba56d0 100644 --- a/docs/orgs/unblockUser.md +++ b/docs/orgs/unblockUser.md @@ -28,9 +28,13 @@ octokit.rest.orgs.unblockUser({ orgyes +The organization name. The name is not case sensitive. + usernameyes +The handle for the GitHub user account. + diff --git a/docs/orgs/update.md b/docs/orgs/update.md index c43436a34..4ecc6cb3b 100644 --- a/docs/orgs/update.md +++ b/docs/orgs/update.md @@ -31,6 +31,8 @@ octokit.rest.orgs.update({ orgyes +The organization name. The name is not case sensitive. + billing_emailno @@ -69,84 +71,63 @@ The description of the company. has_organization_projectsno -Toggles whether an organization can use organization projects. +Whether an organization can use organization projects. has_repository_projectsno -Toggles whether repositories that belong to the organization can use repository projects. +Whether repositories that belong to the organization can use repository projects. default_repository_permissionno -Default permission level members have for organization repositories: -\* `read` - can pull, but not push to or administer this repository. -\* `write` - can pull and push, but not administer this repository. -\* `admin` - can pull, push, and administer this repository. -\* `none` - no permissions granted by default. +Default permission level members have for organization repositories. members_can_create_repositoriesno -Toggles the ability of non-admin organization members to create repositories. Can be one of: -\* `true` - all organization members can create repositories. -\* `false` - only organization owners can create repositories. -Default: `true` -**Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. +Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. members_can_create_internal_repositoriesno -Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of: -\* `true` - all organization members can create internal repositories. -\* `false` - only organization owners can create internal repositories. -Default: `true`. For more information, see "[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. +Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. members_can_create_private_repositoriesno -Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: -\* `true` - all organization members can create private repositories. -\* `false` - only organization owners can create private repositories. -Default: `true`. For more information, see "[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. +Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. members_can_create_public_repositoriesno -Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: -\* `true` - all organization members can create public repositories. -\* `false` - only organization owners can create public repositories. -Default: `true`. For more information, see "[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. +Whether organization members can create public repositories, which are visible to anyone. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. members_allowed_repository_creation_typeno -Specifies which types of repositories non-admin organization members can create. Can be one of: -\* `all` - all organization members can create public and private repositories. -\* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud. -\* `none` - only admin members can create repositories. +Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. members_can_create_pagesno -Toggles whether organization members can create GitHub Pages sites. Can be one of: -\* `true` - all organization members can create GitHub Pages sites. -\* `false` - no organization members can create GitHub Pages sites. Existing published sites will not be impacted. +Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted. members_can_create_public_pagesno -Toggles whether organization members can create public GitHub Pages sites. Can be one of: -\* `true` - all organization members can create public GitHub Pages sites. -\* `false` - no organization members can create public GitHub Pages sites. Existing published sites will not be impacted. +Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted. members_can_create_private_pagesno -Toggles whether organization members can create private GitHub Pages sites. Can be one of: -\* `true` - all organization members can create private GitHub Pages sites. -\* `false` - no organization members can create private GitHub Pages sites. Existing published sites will not be impacted. +Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted. + + +members_can_fork_private_repositoriesno + +Whether organization members can fork private organization repositories. blogno diff --git a/docs/orgs/updateMembershipForAuthenticatedUser.md b/docs/orgs/updateMembershipForAuthenticatedUser.md index 749a0d4a4..e9fb1c55d 100644 --- a/docs/orgs/updateMembershipForAuthenticatedUser.md +++ b/docs/orgs/updateMembershipForAuthenticatedUser.md @@ -28,6 +28,8 @@ octokit.rest.orgs.updateMembershipForAuthenticatedUser({ orgyes +The organization name. The name is not case sensitive. + stateyes diff --git a/docs/orgs/updateWebhook.md b/docs/orgs/updateWebhook.md index 0afc85ee4..e2a307e21 100644 --- a/docs/orgs/updateWebhook.md +++ b/docs/orgs/updateWebhook.md @@ -31,9 +31,13 @@ config.url orgyes +The organization name. The name is not case sensitive. + hook_idyes +The unique identifier of the hook. + configno diff --git a/docs/orgs/updateWebhookConfigForOrg.md b/docs/orgs/updateWebhookConfigForOrg.md index fb8205588..8105f21d7 100644 --- a/docs/orgs/updateWebhookConfigForOrg.md +++ b/docs/orgs/updateWebhookConfigForOrg.md @@ -32,9 +32,13 @@ octokit.rest.orgs.updateWebhookConfigForOrg({ orgyes +The organization name. The name is not case sensitive. + hook_idyes +The unique identifier of the hook. + urlno diff --git a/docs/packages/deletePackageForAuthenticatedUser.md b/docs/packages/deletePackageForAuthenticatedUser.md index 2bf8c9546..3ea69f2a7 100644 --- a/docs/packages/deletePackageForAuthenticatedUser.md +++ b/docs/packages/deletePackageForAuthenticatedUser.md @@ -33,7 +33,7 @@ octokit.rest.packages.deletePackageForAuthenticatedUser({ package_typeyes -The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. +The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. package_nameyes diff --git a/docs/packages/deletePackageForOrg.md b/docs/packages/deletePackageForOrg.md index fad7c6b11..e90a6fad7 100644 --- a/docs/packages/deletePackageForOrg.md +++ b/docs/packages/deletePackageForOrg.md @@ -36,7 +36,7 @@ octokit.rest.packages.deletePackageForOrg({ package_typeyes -The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. +The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. package_nameyes @@ -46,6 +46,8 @@ The name of the package. orgyes +The organization name. The name is not case sensitive. + diff --git a/docs/packages/deletePackageForUser.md b/docs/packages/deletePackageForUser.md index 344bc4822..f8343b58f 100644 --- a/docs/packages/deletePackageForUser.md +++ b/docs/packages/deletePackageForUser.md @@ -36,7 +36,7 @@ octokit.rest.packages.deletePackageForUser({ package_typeyes -The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. +The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. package_nameyes @@ -46,6 +46,8 @@ The name of the package. usernameyes +The handle for the GitHub user account. + diff --git a/docs/packages/deletePackageVersionForAuthenticatedUser.md b/docs/packages/deletePackageVersionForAuthenticatedUser.md index 7cd0a09e7..784abe402 100644 --- a/docs/packages/deletePackageVersionForAuthenticatedUser.md +++ b/docs/packages/deletePackageVersionForAuthenticatedUser.md @@ -34,7 +34,7 @@ octokit.rest.packages.deletePackageVersionForAuthenticatedUser({ package_typeyes -The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. +The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. package_nameyes diff --git a/docs/packages/deletePackageVersionForOrg.md b/docs/packages/deletePackageVersionForOrg.md index 45f16014e..02d6d8bbc 100644 --- a/docs/packages/deletePackageVersionForOrg.md +++ b/docs/packages/deletePackageVersionForOrg.md @@ -37,7 +37,7 @@ octokit.rest.packages.deletePackageVersionForOrg({ package_typeyes -The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. +The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. package_nameyes @@ -47,6 +47,8 @@ The name of the package. orgyes +The organization name. The name is not case sensitive. + package_version_idyes diff --git a/docs/packages/deletePackageVersionForUser.md b/docs/packages/deletePackageVersionForUser.md index 7182e43a2..857e61e90 100644 --- a/docs/packages/deletePackageVersionForUser.md +++ b/docs/packages/deletePackageVersionForUser.md @@ -37,7 +37,7 @@ octokit.rest.packages.deletePackageVersionForUser({ package_typeyes -The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. +The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. package_nameyes @@ -47,6 +47,8 @@ The name of the package. usernameyes +The handle for the GitHub user account. + package_version_idyes diff --git a/docs/packages/getAllPackageVersionsForAPackageOwnedByAnOrg.md b/docs/packages/getAllPackageVersionsForAPackageOwnedByAnOrg.md index 37bdae106..3d3720fc4 100644 --- a/docs/packages/getAllPackageVersionsForAPackageOwnedByAnOrg.md +++ b/docs/packages/getAllPackageVersionsForAPackageOwnedByAnOrg.md @@ -36,7 +36,7 @@ octokit.rest.packages.getAllPackageVersionsForAPackageOwnedByAnOrg({ package_typeyes -The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. +The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. package_nameyes @@ -46,6 +46,8 @@ The name of the package. orgyes +The organization name. The name is not case sensitive. + pageno @@ -54,7 +56,7 @@ Page number of the results to fetch. per_pageno -Results per page (max 100) +The number of results per page (max 100). stateno diff --git a/docs/packages/getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser.md b/docs/packages/getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser.md index b1d43ae8c..e018a72bf 100644 --- a/docs/packages/getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser.md +++ b/docs/packages/getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser.md @@ -37,7 +37,7 @@ octokit.rest.packages.getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUse package_typeyes -The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. +The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. package_nameyes @@ -52,7 +52,7 @@ Page number of the results to fetch. per_pageno -Results per page (max 100) +The number of results per page (max 100). stateno diff --git a/docs/packages/getAllPackageVersionsForPackageOwnedByAuthenticatedUser.md b/docs/packages/getAllPackageVersionsForPackageOwnedByAuthenticatedUser.md index 33ebd3be6..15c43cea6 100644 --- a/docs/packages/getAllPackageVersionsForPackageOwnedByAuthenticatedUser.md +++ b/docs/packages/getAllPackageVersionsForPackageOwnedByAuthenticatedUser.md @@ -33,7 +33,7 @@ octokit.rest.packages.getAllPackageVersionsForPackageOwnedByAuthenticatedUser({ package_typeyes -The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. +The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. package_nameyes @@ -48,7 +48,7 @@ Page number of the results to fetch. per_pageno -Results per page (max 100) +The number of results per page (max 100). stateno diff --git a/docs/packages/getAllPackageVersionsForPackageOwnedByOrg.md b/docs/packages/getAllPackageVersionsForPackageOwnedByOrg.md index 39340f8ff..58faebe84 100644 --- a/docs/packages/getAllPackageVersionsForPackageOwnedByOrg.md +++ b/docs/packages/getAllPackageVersionsForPackageOwnedByOrg.md @@ -34,7 +34,7 @@ octokit.rest.packages.getAllPackageVersionsForPackageOwnedByOrg({ package_typeyes -The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. +The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. package_nameyes @@ -44,6 +44,8 @@ The name of the package. orgyes +The organization name. The name is not case sensitive. + pageno @@ -52,7 +54,7 @@ Page number of the results to fetch. per_pageno -Results per page (max 100) +The number of results per page (max 100). stateno diff --git a/docs/packages/getAllPackageVersionsForPackageOwnedByUser.md b/docs/packages/getAllPackageVersionsForPackageOwnedByUser.md index ec24b4898..cab0cc156 100644 --- a/docs/packages/getAllPackageVersionsForPackageOwnedByUser.md +++ b/docs/packages/getAllPackageVersionsForPackageOwnedByUser.md @@ -34,7 +34,7 @@ octokit.rest.packages.getAllPackageVersionsForPackageOwnedByUser({ package_typeyes -The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. +The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. package_nameyes @@ -44,6 +44,8 @@ The name of the package. usernameyes +The handle for the GitHub user account. + diff --git a/docs/packages/getPackageForAuthenticatedUser.md b/docs/packages/getPackageForAuthenticatedUser.md index aa88a294c..5ace5c6bf 100644 --- a/docs/packages/getPackageForAuthenticatedUser.md +++ b/docs/packages/getPackageForAuthenticatedUser.md @@ -33,7 +33,7 @@ octokit.rest.packages.getPackageForAuthenticatedUser({ package_typeyes -The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. +The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. package_nameyes diff --git a/docs/packages/getPackageForOrganization.md b/docs/packages/getPackageForOrganization.md index a10f3d397..ae0db7ee7 100644 --- a/docs/packages/getPackageForOrganization.md +++ b/docs/packages/getPackageForOrganization.md @@ -34,7 +34,7 @@ octokit.rest.packages.getPackageForOrganization({ package_typeyes -The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. +The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. package_nameyes @@ -44,6 +44,8 @@ The name of the package. orgyes +The organization name. The name is not case sensitive. + diff --git a/docs/packages/getPackageForUser.md b/docs/packages/getPackageForUser.md index c5db88bb5..064df44e2 100644 --- a/docs/packages/getPackageForUser.md +++ b/docs/packages/getPackageForUser.md @@ -34,7 +34,7 @@ octokit.rest.packages.getPackageForUser({ package_typeyes -The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. +The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. package_nameyes @@ -44,6 +44,8 @@ The name of the package. usernameyes +The handle for the GitHub user account. + diff --git a/docs/packages/getPackageVersionForAuthenticatedUser.md b/docs/packages/getPackageVersionForAuthenticatedUser.md index 3ffe66fc7..921ec5e99 100644 --- a/docs/packages/getPackageVersionForAuthenticatedUser.md +++ b/docs/packages/getPackageVersionForAuthenticatedUser.md @@ -34,7 +34,7 @@ octokit.rest.packages.getPackageVersionForAuthenticatedUser({ package_typeyes -The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. +The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. package_nameyes diff --git a/docs/packages/getPackageVersionForOrganization.md b/docs/packages/getPackageVersionForOrganization.md index ba841b158..1dced79c5 100644 --- a/docs/packages/getPackageVersionForOrganization.md +++ b/docs/packages/getPackageVersionForOrganization.md @@ -35,7 +35,7 @@ octokit.rest.packages.getPackageVersionForOrganization({ package_typeyes -The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. +The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. package_nameyes @@ -45,6 +45,8 @@ The name of the package. orgyes +The organization name. The name is not case sensitive. + package_version_idyes diff --git a/docs/packages/getPackageVersionForUser.md b/docs/packages/getPackageVersionForUser.md index e836abc4c..a130b0aa8 100644 --- a/docs/packages/getPackageVersionForUser.md +++ b/docs/packages/getPackageVersionForUser.md @@ -35,7 +35,7 @@ octokit.rest.packages.getPackageVersionForUser({ package_typeyes -The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. +The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. package_nameyes @@ -50,6 +50,8 @@ Unique identifier of the package version. usernameyes +The handle for the GitHub user account. + diff --git a/docs/packages/listPackagesForAuthenticatedUser.md b/docs/packages/listPackagesForAuthenticatedUser.md index 5bba0dcbb..eed253cfa 100644 --- a/docs/packages/listPackagesForAuthenticatedUser.md +++ b/docs/packages/listPackagesForAuthenticatedUser.md @@ -32,12 +32,12 @@ octokit.rest.packages.listPackagesForAuthenticatedUser({ package_typeyes -The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. +The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. visibilityno -The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. +The selected visibility of the packages. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. diff --git a/docs/packages/listPackagesForOrganization.md b/docs/packages/listPackagesForOrganization.md index 375fddc54..fc05d7b9c 100644 --- a/docs/packages/listPackagesForOrganization.md +++ b/docs/packages/listPackagesForOrganization.md @@ -33,15 +33,17 @@ octokit.rest.packages.listPackagesForOrganization({ package_typeyes -The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. +The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. orgyes +The organization name. The name is not case sensitive. + visibilityno -The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. +The selected visibility of the packages. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. diff --git a/docs/packages/listPackagesForUser.md b/docs/packages/listPackagesForUser.md index 99ef38d35..207d7a3b8 100644 --- a/docs/packages/listPackagesForUser.md +++ b/docs/packages/listPackagesForUser.md @@ -33,16 +33,18 @@ octokit.rest.packages.listPackagesForUser({ package_typeyes -The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. +The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. visibilityno -The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. +The selected visibility of the packages. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. usernameyes +The handle for the GitHub user account. + diff --git a/docs/packages/restorePackageForAuthenticatedUser.md b/docs/packages/restorePackageForAuthenticatedUser.md index 1681ec9b9..4bf1a2cfd 100644 --- a/docs/packages/restorePackageForAuthenticatedUser.md +++ b/docs/packages/restorePackageForAuthenticatedUser.md @@ -37,7 +37,7 @@ octokit.rest.packages.restorePackageForAuthenticatedUser({ package_typeyes -The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. +The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. package_nameyes diff --git a/docs/packages/restorePackageForOrg.md b/docs/packages/restorePackageForOrg.md index 961287302..feb0236a3 100644 --- a/docs/packages/restorePackageForOrg.md +++ b/docs/packages/restorePackageForOrg.md @@ -41,7 +41,7 @@ octokit.rest.packages.restorePackageForOrg({ package_typeyes -The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. +The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. package_nameyes @@ -51,6 +51,8 @@ The name of the package. orgyes +The organization name. The name is not case sensitive. + tokenno diff --git a/docs/packages/restorePackageForUser.md b/docs/packages/restorePackageForUser.md index 3b5851ea7..747afef8b 100644 --- a/docs/packages/restorePackageForUser.md +++ b/docs/packages/restorePackageForUser.md @@ -41,7 +41,7 @@ octokit.rest.packages.restorePackageForUser({ package_typeyes -The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. +The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. package_nameyes @@ -51,6 +51,8 @@ The name of the package. usernameyes +The handle for the GitHub user account. + tokenno diff --git a/docs/packages/restorePackageVersionForAuthenticatedUser.md b/docs/packages/restorePackageVersionForAuthenticatedUser.md index 21895b538..30da94b67 100644 --- a/docs/packages/restorePackageVersionForAuthenticatedUser.md +++ b/docs/packages/restorePackageVersionForAuthenticatedUser.md @@ -38,7 +38,7 @@ octokit.rest.packages.restorePackageVersionForAuthenticatedUser({ package_typeyes -The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. +The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. package_nameyes diff --git a/docs/packages/restorePackageVersionForOrg.md b/docs/packages/restorePackageVersionForOrg.md index 28d861125..e6680f13f 100644 --- a/docs/packages/restorePackageVersionForOrg.md +++ b/docs/packages/restorePackageVersionForOrg.md @@ -42,7 +42,7 @@ octokit.rest.packages.restorePackageVersionForOrg({ package_typeyes -The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. +The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. package_nameyes @@ -52,6 +52,8 @@ The name of the package. orgyes +The organization name. The name is not case sensitive. + package_version_idyes diff --git a/docs/packages/restorePackageVersionForUser.md b/docs/packages/restorePackageVersionForUser.md index 824684fa4..a7f478ff5 100644 --- a/docs/packages/restorePackageVersionForUser.md +++ b/docs/packages/restorePackageVersionForUser.md @@ -42,7 +42,7 @@ octokit.rest.packages.restorePackageVersionForUser({ package_typeyes -The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. +The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. package_nameyes @@ -52,6 +52,8 @@ The name of the package. usernameyes +The handle for the GitHub user account. + package_version_idyes diff --git a/docs/projects/addCollaborator.md b/docs/projects/addCollaborator.md index 3d5c64212..94fd87c9d 100644 --- a/docs/projects/addCollaborator.md +++ b/docs/projects/addCollaborator.md @@ -30,9 +30,13 @@ octokit.rest.projects.addCollaborator({ project_idyes +The unique identifier of the project. + usernameyes +The handle for the GitHub user account. + permissionno diff --git a/docs/projects/createCard.md b/docs/projects/createCard.md index c2dabe540..5f488324f 100644 --- a/docs/projects/createCard.md +++ b/docs/projects/createCard.md @@ -30,7 +30,7 @@ octokit.rest.projects.createCard({ column_idyes -column_id parameter +The unique identifier of the column. noteyes diff --git a/docs/projects/createColumn.md b/docs/projects/createColumn.md index 7f3a28e72..753d26f8d 100644 --- a/docs/projects/createColumn.md +++ b/docs/projects/createColumn.md @@ -28,6 +28,8 @@ octokit.rest.projects.createColumn({ project_idyes +The unique identifier of the project. + nameyes diff --git a/docs/projects/createForOrg.md b/docs/projects/createForOrg.md index 5c9e9efba..d6bad39f7 100644 --- a/docs/projects/createForOrg.md +++ b/docs/projects/createForOrg.md @@ -30,6 +30,8 @@ octokit.rest.projects.createForOrg({ orgyes +The organization name. The name is not case sensitive. + nameyes diff --git a/docs/projects/createForRepo.md b/docs/projects/createForRepo.md index 875da939d..a94c857b6 100644 --- a/docs/projects/createForRepo.md +++ b/docs/projects/createForRepo.md @@ -31,9 +31,13 @@ octokit.rest.projects.createForRepo({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + nameyes diff --git a/docs/projects/delete.md b/docs/projects/delete.md index 8b5849b96..ad472ba2b 100644 --- a/docs/projects/delete.md +++ b/docs/projects/delete.md @@ -29,6 +29,8 @@ octokit.rest.projects.delete({ project_idyes +The unique identifier of the project. + diff --git a/docs/projects/deleteCard.md b/docs/projects/deleteCard.md index e5d582bab..f230cbff4 100644 --- a/docs/projects/deleteCard.md +++ b/docs/projects/deleteCard.md @@ -27,7 +27,7 @@ octokit.rest.projects.deleteCard({ card_idyes -card_id parameter +The unique identifier of the card. diff --git a/docs/projects/deleteColumn.md b/docs/projects/deleteColumn.md index fc1e5f054..91b63cac0 100644 --- a/docs/projects/deleteColumn.md +++ b/docs/projects/deleteColumn.md @@ -27,7 +27,7 @@ octokit.rest.projects.deleteColumn({ column_idyes -column_id parameter +The unique identifier of the column. diff --git a/docs/projects/get.md b/docs/projects/get.md index 2541402fd..d1db3fd88 100644 --- a/docs/projects/get.md +++ b/docs/projects/get.md @@ -29,6 +29,8 @@ octokit.rest.projects.get({ project_idyes +The unique identifier of the project. + diff --git a/docs/projects/getCard.md b/docs/projects/getCard.md index e88a79cd6..cfd5daf5d 100644 --- a/docs/projects/getCard.md +++ b/docs/projects/getCard.md @@ -27,7 +27,7 @@ octokit.rest.projects.getCard({ card_idyes -card_id parameter +The unique identifier of the card. diff --git a/docs/projects/getColumn.md b/docs/projects/getColumn.md index cd4958ec9..30d3dacfc 100644 --- a/docs/projects/getColumn.md +++ b/docs/projects/getColumn.md @@ -27,7 +27,7 @@ octokit.rest.projects.getColumn({ column_idyes -column_id parameter +The unique identifier of the column. diff --git a/docs/projects/getPermissionForUser.md b/docs/projects/getPermissionForUser.md index 51e9d20cd..7dfc90773 100644 --- a/docs/projects/getPermissionForUser.md +++ b/docs/projects/getPermissionForUser.md @@ -30,9 +30,13 @@ octokit.rest.projects.getPermissionForUser({ project_idyes +The unique identifier of the project. + usernameyes +The handle for the GitHub user account. + diff --git a/docs/projects/listCards.md b/docs/projects/listCards.md index 1a4d6feed..53b884626 100644 --- a/docs/projects/listCards.md +++ b/docs/projects/listCards.md @@ -27,17 +27,17 @@ octokit.rest.projects.listCards({ column_idyes -column_id parameter +The unique identifier of the column. archived_stateno -Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`. +Filters the project cards that are returned by the card's state. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/projects/listCollaborators.md b/docs/projects/listCollaborators.md index 70c8bda1b..f6bab62e2 100644 --- a/docs/projects/listCollaborators.md +++ b/docs/projects/listCollaborators.md @@ -29,18 +29,17 @@ octokit.rest.projects.listCollaborators({ project_idyes +The unique identifier of the project. + affiliationno -Filters the collaborators by their affiliation. Can be one of: -\* `outside`: Outside collaborators of a project that are not a member of the project's organization. -\* `direct`: Collaborators with permissions to a project, regardless of organization membership status. -\* `all`: All collaborators the authenticated user can see. +Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/projects/listColumns.md b/docs/projects/listColumns.md index 6c6f2ab88..c1229c636 100644 --- a/docs/projects/listColumns.md +++ b/docs/projects/listColumns.md @@ -27,10 +27,12 @@ octokit.rest.projects.listColumns({ project_idyes +The unique identifier of the project. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/projects/listForOrg.md b/docs/projects/listForOrg.md index 666d51760..e5c65513d 100644 --- a/docs/projects/listForOrg.md +++ b/docs/projects/listForOrg.md @@ -29,6 +29,8 @@ octokit.rest.projects.listForOrg({ orgyes +The organization name. The name is not case sensitive. + stateno @@ -37,7 +39,7 @@ Indicates the state of the projects to return. Can be either `open`, `closed`, o per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/projects/listForRepo.md b/docs/projects/listForRepo.md index 17c660f1e..277b28842 100644 --- a/docs/projects/listForRepo.md +++ b/docs/projects/listForRepo.md @@ -30,9 +30,13 @@ octokit.rest.projects.listForRepo({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + stateno @@ -41,7 +45,7 @@ Indicates the state of the projects to return. Can be either `open`, `closed`, o per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/projects/listForUser.md b/docs/projects/listForUser.md index ec2fc0eb5..3253b9257 100644 --- a/docs/projects/listForUser.md +++ b/docs/projects/listForUser.md @@ -27,6 +27,8 @@ octokit.rest.projects.listForUser({ usernameyes +The handle for the GitHub user account. + stateno @@ -35,7 +37,7 @@ Indicates the state of the projects to return. Can be either `open`, `closed`, o per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/projects/moveCard.md b/docs/projects/moveCard.md index 6986d6365..f4fdceb8c 100644 --- a/docs/projects/moveCard.md +++ b/docs/projects/moveCard.md @@ -28,7 +28,7 @@ octokit.rest.projects.moveCard({ card_idyes -card_id parameter +The unique identifier of the card. positionyes diff --git a/docs/projects/moveColumn.md b/docs/projects/moveColumn.md index 631c04d79..598f083cc 100644 --- a/docs/projects/moveColumn.md +++ b/docs/projects/moveColumn.md @@ -28,7 +28,7 @@ octokit.rest.projects.moveColumn({ column_idyes -column_id parameter +The unique identifier of the column. positionyes diff --git a/docs/projects/removeCollaborator.md b/docs/projects/removeCollaborator.md index 6efb6139b..72224648e 100644 --- a/docs/projects/removeCollaborator.md +++ b/docs/projects/removeCollaborator.md @@ -30,9 +30,13 @@ octokit.rest.projects.removeCollaborator({ project_idyes +The unique identifier of the project. + usernameyes +The handle for the GitHub user account. + diff --git a/docs/projects/update.md b/docs/projects/update.md index 1de50c4ce..4d5b85e56 100644 --- a/docs/projects/update.md +++ b/docs/projects/update.md @@ -29,6 +29,8 @@ octokit.rest.projects.update({ project_idyes +The unique identifier of the project. + nameno diff --git a/docs/projects/updateCard.md b/docs/projects/updateCard.md index 3b78ccbcc..853736068 100644 --- a/docs/projects/updateCard.md +++ b/docs/projects/updateCard.md @@ -27,7 +27,7 @@ octokit.rest.projects.updateCard({ card_idyes -card_id parameter +The unique identifier of the card. noteno diff --git a/docs/projects/updateColumn.md b/docs/projects/updateColumn.md index 065097870..240589974 100644 --- a/docs/projects/updateColumn.md +++ b/docs/projects/updateColumn.md @@ -28,7 +28,7 @@ octokit.rest.projects.updateColumn({ column_idyes -column_id parameter +The unique identifier of the column. nameyes diff --git a/docs/pulls/checkIfMerged.md b/docs/pulls/checkIfMerged.md index c0f23641a..24e0d8367 100644 --- a/docs/pulls/checkIfMerged.md +++ b/docs/pulls/checkIfMerged.md @@ -29,12 +29,18 @@ octokit.rest.pulls.checkIfMerged({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + pull_numberyes +The number that identifies the pull request. + diff --git a/docs/pulls/create.md b/docs/pulls/create.md index d690839c4..7aa4e6a8c 100644 --- a/docs/pulls/create.md +++ b/docs/pulls/create.md @@ -8,7 +8,7 @@ type: API method # Create a pull request -Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. @@ -38,9 +38,13 @@ octokit.rest.pulls.create({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + titleno @@ -64,12 +68,12 @@ The contents of the pull request. maintainer_can_modifyno -Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. +Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. draftno -Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. +Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://docs.github.com/en/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. issueno diff --git a/docs/pulls/createReplyForReviewComment.md b/docs/pulls/createReplyForReviewComment.md index 0615b99b7..d48e37fea 100644 --- a/docs/pulls/createReplyForReviewComment.md +++ b/docs/pulls/createReplyForReviewComment.md @@ -35,16 +35,22 @@ octokit.rest.pulls.createReplyForReviewComment({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + pull_numberyes +The number that identifies the pull request. + comment_idyes -comment_id parameter +The unique identifier of the comment. bodyyes diff --git a/docs/pulls/createReview.md b/docs/pulls/createReview.md index c286d1a59..1c2124f37 100644 --- a/docs/pulls/createReview.md +++ b/docs/pulls/createReview.md @@ -39,12 +39,18 @@ comments[].body owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + pull_numberyes +The number that identifies the pull request. + commit_idno diff --git a/docs/pulls/createReviewComment.md b/docs/pulls/createReviewComment.md index b56b4e520..08a1fba1c 100644 --- a/docs/pulls/createReviewComment.md +++ b/docs/pulls/createReviewComment.md @@ -10,7 +10,7 @@ type: API method Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff. -You can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see the [`comfort-fade` preview notice](https://docs.github.com/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices). +The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. **Note:** The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. @@ -38,12 +38,18 @@ octokit.rest.pulls.createReviewComment({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + pull_numberyes +The number that identifies the pull request. + bodyyes @@ -62,31 +68,33 @@ The relative path to the file that necessitates a comment. positionno -**Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. +**This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. sideno -**Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. +In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. lineno -**Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. +The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. start_lineno -**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. +**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. start_sideno -**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. +**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. in_reply_tono +The ID of the review comment to reply to. To find the ID of a review comment with ["List review comments on a pull request"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored. + diff --git a/docs/pulls/deletePendingReview.md b/docs/pulls/deletePendingReview.md index 62d9f1754..8a69ae312 100644 --- a/docs/pulls/deletePendingReview.md +++ b/docs/pulls/deletePendingReview.md @@ -30,16 +30,22 @@ octokit.rest.pulls.deletePendingReview({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + pull_numberyes +The number that identifies the pull request. + review_idyes -review_id parameter +The unique identifier of the review. diff --git a/docs/pulls/deleteReviewComment.md b/docs/pulls/deleteReviewComment.md index efeed4d17..bdf9d191c 100644 --- a/docs/pulls/deleteReviewComment.md +++ b/docs/pulls/deleteReviewComment.md @@ -31,13 +31,17 @@ octokit.rest.pulls.deleteReviewComment({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + comment_idyes -comment_id parameter +The unique identifier of the comment. diff --git a/docs/pulls/dismissReview.md b/docs/pulls/dismissReview.md index e5374620a..55c6c0412 100644 --- a/docs/pulls/dismissReview.md +++ b/docs/pulls/dismissReview.md @@ -33,16 +33,22 @@ octokit.rest.pulls.dismissReview({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + pull_numberyes +The number that identifies the pull request. + review_idyes -review_id parameter +The unique identifier of the review. messageyes diff --git a/docs/pulls/get.md b/docs/pulls/get.md index 89a184965..ca5f57f77 100644 --- a/docs/pulls/get.md +++ b/docs/pulls/get.md @@ -8,7 +8,7 @@ type: API method # Get a pull request -Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Lists details of a pull request by providing its number. @@ -18,9 +18,9 @@ The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: -- If merged as a [merge commit](https://help.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. -- If merged via a [squash](https://help.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. -- If [rebased](https://help.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. +- If merged as a [merge commit](https://docs.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. +- If merged via a [squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. +- If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. @@ -45,12 +45,18 @@ octokit.rest.pulls.get({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + pull_numberyes +The number that identifies the pull request. + diff --git a/docs/pulls/getReview.md b/docs/pulls/getReview.md index b6c3850a1..2c2c32b38 100644 --- a/docs/pulls/getReview.md +++ b/docs/pulls/getReview.md @@ -30,16 +30,22 @@ octokit.rest.pulls.getReview({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + pull_numberyes +The number that identifies the pull request. + review_idyes -review_id parameter +The unique identifier of the review. diff --git a/docs/pulls/getReviewComment.md b/docs/pulls/getReviewComment.md index 67de67cc3..ea59e81b6 100644 --- a/docs/pulls/getReviewComment.md +++ b/docs/pulls/getReviewComment.md @@ -31,13 +31,17 @@ octokit.rest.pulls.getReviewComment({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + comment_idyes -comment_id parameter +The unique identifier of the comment. diff --git a/docs/pulls/list.md b/docs/pulls/list.md index 3354d5a4f..68c90b715 100644 --- a/docs/pulls/list.md +++ b/docs/pulls/list.md @@ -8,7 +8,7 @@ type: API method # List pull requests -Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. ```js octokit.rest.pulls.list({ @@ -30,9 +30,13 @@ octokit.rest.pulls.list({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + stateno @@ -61,7 +65,7 @@ The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when s per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/pulls/listCommentsForReview.md b/docs/pulls/listCommentsForReview.md index 4a1e46f2b..aa4f8efc7 100644 --- a/docs/pulls/listCommentsForReview.md +++ b/docs/pulls/listCommentsForReview.md @@ -32,21 +32,27 @@ octokit.rest.pulls.listCommentsForReview({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + pull_numberyes +The number that identifies the pull request. + review_idyes -review_id parameter +The unique identifier of the review. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/pulls/listCommits.md b/docs/pulls/listCommits.md index 74f1577bf..005885955 100644 --- a/docs/pulls/listCommits.md +++ b/docs/pulls/listCommits.md @@ -31,16 +31,22 @@ octokit.rest.pulls.listCommits({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + pull_numberyes +The number that identifies the pull request. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/pulls/listFiles.md b/docs/pulls/listFiles.md index 5d4756a35..d79356c9c 100644 --- a/docs/pulls/listFiles.md +++ b/docs/pulls/listFiles.md @@ -31,16 +31,22 @@ octokit.rest.pulls.listFiles({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + pull_numberyes +The number that identifies the pull request. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/pulls/listRequestedReviewers.md b/docs/pulls/listRequestedReviewers.md index 7107a76cd..54dfd67ca 100644 --- a/docs/pulls/listRequestedReviewers.md +++ b/docs/pulls/listRequestedReviewers.md @@ -29,16 +29,22 @@ octokit.rest.pulls.listRequestedReviewers({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + pull_numberyes +The number that identifies the pull request. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/pulls/listReviewComments.md b/docs/pulls/listReviewComments.md index e408fc304..afd7cfa55 100644 --- a/docs/pulls/listReviewComments.md +++ b/docs/pulls/listReviewComments.md @@ -31,16 +31,22 @@ octokit.rest.pulls.listReviewComments({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + pull_numberyes +The number that identifies the pull request. + sortno -One of `created` (when the repository was starred) or `updated` (when it was last pushed to). +The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. directionno @@ -55,7 +61,7 @@ Only show notifications updated after the given time. This is a timestamp in [IS per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/pulls/listReviewCommentsForRepo.md b/docs/pulls/listReviewCommentsForRepo.md index 595259bd5..2fc01df74 100644 --- a/docs/pulls/listReviewCommentsForRepo.md +++ b/docs/pulls/listReviewCommentsForRepo.md @@ -30,9 +30,13 @@ octokit.rest.pulls.listReviewCommentsForRepo({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + sortno @@ -49,7 +53,7 @@ Only show notifications updated after the given time. This is a timestamp in [IS per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/pulls/listReviews.md b/docs/pulls/listReviews.md index ecf4952c7..de95a163b 100644 --- a/docs/pulls/listReviews.md +++ b/docs/pulls/listReviews.md @@ -31,16 +31,22 @@ octokit.rest.pulls.listReviews({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + pull_numberyes +The number that identifies the pull request. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/pulls/merge.md b/docs/pulls/merge.md index c4da5935c..ef34eeea7 100644 --- a/docs/pulls/merge.md +++ b/docs/pulls/merge.md @@ -31,12 +31,18 @@ octokit.rest.pulls.merge({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + pull_numberyes +The number that identifies the pull request. + commit_titleno diff --git a/docs/pulls/removeRequestedReviewers.md b/docs/pulls/removeRequestedReviewers.md index 5cd763948..fe252758c 100644 --- a/docs/pulls/removeRequestedReviewers.md +++ b/docs/pulls/removeRequestedReviewers.md @@ -30,12 +30,18 @@ octokit.rest.pulls.removeRequestedReviewers({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + pull_numberyes +The number that identifies the pull request. + reviewersyes diff --git a/docs/pulls/requestReviewers.md b/docs/pulls/requestReviewers.md index 9f4547c1e..8eea87614 100644 --- a/docs/pulls/requestReviewers.md +++ b/docs/pulls/requestReviewers.md @@ -31,12 +31,18 @@ octokit.rest.pulls.requestReviewers({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + pull_numberyes +The number that identifies the pull request. + reviewersno diff --git a/docs/pulls/submitReview.md b/docs/pulls/submitReview.md index 6880864a1..b9d4c4a2d 100644 --- a/docs/pulls/submitReview.md +++ b/docs/pulls/submitReview.md @@ -31,16 +31,22 @@ octokit.rest.pulls.submitReview({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + pull_numberyes +The number that identifies the pull request. + review_idyes -review_id parameter +The unique identifier of the review. bodyno diff --git a/docs/pulls/update.md b/docs/pulls/update.md index cd289a145..2d1c6a700 100644 --- a/docs/pulls/update.md +++ b/docs/pulls/update.md @@ -8,7 +8,7 @@ type: API method # Update a pull request -Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. @@ -33,12 +33,18 @@ octokit.rest.pulls.update({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + pull_numberyes +The number that identifies the pull request. + titleno @@ -62,7 +68,7 @@ The name of the branch you want your changes pulled into. This should be an exis maintainer_can_modifyno -Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. +Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. diff --git a/docs/pulls/updateBranch.md b/docs/pulls/updateBranch.md index df412d8fd..bfdbe1c25 100644 --- a/docs/pulls/updateBranch.md +++ b/docs/pulls/updateBranch.md @@ -31,12 +31,18 @@ octokit.rest.pulls.updateBranch({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + pull_numberyes +The number that identifies the pull request. + expected_head_shano diff --git a/docs/pulls/updateReview.md b/docs/pulls/updateReview.md index 3588d9a6a..a46f542ca 100644 --- a/docs/pulls/updateReview.md +++ b/docs/pulls/updateReview.md @@ -33,16 +33,22 @@ octokit.rest.pulls.updateReview({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + pull_numberyes +The number that identifies the pull request. + review_idyes -review_id parameter +The unique identifier of the review. bodyyes diff --git a/docs/pulls/updateReviewComment.md b/docs/pulls/updateReviewComment.md index d0e5f03c9..6f78695ee 100644 --- a/docs/pulls/updateReviewComment.md +++ b/docs/pulls/updateReviewComment.md @@ -32,13 +32,17 @@ octokit.rest.pulls.updateReviewComment({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + comment_idyes -comment_id parameter +The unique identifier of the comment. bodyyes diff --git a/docs/reactions/createForCommitComment.md b/docs/reactions/createForCommitComment.md index 764ad37ba..5507d1257 100644 --- a/docs/reactions/createForCommitComment.md +++ b/docs/reactions/createForCommitComment.md @@ -32,13 +32,17 @@ octokit.rest.reactions.createForCommitComment({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + comment_idyes -comment_id parameter +The unique identifier of the comment. contentyes diff --git a/docs/reactions/createForIssue.md b/docs/reactions/createForIssue.md index 9a0900da8..0643966c4 100644 --- a/docs/reactions/createForIssue.md +++ b/docs/reactions/createForIssue.md @@ -32,13 +32,17 @@ octokit.rest.reactions.createForIssue({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + issue_numberyes -issue_number parameter +The number that identifies the issue. contentyes diff --git a/docs/reactions/createForIssueComment.md b/docs/reactions/createForIssueComment.md index 6a1e15b8c..a0a889b3a 100644 --- a/docs/reactions/createForIssueComment.md +++ b/docs/reactions/createForIssueComment.md @@ -32,13 +32,17 @@ octokit.rest.reactions.createForIssueComment({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + comment_idyes -comment_id parameter +The unique identifier of the comment. contentyes diff --git a/docs/reactions/createForPullRequestReviewComment.md b/docs/reactions/createForPullRequestReviewComment.md index 3fc2f669c..249c0d68e 100644 --- a/docs/reactions/createForPullRequestReviewComment.md +++ b/docs/reactions/createForPullRequestReviewComment.md @@ -32,13 +32,17 @@ octokit.rest.reactions.createForPullRequestReviewComment({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + comment_idyes -comment_id parameter +The unique identifier of the comment. contentyes diff --git a/docs/reactions/createForRelease.md b/docs/reactions/createForRelease.md index 2b1fab036..e0f61d37e 100644 --- a/docs/reactions/createForRelease.md +++ b/docs/reactions/createForRelease.md @@ -32,13 +32,17 @@ octokit.rest.reactions.createForRelease({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + release_idyes -release_id parameter +The unique identifier of the release. contentyes diff --git a/docs/reactions/createForTeamDiscussionCommentInOrg.md b/docs/reactions/createForTeamDiscussionCommentInOrg.md index b2f3be71d..36ee7a9cf 100644 --- a/docs/reactions/createForTeamDiscussionCommentInOrg.md +++ b/docs/reactions/createForTeamDiscussionCommentInOrg.md @@ -35,17 +35,23 @@ octokit.rest.reactions.createForTeamDiscussionCommentInOrg({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. discussion_numberyes +The number that identifies the discussion. + comment_numberyes +The number that identifies the comment. + contentyes diff --git a/docs/reactions/createForTeamDiscussionInOrg.md b/docs/reactions/createForTeamDiscussionInOrg.md index e5d7d98ea..0e19e5a29 100644 --- a/docs/reactions/createForTeamDiscussionInOrg.md +++ b/docs/reactions/createForTeamDiscussionInOrg.md @@ -34,14 +34,18 @@ octokit.rest.reactions.createForTeamDiscussionInOrg({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. discussion_numberyes +The number that identifies the discussion. + contentyes diff --git a/docs/reactions/deleteForCommitComment.md b/docs/reactions/deleteForCommitComment.md index ed6c32017..0caed7d18 100644 --- a/docs/reactions/deleteForCommitComment.md +++ b/docs/reactions/deleteForCommitComment.md @@ -34,17 +34,23 @@ octokit.rest.reactions.deleteForCommitComment({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + comment_idyes -comment_id parameter +The unique identifier of the comment. reaction_idyes +The unique identifier of the reaction. + diff --git a/docs/reactions/deleteForIssue.md b/docs/reactions/deleteForIssue.md index a990e01b5..ad37b9586 100644 --- a/docs/reactions/deleteForIssue.md +++ b/docs/reactions/deleteForIssue.md @@ -34,17 +34,23 @@ octokit.rest.reactions.deleteForIssue({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + issue_numberyes -issue_number parameter +The number that identifies the issue. reaction_idyes +The unique identifier of the reaction. + diff --git a/docs/reactions/deleteForIssueComment.md b/docs/reactions/deleteForIssueComment.md index 86da5c54d..978b25f78 100644 --- a/docs/reactions/deleteForIssueComment.md +++ b/docs/reactions/deleteForIssueComment.md @@ -34,17 +34,23 @@ octokit.rest.reactions.deleteForIssueComment({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + comment_idyes -comment_id parameter +The unique identifier of the comment. reaction_idyes +The unique identifier of the reaction. + diff --git a/docs/reactions/deleteForPullRequestComment.md b/docs/reactions/deleteForPullRequestComment.md index 3eb8476ca..3915dbcfb 100644 --- a/docs/reactions/deleteForPullRequestComment.md +++ b/docs/reactions/deleteForPullRequestComment.md @@ -34,17 +34,23 @@ octokit.rest.reactions.deleteForPullRequestComment({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + comment_idyes -comment_id parameter +The unique identifier of the comment. reaction_idyes +The unique identifier of the reaction. + diff --git a/docs/reactions/deleteForRelease.md b/docs/reactions/deleteForRelease.md new file mode 100644 index 000000000..0aeb5ceb7 --- /dev/null +++ b/docs/reactions/deleteForRelease.md @@ -0,0 +1,58 @@ +--- +name: Delete a release reaction +example: octokit.rest.reactions.deleteForRelease({ owner, repo, release_id, reaction_id }) +route: DELETE /repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id} +scope: reactions +type: API method +--- + +# Delete a release reaction + +**Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. + +Delete a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). + +```js +octokit.rest.reactions.deleteForRelease({ + owner, + repo, + release_id, + reaction_id, +}); +``` + +## Parameters + + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
release_idyes + +The unique identifier of the release. + +
reaction_idyes + +The unique identifier of the reaction. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/reactions/#delete-a-release-reaction). diff --git a/docs/reactions/deleteForTeamDiscussion.md b/docs/reactions/deleteForTeamDiscussion.md index 43cfba6e3..339ccbf38 100644 --- a/docs/reactions/deleteForTeamDiscussion.md +++ b/docs/reactions/deleteForTeamDiscussion.md @@ -34,17 +34,23 @@ octokit.rest.reactions.deleteForTeamDiscussion({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. discussion_numberyes +The number that identifies the discussion. + reaction_idyes +The unique identifier of the reaction. + diff --git a/docs/reactions/deleteForTeamDiscussionComment.md b/docs/reactions/deleteForTeamDiscussionComment.md index 4a5a38b59..6e91dce7d 100644 --- a/docs/reactions/deleteForTeamDiscussionComment.md +++ b/docs/reactions/deleteForTeamDiscussionComment.md @@ -35,20 +35,28 @@ octokit.rest.reactions.deleteForTeamDiscussionComment({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. discussion_numberyes +The number that identifies the discussion. + comment_numberyes +The number that identifies the comment. + reaction_idyes +The unique identifier of the reaction. + diff --git a/docs/reactions/listForCommitComment.md b/docs/reactions/listForCommitComment.md index d4cda432c..d6a3eb327 100644 --- a/docs/reactions/listForCommitComment.md +++ b/docs/reactions/listForCommitComment.md @@ -31,13 +31,17 @@ octokit.rest.reactions.listForCommitComment({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + comment_idyes -comment_id parameter +The unique identifier of the comment. contentno @@ -47,7 +51,7 @@ Returns a single [reaction type](https://docs.github.com/rest/reference/reaction per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/reactions/listForIssue.md b/docs/reactions/listForIssue.md index 64fa934e3..c1c0684aa 100644 --- a/docs/reactions/listForIssue.md +++ b/docs/reactions/listForIssue.md @@ -31,13 +31,17 @@ octokit.rest.reactions.listForIssue({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + issue_numberyes -issue_number parameter +The number that identifies the issue. contentno @@ -47,7 +51,7 @@ Returns a single [reaction type](https://docs.github.com/rest/reference/reaction per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/reactions/listForIssueComment.md b/docs/reactions/listForIssueComment.md index da6405e91..cb895e3a1 100644 --- a/docs/reactions/listForIssueComment.md +++ b/docs/reactions/listForIssueComment.md @@ -31,13 +31,17 @@ octokit.rest.reactions.listForIssueComment({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + comment_idyes -comment_id parameter +The unique identifier of the comment. contentno @@ -47,7 +51,7 @@ Returns a single [reaction type](https://docs.github.com/rest/reference/reaction per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/reactions/listForPullRequestReviewComment.md b/docs/reactions/listForPullRequestReviewComment.md index d28728d6a..23234b0a1 100644 --- a/docs/reactions/listForPullRequestReviewComment.md +++ b/docs/reactions/listForPullRequestReviewComment.md @@ -31,13 +31,17 @@ octokit.rest.reactions.listForPullRequestReviewComment({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + comment_idyes -comment_id parameter +The unique identifier of the comment. contentno @@ -47,7 +51,7 @@ Returns a single [reaction type](https://docs.github.com/rest/reference/reaction per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/reactions/listForRelease.md b/docs/reactions/listForRelease.md new file mode 100644 index 000000000..1f8486f2f --- /dev/null +++ b/docs/reactions/listForRelease.md @@ -0,0 +1,65 @@ +--- +name: List reactions for a release +example: octokit.rest.reactions.listForRelease({ owner, repo, release_id }) +route: GET /repos/{owner}/{repo}/releases/{release_id}/reactions +scope: reactions +type: API method +--- + +# List reactions for a release + +List the reactions to a [release](https://docs.github.com/rest/reference/repos#releases). + +```js +octokit.rest.reactions.listForRelease({ + owner, + repo, + release_id, +}); +``` + +## Parameters + + + + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
release_idyes + +The unique identifier of the release. + +
contentno + +Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a release. + +
per_pageno + +The number of results per page (max 100). + +
pageno + +Page number of the results to fetch. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/reactions/#list-reactions-for-a-release). diff --git a/docs/reactions/listForTeamDiscussionCommentInOrg.md b/docs/reactions/listForTeamDiscussionCommentInOrg.md index 8350aedde..eed9a7f68 100644 --- a/docs/reactions/listForTeamDiscussionCommentInOrg.md +++ b/docs/reactions/listForTeamDiscussionCommentInOrg.md @@ -34,17 +34,23 @@ octokit.rest.reactions.listForTeamDiscussionCommentInOrg({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. discussion_numberyes +The number that identifies the discussion. + comment_numberyes +The number that identifies the comment. + contentno @@ -53,7 +59,7 @@ Returns a single [reaction type](https://docs.github.com/rest/reference/reaction per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/reactions/listForTeamDiscussionInOrg.md b/docs/reactions/listForTeamDiscussionInOrg.md index cc30d3b13..dcce96702 100644 --- a/docs/reactions/listForTeamDiscussionInOrg.md +++ b/docs/reactions/listForTeamDiscussionInOrg.md @@ -33,14 +33,18 @@ octokit.rest.reactions.listForTeamDiscussionInOrg({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. discussion_numberyes +The number that identifies the discussion. + contentno @@ -49,7 +53,7 @@ Returns a single [reaction type](https://docs.github.com/rest/reference/reaction per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/repos/acceptInvitation.md b/docs/repos/acceptInvitation.md index eef4c9ff4..de4149d3f 100644 --- a/docs/repos/acceptInvitation.md +++ b/docs/repos/acceptInvitation.md @@ -29,7 +29,7 @@ octokit.rest.repos.acceptInvitation({ invitation_idyes -invitation_id parameter +The unique identifier of the invitation. diff --git a/docs/repos/acceptInvitationForAuthenticatedUser.md b/docs/repos/acceptInvitationForAuthenticatedUser.md index befd92354..0b9efede1 100644 --- a/docs/repos/acceptInvitationForAuthenticatedUser.md +++ b/docs/repos/acceptInvitationForAuthenticatedUser.md @@ -27,7 +27,7 @@ octokit.rest.repos.acceptInvitationForAuthenticatedUser({ invitation_idyes -invitation_id parameter +The unique identifier of the invitation. diff --git a/docs/repos/addAppAccessRestrictions.md b/docs/repos/addAppAccessRestrictions.md index d46dc30fb..bf17b97c0 100644 --- a/docs/repos/addAppAccessRestrictions.md +++ b/docs/repos/addAppAccessRestrictions.md @@ -8,7 +8,7 @@ type: API method # Add app access restrictions -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Grants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. @@ -38,9 +38,13 @@ octokit.rest.repos.addAppAccessRestrictions({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/addCollaborator.md b/docs/repos/addCollaborator.md index 4eea944df..dbd47ad38 100644 --- a/docs/repos/addCollaborator.md +++ b/docs/repos/addCollaborator.md @@ -8,14 +8,24 @@ type: API method # Add a repository collaborator -This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. +This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. -For more information the permission levels, see "[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". +Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." + +For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: + +``` +Cannot assign {member} permission of {role name} +``` Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/rest/reference/repos#invitations). +**Updating an existing collaborator's permission level** + +The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed. + **Rate limits** You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository. @@ -41,24 +51,22 @@ octokit.rest.repos.addCollaborator({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + usernameyes +The handle for the GitHub user account. + permissionno -The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: -\* `pull` - can pull, but not push to or administer this repository. -\* `push` - can pull and push, but not administer this repository. -\* `admin` - can pull, push and administer this repository. -\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. -\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access. \* custom repository role name - Can assign a custom repository role if the owning organization has defined any. - - -permissionsno +The permission to grant the collaborator. **Only valid on organization-owned repositories.** In addition to the enumerated values, you can also specify a custom repository role name, if the owning organization has defined any. diff --git a/docs/repos/addStatusCheckContexts.md b/docs/repos/addStatusCheckContexts.md index c7d04ac26..d2f5beb3d 100644 --- a/docs/repos/addStatusCheckContexts.md +++ b/docs/repos/addStatusCheckContexts.md @@ -8,7 +8,7 @@ type: API method # Add status check contexts -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. ```js octokit.rest.repos.addStatusCheckContexts({ @@ -32,9 +32,13 @@ octokit.rest.repos.addStatusCheckContexts({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/addTeamAccessRestrictions.md b/docs/repos/addTeamAccessRestrictions.md index e7fbc75d1..447b3d537 100644 --- a/docs/repos/addTeamAccessRestrictions.md +++ b/docs/repos/addTeamAccessRestrictions.md @@ -8,7 +8,7 @@ type: API method # Add team access restrictions -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Grants the specified teams push access for this branch. You can also give push access to child teams. @@ -38,9 +38,13 @@ octokit.rest.repos.addTeamAccessRestrictions({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/addUserAccessRestrictions.md b/docs/repos/addUserAccessRestrictions.md index 8424b3624..a12351268 100644 --- a/docs/repos/addUserAccessRestrictions.md +++ b/docs/repos/addUserAccessRestrictions.md @@ -8,7 +8,7 @@ type: API method # Add user access restrictions -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Grants the specified people push access for this branch. @@ -38,9 +38,13 @@ octokit.rest.repos.addUserAccessRestrictions({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/checkCollaborator.md b/docs/repos/checkCollaborator.md index 829334d2b..c293be47c 100644 --- a/docs/repos/checkCollaborator.md +++ b/docs/repos/checkCollaborator.md @@ -12,6 +12,10 @@ For organization-owned repositories, the list of collaborators includes outside Team members will include the members of child teams. +You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this +endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this +endpoint. + ```js octokit.rest.repos.checkCollaborator({ owner, @@ -33,12 +37,18 @@ octokit.rest.repos.checkCollaborator({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + usernameyes +The handle for the GitHub user account. + diff --git a/docs/repos/checkVulnerabilityAlerts.md b/docs/repos/checkVulnerabilityAlerts.md index 393c811b5..b6f36df15 100644 --- a/docs/repos/checkVulnerabilityAlerts.md +++ b/docs/repos/checkVulnerabilityAlerts.md @@ -8,7 +8,7 @@ type: API method # Check if vulnerability alerts are enabled for a repository -Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". +Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". ```js octokit.rest.repos.checkVulnerabilityAlerts({ @@ -30,9 +30,13 @@ octokit.rest.repos.checkVulnerabilityAlerts({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/repos/codeownersErrors.md b/docs/repos/codeownersErrors.md new file mode 100644 index 000000000..fda78d43c --- /dev/null +++ b/docs/repos/codeownersErrors.md @@ -0,0 +1,53 @@ +--- +name: List CODEOWNERS errors +example: octokit.rest.repos.codeownersErrors({ owner, repo }) +route: GET /repos/{owner}/{repo}/codeowners/errors +scope: repos +type: API method +--- + +# List CODEOWNERS errors + +List any syntax errors that are detected in the CODEOWNERS +file. + +For more information about the correct CODEOWNERS syntax, +see "[About code owners](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." + +```js +octokit.rest.repos.codeownersErrors({ + owner, + repo, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
refno + +A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository's default branch (e.g. `main`) + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#list-codeowners-errors). diff --git a/docs/repos/compareCommitsWithBasehead.md b/docs/repos/compareCommitsWithBasehead.md index ea0ba48eb..4a5ca36db 100644 --- a/docs/repos/compareCommitsWithBasehead.md +++ b/docs/repos/compareCommitsWithBasehead.md @@ -70,9 +70,13 @@ octokit.rest.repos.compareCommitsWithBasehead({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + pageno @@ -81,7 +85,7 @@ Page number of the results to fetch. per_pageno -Results per page (max 100) +The number of results per page (max 100). baseheadyes diff --git a/docs/repos/createAutolink.md b/docs/repos/createAutolink.md index 69b2d1603..c9ba9baf8 100644 --- a/docs/repos/createAutolink.md +++ b/docs/repos/createAutolink.md @@ -32,9 +32,13 @@ octokit.rest.repos.createAutolink({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + key_prefixyes diff --git a/docs/repos/createCommitComment.md b/docs/repos/createCommitComment.md index 5be0c4280..a0444ec55 100644 --- a/docs/repos/createCommitComment.md +++ b/docs/repos/createCommitComment.md @@ -34,13 +34,17 @@ octokit.rest.repos.createCommitComment({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + commit_shayes -commit_sha parameter +The SHA of the commit. bodyyes diff --git a/docs/repos/createCommitSignatureProtection.md b/docs/repos/createCommitSignatureProtection.md index 2a74f44d1..62c165053 100644 --- a/docs/repos/createCommitSignatureProtection.md +++ b/docs/repos/createCommitSignatureProtection.md @@ -8,7 +8,7 @@ type: API method # Create commit signature protection -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. @@ -33,9 +33,13 @@ octokit.rest.repos.createCommitSignatureProtection({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/createCommitStatus.md b/docs/repos/createCommitStatus.md index ab0f29885..89ad13f69 100644 --- a/docs/repos/createCommitStatus.md +++ b/docs/repos/createCommitStatus.md @@ -34,16 +34,20 @@ octokit.rest.repos.createCommitStatus({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + shayes stateyes -The state of the status. Can be one of `error`, `failure`, `pending`, or `success`. +The state of the status. target_urlno diff --git a/docs/repos/createDeployKey.md b/docs/repos/createDeployKey.md index 9cacf2541..d9d4a9c83 100644 --- a/docs/repos/createDeployKey.md +++ b/docs/repos/createDeployKey.md @@ -31,9 +31,13 @@ octokit.rest.repos.createDeployKey({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + titleno @@ -49,7 +53,7 @@ The contents of the key. If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. -Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://help.github.com/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://help.github.com/articles/permission-levels-for-a-user-account-repository/)." +Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/)." diff --git a/docs/repos/createDeployment.md b/docs/repos/createDeployment.md index 71f779fc2..fc427f0f8 100644 --- a/docs/repos/createDeployment.md +++ b/docs/repos/createDeployment.md @@ -22,7 +22,7 @@ the ref _is_ behind the default branch for the repository, we will attempt to me the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will return a failure response. -By default, [commit statuses](https://docs.github.com/rest/reference/repos#statuses) for every submitted context must be in a `success` +By default, [commit statuses](https://docs.github.com/rest/commits/statuses) for every submitted context must be in a `success` state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do not require any contexts or create any commit statuses, the deployment will always succeed. @@ -79,9 +79,13 @@ octokit.rest.repos.createDeployment({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + refyes @@ -100,7 +104,7 @@ Attempts to automatically merge the default branch into the requested ref, if it required_contextsno -The [status](https://docs.github.com/rest/reference/repos#statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. +The [status](https://docs.github.com/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. payloadno diff --git a/docs/repos/createDeploymentStatus.md b/docs/repos/createDeploymentStatus.md index d42146e47..2b11713fd 100644 --- a/docs/repos/createDeploymentStatus.md +++ b/docs/repos/createDeploymentStatus.md @@ -34,9 +34,13 @@ octokit.rest.repos.createDeploymentStatus({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + deployment_idyes @@ -45,7 +49,7 @@ deployment_id parameter stateyes -The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub. +The state of the status. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub. target_urlno diff --git a/docs/repos/createDispatchEvent.md b/docs/repos/createDispatchEvent.md index 2b369f79e..ff179ad06 100644 --- a/docs/repos/createDispatchEvent.md +++ b/docs/repos/createDispatchEvent.md @@ -14,7 +14,7 @@ The `client_payload` parameter is available for any extra information that your This endpoint requires write access to the repository by providing either: -- Personal access tokens with `repo` scope. For more information, see "[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation. +- Personal access tokens with `repo` scope. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation. - GitHub Apps with both `metadata:read` and `contents:read&write` permissions. This input example shows how you can use the `client_payload` as a test to debug your workflow. @@ -40,13 +40,17 @@ octokit.rest.repos.createDispatchEvent({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + event_typeyes -A custom webhook event name. +A custom webhook event name. Must be 100 characters or fewer. client_payloadno diff --git a/docs/repos/createFork.md b/docs/repos/createFork.md index 46f27d002..d92cba7fa 100644 --- a/docs/repos/createFork.md +++ b/docs/repos/createFork.md @@ -32,9 +32,13 @@ octokit.rest.repos.createFork({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + organizationno diff --git a/docs/repos/createInOrg.md b/docs/repos/createInOrg.md index ca9e9eb21..301b945a3 100644 --- a/docs/repos/createInOrg.md +++ b/docs/repos/createInOrg.md @@ -37,6 +37,8 @@ octokit.rest.repos.createInOrg({ orgyes +The organization name. The name is not case sensitive. + nameyes @@ -60,7 +62,7 @@ Whether the repository is private. visibilityno -Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see "[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)" in the GitHub Help documentation. +Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see "[Creating an internal repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)" in the GitHub Help documentation. has_issuesno @@ -100,7 +102,7 @@ Desired language or platform [.gitignore template](https://github.com/github/git license_templateno -Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". +Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". allow_squash_mergeno @@ -127,6 +129,11 @@ Either `true` to allow auto-merge on pull requests, or `false` to disallow auto- Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. + +use_squash_pr_title_as_defaultno + +Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. + diff --git a/docs/repos/createOrUpdateEnvironment.md b/docs/repos/createOrUpdateEnvironment.md index 7f8b893d3..b3ffa0bfc 100644 --- a/docs/repos/createOrUpdateEnvironment.md +++ b/docs/repos/createOrUpdateEnvironment.md @@ -39,9 +39,13 @@ deployment_branch_policy.custom_branch_policies owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + environment_nameyes @@ -60,7 +64,7 @@ The people or teams that may review jobs that reference the environment. You can reviewers[].typeno -The type of reviewer. Must be one of: `User` or `Team` +The type of reviewer. reviewers[].idno diff --git a/docs/repos/createOrUpdateFileContents.md b/docs/repos/createOrUpdateFileContents.md index 4b04c0354..eaff02473 100644 --- a/docs/repos/createOrUpdateFileContents.md +++ b/docs/repos/createOrUpdateFileContents.md @@ -37,9 +37,13 @@ author.email owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + pathyes diff --git a/docs/repos/createPagesSite.md b/docs/repos/createPagesSite.md index e9a7059b3..b234e1260 100644 --- a/docs/repos/createPagesSite.md +++ b/docs/repos/createPagesSite.md @@ -1,6 +1,6 @@ --- name: Create a GitHub Pages site -example: octokit.rest.repos.createPagesSite({ owner, repo, source, source.branch }) +example: octokit.rest.repos.createPagesSite({ owner, repo, source.branch }) route: POST /repos/{owner}/{repo}/pages scope: repos type: API method @@ -14,7 +14,6 @@ Configures a GitHub Pages site. For more information, see "[About GitHub Pages]( octokit.rest.repos.createPagesSite({ owner, repo, -source, source.branch }) ``` @@ -32,11 +31,15 @@ source.branch owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + -sourceyes +sourceno The source branch and directory used to publish your Pages site. diff --git a/docs/repos/createRelease.md b/docs/repos/createRelease.md index 18bba7bf0..ebc2ac59d 100644 --- a/docs/repos/createRelease.md +++ b/docs/repos/createRelease.md @@ -33,9 +33,13 @@ octokit.rest.repos.createRelease({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + tag_nameyes diff --git a/docs/repos/createTagProtection.md b/docs/repos/createTagProtection.md new file mode 100644 index 000000000..d153e6783 --- /dev/null +++ b/docs/repos/createTagProtection.md @@ -0,0 +1,51 @@ +--- +name: Create a tag protection state for a repository +example: octokit.rest.repos.createTagProtection({ owner, repo, pattern }) +route: POST /repos/{owner}/{repo}/tags/protection +scope: repos +type: API method +--- + +# Create a tag protection state for a repository + +This creates a tag protection state for a repository. +This endpoint is only available to repository administrators. + +```js +octokit.rest.repos.createTagProtection({ + owner, + repo, + pattern, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
patternyes + +An optional glob pattern to match against when enforcing tag protection. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#create-tag-protection-state-for-a-repository). diff --git a/docs/repos/createWebhook.md b/docs/repos/createWebhook.md index 3bd881ae9..4207f0b3f 100644 --- a/docs/repos/createWebhook.md +++ b/docs/repos/createWebhook.md @@ -31,9 +31,13 @@ octokit.rest.repos.createWebhook({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + nameno diff --git a/docs/repos/declineInvitation.md b/docs/repos/declineInvitation.md index ed3dc6e68..46349a41a 100644 --- a/docs/repos/declineInvitation.md +++ b/docs/repos/declineInvitation.md @@ -29,7 +29,7 @@ octokit.rest.repos.declineInvitation({ invitation_idyes -invitation_id parameter +The unique identifier of the invitation. diff --git a/docs/repos/declineInvitationForAuthenticatedUser.md b/docs/repos/declineInvitationForAuthenticatedUser.md index 937bd03b0..06fe509b5 100644 --- a/docs/repos/declineInvitationForAuthenticatedUser.md +++ b/docs/repos/declineInvitationForAuthenticatedUser.md @@ -27,7 +27,7 @@ octokit.rest.repos.declineInvitationForAuthenticatedUser({ invitation_idyes -invitation_id parameter +The unique identifier of the invitation. diff --git a/docs/repos/delete.md b/docs/repos/delete.md index 5f87d037d..8048fc383 100644 --- a/docs/repos/delete.md +++ b/docs/repos/delete.md @@ -33,9 +33,13 @@ octokit.rest.repos.delete({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/repos/deleteAccessRestrictions.md b/docs/repos/deleteAccessRestrictions.md index 3f01c5c78..5e398b7e7 100644 --- a/docs/repos/deleteAccessRestrictions.md +++ b/docs/repos/deleteAccessRestrictions.md @@ -8,7 +8,7 @@ type: API method # Delete access restrictions -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Disables the ability to restrict who can push to this branch. @@ -33,9 +33,13 @@ octokit.rest.repos.deleteAccessRestrictions({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/deleteAdminBranchProtection.md b/docs/repos/deleteAdminBranchProtection.md index b86a058d4..994c294f1 100644 --- a/docs/repos/deleteAdminBranchProtection.md +++ b/docs/repos/deleteAdminBranchProtection.md @@ -8,7 +8,7 @@ type: API method # Delete admin branch protection -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. @@ -33,9 +33,13 @@ octokit.rest.repos.deleteAdminBranchProtection({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/deleteAnEnvironment.md b/docs/repos/deleteAnEnvironment.md index 2b7b5e19d..ee2b94502 100644 --- a/docs/repos/deleteAnEnvironment.md +++ b/docs/repos/deleteAnEnvironment.md @@ -31,9 +31,13 @@ octokit.rest.repos.deleteAnEnvironment({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + environment_nameyes diff --git a/docs/repos/deleteAutolink.md b/docs/repos/deleteAutolink.md index c1d1083d3..fd2b265a2 100644 --- a/docs/repos/deleteAutolink.md +++ b/docs/repos/deleteAutolink.md @@ -33,13 +33,17 @@ octokit.rest.repos.deleteAutolink({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + autolink_idyes -autolink_id parameter +The unique identifier of the autolink. diff --git a/docs/repos/deleteBranchProtection.md b/docs/repos/deleteBranchProtection.md index caf0abc43..8acce1246 100644 --- a/docs/repos/deleteBranchProtection.md +++ b/docs/repos/deleteBranchProtection.md @@ -8,7 +8,7 @@ type: API method # Delete branch protection -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. ```js octokit.rest.repos.deleteBranchProtection({ @@ -31,9 +31,13 @@ octokit.rest.repos.deleteBranchProtection({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/deleteCommitComment.md b/docs/repos/deleteCommitComment.md index af374f741..b0c63f8b8 100644 --- a/docs/repos/deleteCommitComment.md +++ b/docs/repos/deleteCommitComment.md @@ -29,13 +29,17 @@ octokit.rest.repos.deleteCommitComment({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + comment_idyes -comment_id parameter +The unique identifier of the comment. diff --git a/docs/repos/deleteCommitSignatureProtection.md b/docs/repos/deleteCommitSignatureProtection.md index 6e9cfcb70..046d24c45 100644 --- a/docs/repos/deleteCommitSignatureProtection.md +++ b/docs/repos/deleteCommitSignatureProtection.md @@ -8,7 +8,7 @@ type: API method # Delete commit signature protection -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. @@ -33,9 +33,13 @@ octokit.rest.repos.deleteCommitSignatureProtection({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/deleteDeployKey.md b/docs/repos/deleteDeployKey.md index f38c1adda..f5d321688 100644 --- a/docs/repos/deleteDeployKey.md +++ b/docs/repos/deleteDeployKey.md @@ -31,13 +31,17 @@ octokit.rest.repos.deleteDeployKey({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + key_idyes -key_id parameter +The unique identifier of the key. diff --git a/docs/repos/deleteDeployment.md b/docs/repos/deleteDeployment.md index a2e9ce6a6..524f78cad 100644 --- a/docs/repos/deleteDeployment.md +++ b/docs/repos/deleteDeployment.md @@ -8,7 +8,7 @@ type: API method # Delete a deployment -To ensure there can always be an active deployment, you can only delete an _inactive_ deployment. Anyone with `repo` or `repo_deployment` scopes can delete an inactive deployment. +If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment. To set a deployment as inactive, you must: @@ -38,9 +38,13 @@ octokit.rest.repos.deleteDeployment({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + deployment_idyes diff --git a/docs/repos/deleteFile.md b/docs/repos/deleteFile.md index 2151bd9b8..9bae06e48 100644 --- a/docs/repos/deleteFile.md +++ b/docs/repos/deleteFile.md @@ -39,9 +39,13 @@ octokit.rest.repos.deleteFile({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + pathyes diff --git a/docs/repos/deleteInvitation.md b/docs/repos/deleteInvitation.md index 3ea658618..85982ab4c 100644 --- a/docs/repos/deleteInvitation.md +++ b/docs/repos/deleteInvitation.md @@ -29,13 +29,17 @@ octokit.rest.repos.deleteInvitation({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + invitation_idyes -invitation_id parameter +The unique identifier of the invitation. diff --git a/docs/repos/deletePagesSite.md b/docs/repos/deletePagesSite.md index bb4a9a559..25b5c931e 100644 --- a/docs/repos/deletePagesSite.md +++ b/docs/repos/deletePagesSite.md @@ -28,9 +28,13 @@ octokit.rest.repos.deletePagesSite({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/repos/deletePullRequestReviewProtection.md b/docs/repos/deletePullRequestReviewProtection.md index d6a69c323..fe3190754 100644 --- a/docs/repos/deletePullRequestReviewProtection.md +++ b/docs/repos/deletePullRequestReviewProtection.md @@ -8,7 +8,7 @@ type: API method # Delete pull request review protection -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. ```js octokit.rest.repos.deletePullRequestReviewProtection({ @@ -31,9 +31,13 @@ octokit.rest.repos.deletePullRequestReviewProtection({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/deleteRelease.md b/docs/repos/deleteRelease.md index 67c9000e0..d8680e20b 100644 --- a/docs/repos/deleteRelease.md +++ b/docs/repos/deleteRelease.md @@ -31,13 +31,17 @@ octokit.rest.repos.deleteRelease({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + release_idyes -release_id parameter +The unique identifier of the release. diff --git a/docs/repos/deleteReleaseAsset.md b/docs/repos/deleteReleaseAsset.md index 4becfab81..9f4d47315 100644 --- a/docs/repos/deleteReleaseAsset.md +++ b/docs/repos/deleteReleaseAsset.md @@ -29,13 +29,17 @@ octokit.rest.repos.deleteReleaseAsset({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + asset_idyes -asset_id parameter +The unique identifier of the asset. diff --git a/docs/repos/deleteTagProtection.md b/docs/repos/deleteTagProtection.md new file mode 100644 index 000000000..58d0ce5bb --- /dev/null +++ b/docs/repos/deleteTagProtection.md @@ -0,0 +1,51 @@ +--- +name: Delete a tag protection state for a repository +example: octokit.rest.repos.deleteTagProtection({ owner, repo, tag_protection_id }) +route: DELETE /repos/{owner}/{repo}/tags/protection/{tag_protection_id} +scope: repos +type: API method +--- + +# Delete a tag protection state for a repository + +This deletes a tag protection state for a repository. +This endpoint is only available to repository administrators. + +```js +octokit.rest.repos.deleteTagProtection({ + owner, + repo, + tag_protection_id, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
tag_protection_idyes + +The unique identifier of the tag protection. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#delete-tag-protection-state-for-a-repository). diff --git a/docs/repos/deleteWebhook.md b/docs/repos/deleteWebhook.md index 0309b3797..fd45ff5a5 100644 --- a/docs/repos/deleteWebhook.md +++ b/docs/repos/deleteWebhook.md @@ -29,12 +29,18 @@ octokit.rest.repos.deleteWebhook({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + hook_idyes +The unique identifier of the hook. + diff --git a/docs/repos/disableAutomatedSecurityFixes.md b/docs/repos/disableAutomatedSecurityFixes.md index ae0a24bf1..04598e9ef 100644 --- a/docs/repos/disableAutomatedSecurityFixes.md +++ b/docs/repos/disableAutomatedSecurityFixes.md @@ -8,7 +8,7 @@ type: API method # Disable automated security fixes -Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://help.github.com/en/articles/configuring-automated-security-fixes)". +Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)". ```js octokit.rest.repos.disableAutomatedSecurityFixes({ @@ -30,9 +30,13 @@ octokit.rest.repos.disableAutomatedSecurityFixes({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/repos/disableLfsForRepo.md b/docs/repos/disableLfsForRepo.md index 448a29fd5..ff8428a6d 100644 --- a/docs/repos/disableLfsForRepo.md +++ b/docs/repos/disableLfsForRepo.md @@ -8,8 +8,6 @@ type: API method # Disable Git LFS for a repository -**Note:** The Git LFS API endpoints are currently in beta and are subject to change. - ```js octokit.rest.repos.disableLfsForRepo({ owner, @@ -30,9 +28,13 @@ octokit.rest.repos.disableLfsForRepo({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/repos/disableVulnerabilityAlerts.md b/docs/repos/disableVulnerabilityAlerts.md index 114f51a23..198c64004 100644 --- a/docs/repos/disableVulnerabilityAlerts.md +++ b/docs/repos/disableVulnerabilityAlerts.md @@ -8,7 +8,7 @@ type: API method # Disable vulnerability alerts -Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". +Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". ```js octokit.rest.repos.disableVulnerabilityAlerts({ @@ -30,9 +30,13 @@ octokit.rest.repos.disableVulnerabilityAlerts({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/repos/downloadArchive.md b/docs/repos/downloadArchive.md index eba15aeca..3f1b35993 100644 --- a/docs/repos/downloadArchive.md +++ b/docs/repos/downloadArchive.md @@ -36,9 +36,13 @@ octokit.rest.repos.downloadArchive({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + refyes diff --git a/docs/repos/downloadTarballArchive.md b/docs/repos/downloadTarballArchive.md index 0ae3cdbfe..17c3de78e 100644 --- a/docs/repos/downloadTarballArchive.md +++ b/docs/repos/downloadTarballArchive.md @@ -34,9 +34,13 @@ octokit.rest.repos.downloadTarballArchive({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + refyes diff --git a/docs/repos/downloadZipballArchive.md b/docs/repos/downloadZipballArchive.md index d0b4cfabf..d5fb735de 100644 --- a/docs/repos/downloadZipballArchive.md +++ b/docs/repos/downloadZipballArchive.md @@ -34,9 +34,13 @@ octokit.rest.repos.downloadZipballArchive({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + refyes diff --git a/docs/repos/enableAutomatedSecurityFixes.md b/docs/repos/enableAutomatedSecurityFixes.md index 379fd4c7e..ee85a17d6 100644 --- a/docs/repos/enableAutomatedSecurityFixes.md +++ b/docs/repos/enableAutomatedSecurityFixes.md @@ -8,7 +8,7 @@ type: API method # Enable automated security fixes -Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://help.github.com/en/articles/configuring-automated-security-fixes)". +Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)". ```js octokit.rest.repos.enableAutomatedSecurityFixes({ @@ -30,9 +30,13 @@ octokit.rest.repos.enableAutomatedSecurityFixes({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/repos/enableLfsForRepo.md b/docs/repos/enableLfsForRepo.md index e6146e3a3..3d8af0b52 100644 --- a/docs/repos/enableLfsForRepo.md +++ b/docs/repos/enableLfsForRepo.md @@ -8,8 +8,6 @@ type: API method # Enable Git LFS for a repository -**Note:** The Git LFS API endpoints are currently in beta and are subject to change. - ```js octokit.rest.repos.enableLfsForRepo({ owner, @@ -30,9 +28,13 @@ octokit.rest.repos.enableLfsForRepo({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/repos/enableVulnerabilityAlerts.md b/docs/repos/enableVulnerabilityAlerts.md index 84eda209a..e26019fdc 100644 --- a/docs/repos/enableVulnerabilityAlerts.md +++ b/docs/repos/enableVulnerabilityAlerts.md @@ -8,7 +8,7 @@ type: API method # Enable vulnerability alerts -Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". +Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". ```js octokit.rest.repos.enableVulnerabilityAlerts({ @@ -30,9 +30,13 @@ octokit.rest.repos.enableVulnerabilityAlerts({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/repos/generateReleaseNotes.md b/docs/repos/generateReleaseNotes.md index a164fccdc..842102c84 100644 --- a/docs/repos/generateReleaseNotes.md +++ b/docs/repos/generateReleaseNotes.md @@ -31,9 +31,13 @@ octokit.rest.repos.generateReleaseNotes({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + tag_nameyes diff --git a/docs/repos/get.md b/docs/repos/get.md index 27e659090..4a9a14ead 100644 --- a/docs/repos/get.md +++ b/docs/repos/get.md @@ -30,9 +30,13 @@ octokit.rest.repos.get({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/repos/getAccessRestrictions.md b/docs/repos/getAccessRestrictions.md index 25f3f2daf..0302cd7ef 100644 --- a/docs/repos/getAccessRestrictions.md +++ b/docs/repos/getAccessRestrictions.md @@ -8,7 +8,7 @@ type: API method # Get access restrictions -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Lists who has access to this protected branch. @@ -35,9 +35,13 @@ octokit.rest.repos.getAccessRestrictions({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/getAdminBranchProtection.md b/docs/repos/getAdminBranchProtection.md index 69a88d86a..53cad3b09 100644 --- a/docs/repos/getAdminBranchProtection.md +++ b/docs/repos/getAdminBranchProtection.md @@ -8,7 +8,7 @@ type: API method # Get admin branch protection -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. ```js octokit.rest.repos.getAdminBranchProtection({ @@ -31,9 +31,13 @@ octokit.rest.repos.getAdminBranchProtection({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/getAllEnvironments.md b/docs/repos/getAllEnvironments.md index 77698fbdd..849c56da5 100644 --- a/docs/repos/getAllEnvironments.md +++ b/docs/repos/getAllEnvironments.md @@ -32,9 +32,23 @@ octokit.rest.repos.getAllEnvironments({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + + +per_pageno + +The number of results per page (max 100). + + +pageno + +Page number of the results to fetch. + diff --git a/docs/repos/getAllStatusCheckContexts.md b/docs/repos/getAllStatusCheckContexts.md index 2eee88d65..711e52b60 100644 --- a/docs/repos/getAllStatusCheckContexts.md +++ b/docs/repos/getAllStatusCheckContexts.md @@ -8,7 +8,7 @@ type: API method # Get all status check contexts -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. ```js octokit.rest.repos.getAllStatusCheckContexts({ @@ -31,9 +31,13 @@ octokit.rest.repos.getAllStatusCheckContexts({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/getAllTopics.md b/docs/repos/getAllTopics.md index 54b4a52d5..f7fdf036d 100644 --- a/docs/repos/getAllTopics.md +++ b/docs/repos/getAllTopics.md @@ -28,9 +28,13 @@ octokit.rest.repos.getAllTopics({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + pageno @@ -39,7 +43,7 @@ Page number of the results to fetch. per_pageno -Results per page (max 100) +The number of results per page (max 100). diff --git a/docs/repos/getAppsWithAccessToProtectedBranch.md b/docs/repos/getAppsWithAccessToProtectedBranch.md index a6b737c16..dd92f8e59 100644 --- a/docs/repos/getAppsWithAccessToProtectedBranch.md +++ b/docs/repos/getAppsWithAccessToProtectedBranch.md @@ -8,7 +8,7 @@ type: API method # Get apps with access to the protected branch -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. @@ -33,9 +33,13 @@ octokit.rest.repos.getAppsWithAccessToProtectedBranch({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/getAutolink.md b/docs/repos/getAutolink.md index b65eee3b7..e68acbb96 100644 --- a/docs/repos/getAutolink.md +++ b/docs/repos/getAutolink.md @@ -33,13 +33,17 @@ octokit.rest.repos.getAutolink({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + autolink_idyes -autolink_id parameter +The unique identifier of the autolink. diff --git a/docs/repos/getBranch.md b/docs/repos/getBranch.md index 4c4af3bb3..ef0110a02 100644 --- a/docs/repos/getBranch.md +++ b/docs/repos/getBranch.md @@ -29,9 +29,13 @@ octokit.rest.repos.getBranch({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/getBranchProtection.md b/docs/repos/getBranchProtection.md index 6d9260356..7b86b42b3 100644 --- a/docs/repos/getBranchProtection.md +++ b/docs/repos/getBranchProtection.md @@ -8,7 +8,7 @@ type: API method # Get branch protection -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. ```js octokit.rest.repos.getBranchProtection({ @@ -31,9 +31,13 @@ octokit.rest.repos.getBranchProtection({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/getClones.md b/docs/repos/getClones.md index dd272aae7..a0301e859 100644 --- a/docs/repos/getClones.md +++ b/docs/repos/getClones.md @@ -30,13 +30,17 @@ octokit.rest.repos.getClones({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + perno -Must be one of: `day`, `week`. +The time frame to display results for. diff --git a/docs/repos/getCodeFrequencyStats.md b/docs/repos/getCodeFrequencyStats.md index 5aac353e6..61b9b537d 100644 --- a/docs/repos/getCodeFrequencyStats.md +++ b/docs/repos/getCodeFrequencyStats.md @@ -30,9 +30,13 @@ octokit.rest.repos.getCodeFrequencyStats({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/repos/getCollaboratorPermissionLevel.md b/docs/repos/getCollaboratorPermissionLevel.md index bc440290e..81e2a9280 100644 --- a/docs/repos/getCollaboratorPermissionLevel.md +++ b/docs/repos/getCollaboratorPermissionLevel.md @@ -31,12 +31,18 @@ octokit.rest.repos.getCollaboratorPermissionLevel({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + usernameyes +The handle for the GitHub user account. + diff --git a/docs/repos/getCombinedStatusForRef.md b/docs/repos/getCombinedStatusForRef.md index b3c5c2e5c..4920609fb 100644 --- a/docs/repos/getCombinedStatusForRef.md +++ b/docs/repos/getCombinedStatusForRef.md @@ -10,8 +10,6 @@ type: API method Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. -The most recent status for each context is returned, up to 100. This field [paginates](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination) if there are over 100 contexts. - Additionally, a combined `state` is returned. The `state` is one of: - **failure** if any of the contexts report as `error` or `failure` @@ -39,9 +37,13 @@ octokit.rest.repos.getCombinedStatusForRef({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + refyes @@ -50,7 +52,7 @@ ref parameter per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/repos/getCommit.md b/docs/repos/getCommit.md index 25b7d9a3f..af8e4e141 100644 --- a/docs/repos/getCommit.md +++ b/docs/repos/getCommit.md @@ -66,9 +66,13 @@ octokit.rest.repos.getCommit({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + pageno @@ -77,7 +81,7 @@ Page number of the results to fetch. per_pageno -Results per page (max 100) +The number of results per page (max 100). refyes diff --git a/docs/repos/getCommitActivityStats.md b/docs/repos/getCommitActivityStats.md index 82c55721e..4ce85ebe4 100644 --- a/docs/repos/getCommitActivityStats.md +++ b/docs/repos/getCommitActivityStats.md @@ -30,9 +30,13 @@ octokit.rest.repos.getCommitActivityStats({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/repos/getCommitComment.md b/docs/repos/getCommitComment.md index fd37280bb..53c0c8997 100644 --- a/docs/repos/getCommitComment.md +++ b/docs/repos/getCommitComment.md @@ -29,13 +29,17 @@ octokit.rest.repos.getCommitComment({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + comment_idyes -comment_id parameter +The unique identifier of the comment. diff --git a/docs/repos/getCommitSignatureProtection.md b/docs/repos/getCommitSignatureProtection.md index 7b767eb42..65352b6e4 100644 --- a/docs/repos/getCommitSignatureProtection.md +++ b/docs/repos/getCommitSignatureProtection.md @@ -8,9 +8,9 @@ type: API method # Get commit signature protection -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. -When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://help.github.com/articles/signing-commits-with-gpg) in GitHub Help. +When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help. **Note**: You must enable branch protection to require signed commits. @@ -35,9 +35,13 @@ octokit.rest.repos.getCommitSignatureProtection({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/getCommunityProfileMetrics.md b/docs/repos/getCommunityProfileMetrics.md index f304b84b4..4c25c50f2 100644 --- a/docs/repos/getCommunityProfileMetrics.md +++ b/docs/repos/getCommunityProfileMetrics.md @@ -41,9 +41,13 @@ octokit.rest.repos.getCommunityProfileMetrics({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/repos/getContent.md b/docs/repos/getContent.md index 6dcb4b20f..530e78570 100644 --- a/docs/repos/getContent.md +++ b/docs/repos/getContent.md @@ -21,7 +21,14 @@ object format. - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/reference/git#trees). - This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees API](https://docs.github.com/rest/reference/git#get-a-tree). -- This API supports files up to 1 megabyte in size. + +#### Size limits + +If the requested file's size is: + +- 1 MB or smaller: All features of this endpoint are supported. +- Between 1-100 MB: Only the `raw` or `object` [custom media types](https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents) are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. +- Greater than 100 MB: This endpoint is not supported. #### If the content is a directory @@ -66,9 +73,13 @@ octokit.rest.repos.getContent({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + pathyes diff --git a/docs/repos/getContributorsStats.md b/docs/repos/getContributorsStats.md index dd28fbbd7..aca6ff9cb 100644 --- a/docs/repos/getContributorsStats.md +++ b/docs/repos/getContributorsStats.md @@ -35,9 +35,13 @@ octokit.rest.repos.getContributorsStats({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/repos/getDeployKey.md b/docs/repos/getDeployKey.md index 14d9c82de..0ad3907fb 100644 --- a/docs/repos/getDeployKey.md +++ b/docs/repos/getDeployKey.md @@ -29,13 +29,17 @@ octokit.rest.repos.getDeployKey({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + key_idyes -key_id parameter +The unique identifier of the key. diff --git a/docs/repos/getDeployment.md b/docs/repos/getDeployment.md index 9d96cfd52..d74829c2e 100644 --- a/docs/repos/getDeployment.md +++ b/docs/repos/getDeployment.md @@ -29,9 +29,13 @@ octokit.rest.repos.getDeployment({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + deployment_idyes diff --git a/docs/repos/getDeploymentStatus.md b/docs/repos/getDeploymentStatus.md index e3065f841..4fdcaeda1 100644 --- a/docs/repos/getDeploymentStatus.md +++ b/docs/repos/getDeploymentStatus.md @@ -32,9 +32,13 @@ octokit.rest.repos.getDeploymentStatus({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + deployment_idyes diff --git a/docs/repos/getEnvironment.md b/docs/repos/getEnvironment.md index 2c2d14713..6b07e34be 100644 --- a/docs/repos/getEnvironment.md +++ b/docs/repos/getEnvironment.md @@ -31,9 +31,13 @@ octokit.rest.repos.getEnvironment({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + environment_nameyes diff --git a/docs/repos/getLatestPagesBuild.md b/docs/repos/getLatestPagesBuild.md index e4b160cc9..0bd4f251f 100644 --- a/docs/repos/getLatestPagesBuild.md +++ b/docs/repos/getLatestPagesBuild.md @@ -28,9 +28,13 @@ octokit.rest.repos.getLatestPagesBuild({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/repos/getLatestRelease.md b/docs/repos/getLatestRelease.md index 0102c3ea2..78d06180b 100644 --- a/docs/repos/getLatestRelease.md +++ b/docs/repos/getLatestRelease.md @@ -32,9 +32,13 @@ octokit.rest.repos.getLatestRelease({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/repos/getPages.md b/docs/repos/getPages.md index ee8cd16c1..317f2ad13 100644 --- a/docs/repos/getPages.md +++ b/docs/repos/getPages.md @@ -28,9 +28,13 @@ octokit.rest.repos.getPages({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/repos/getPagesBuild.md b/docs/repos/getPagesBuild.md index 332a39d1e..4dc425053 100644 --- a/docs/repos/getPagesBuild.md +++ b/docs/repos/getPagesBuild.md @@ -29,9 +29,13 @@ octokit.rest.repos.getPagesBuild({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + build_idyes diff --git a/docs/repos/getPagesHealthCheck.md b/docs/repos/getPagesHealthCheck.md index 52a9fab47..66974e92f 100644 --- a/docs/repos/getPagesHealthCheck.md +++ b/docs/repos/getPagesHealthCheck.md @@ -34,9 +34,13 @@ octokit.rest.repos.getPagesHealthCheck({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/repos/getParticipationStats.md b/docs/repos/getParticipationStats.md index 2da32876a..26bfaf482 100644 --- a/docs/repos/getParticipationStats.md +++ b/docs/repos/getParticipationStats.md @@ -32,9 +32,13 @@ octokit.rest.repos.getParticipationStats({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/repos/getPullRequestReviewProtection.md b/docs/repos/getPullRequestReviewProtection.md index 058ebf5c7..dc7d26e8b 100644 --- a/docs/repos/getPullRequestReviewProtection.md +++ b/docs/repos/getPullRequestReviewProtection.md @@ -8,7 +8,7 @@ type: API method # Get pull request review protection -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. ```js octokit.rest.repos.getPullRequestReviewProtection({ @@ -31,9 +31,13 @@ octokit.rest.repos.getPullRequestReviewProtection({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/getPunchCardStats.md b/docs/repos/getPunchCardStats.md index 392b74882..37fa141f4 100644 --- a/docs/repos/getPunchCardStats.md +++ b/docs/repos/getPunchCardStats.md @@ -36,9 +36,13 @@ octokit.rest.repos.getPunchCardStats({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/repos/getReadme.md b/docs/repos/getReadme.md index a21e6472b..242018dd5 100644 --- a/docs/repos/getReadme.md +++ b/docs/repos/getReadme.md @@ -32,9 +32,13 @@ octokit.rest.repos.getReadme({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + refno diff --git a/docs/repos/getReadmeInDirectory.md b/docs/repos/getReadmeInDirectory.md index 25e0d104d..a21230040 100644 --- a/docs/repos/getReadmeInDirectory.md +++ b/docs/repos/getReadmeInDirectory.md @@ -33,9 +33,13 @@ octokit.rest.repos.getReadmeInDirectory({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diryes diff --git a/docs/repos/getRelease.md b/docs/repos/getRelease.md index 115919a68..3e2c809ba 100644 --- a/docs/repos/getRelease.md +++ b/docs/repos/getRelease.md @@ -31,13 +31,17 @@ octokit.rest.repos.getRelease({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + release_idyes -release_id parameter +The unique identifier of the release. diff --git a/docs/repos/getReleaseAsset.md b/docs/repos/getReleaseAsset.md index 0726e6fe8..094079f7d 100644 --- a/docs/repos/getReleaseAsset.md +++ b/docs/repos/getReleaseAsset.md @@ -31,13 +31,17 @@ octokit.rest.repos.getReleaseAsset({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + asset_idyes -asset_id parameter +The unique identifier of the asset. diff --git a/docs/repos/getReleaseByTag.md b/docs/repos/getReleaseByTag.md index 2ddb1c8c3..0ab0c9912 100644 --- a/docs/repos/getReleaseByTag.md +++ b/docs/repos/getReleaseByTag.md @@ -31,9 +31,13 @@ octokit.rest.repos.getReleaseByTag({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + tagyes diff --git a/docs/repos/getStatusChecksProtection.md b/docs/repos/getStatusChecksProtection.md index 5002b01d2..a15d7a92a 100644 --- a/docs/repos/getStatusChecksProtection.md +++ b/docs/repos/getStatusChecksProtection.md @@ -8,7 +8,7 @@ type: API method # Get status checks protection -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. ```js octokit.rest.repos.getStatusChecksProtection({ @@ -31,9 +31,13 @@ octokit.rest.repos.getStatusChecksProtection({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/getTeamsWithAccessToProtectedBranch.md b/docs/repos/getTeamsWithAccessToProtectedBranch.md index 96d5b63c0..68e8348da 100644 --- a/docs/repos/getTeamsWithAccessToProtectedBranch.md +++ b/docs/repos/getTeamsWithAccessToProtectedBranch.md @@ -8,7 +8,7 @@ type: API method # Get teams with access to the protected branch -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Lists the teams who have push access to this branch. The list includes child teams. @@ -33,9 +33,13 @@ octokit.rest.repos.getTeamsWithAccessToProtectedBranch({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/getTopPaths.md b/docs/repos/getTopPaths.md index 595d9a012..ebf16a7cb 100644 --- a/docs/repos/getTopPaths.md +++ b/docs/repos/getTopPaths.md @@ -30,9 +30,13 @@ octokit.rest.repos.getTopPaths({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/repos/getTopReferrers.md b/docs/repos/getTopReferrers.md index 599748b20..7536a3868 100644 --- a/docs/repos/getTopReferrers.md +++ b/docs/repos/getTopReferrers.md @@ -30,9 +30,13 @@ octokit.rest.repos.getTopReferrers({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/repos/getUsersWithAccessToProtectedBranch.md b/docs/repos/getUsersWithAccessToProtectedBranch.md index 82dc05b78..492e0ca1f 100644 --- a/docs/repos/getUsersWithAccessToProtectedBranch.md +++ b/docs/repos/getUsersWithAccessToProtectedBranch.md @@ -8,7 +8,7 @@ type: API method # Get users with access to the protected branch -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Lists the people who have push access to this branch. @@ -33,9 +33,13 @@ octokit.rest.repos.getUsersWithAccessToProtectedBranch({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/getViews.md b/docs/repos/getViews.md index 1e9749f31..dea163fd1 100644 --- a/docs/repos/getViews.md +++ b/docs/repos/getViews.md @@ -30,13 +30,17 @@ octokit.rest.repos.getViews({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + perno -Must be one of: `day`, `week`. +The time frame to display results for. diff --git a/docs/repos/getWebhook.md b/docs/repos/getWebhook.md index 6262ddf54..31c55c379 100644 --- a/docs/repos/getWebhook.md +++ b/docs/repos/getWebhook.md @@ -31,12 +31,18 @@ octokit.rest.repos.getWebhook({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + hook_idyes +The unique identifier of the hook. + diff --git a/docs/repos/getWebhookConfigForRepo.md b/docs/repos/getWebhookConfigForRepo.md index 5c5a46a55..df99e0119 100644 --- a/docs/repos/getWebhookConfigForRepo.md +++ b/docs/repos/getWebhookConfigForRepo.md @@ -33,12 +33,18 @@ octokit.rest.repos.getWebhookConfigForRepo({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + hook_idyes +The unique identifier of the hook. + diff --git a/docs/repos/getWebhookDelivery.md b/docs/repos/getWebhookDelivery.md index d11bd8ddc..81e948189 100644 --- a/docs/repos/getWebhookDelivery.md +++ b/docs/repos/getWebhookDelivery.md @@ -32,12 +32,18 @@ octokit.rest.repos.getWebhookDelivery({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + hook_idyes +The unique identifier of the hook. + delivery_idyes diff --git a/docs/repos/listAutolinks.md b/docs/repos/listAutolinks.md index 8b33d0683..ce405191f 100644 --- a/docs/repos/listAutolinks.md +++ b/docs/repos/listAutolinks.md @@ -32,9 +32,13 @@ octokit.rest.repos.listAutolinks({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + pageno diff --git a/docs/repos/listBranches.md b/docs/repos/listBranches.md index 0e2349073..c5c7ca6a7 100644 --- a/docs/repos/listBranches.md +++ b/docs/repos/listBranches.md @@ -28,9 +28,13 @@ octokit.rest.repos.listBranches({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + protectedno @@ -39,7 +43,7 @@ Setting to `true` returns only protected branches. When set to `false`, only unp per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/repos/listBranchesForHeadCommit.md b/docs/repos/listBranchesForHeadCommit.md index e78550067..25f65e84b 100644 --- a/docs/repos/listBranchesForHeadCommit.md +++ b/docs/repos/listBranchesForHeadCommit.md @@ -8,7 +8,7 @@ type: API method # List branches for HEAD commit -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. @@ -33,13 +33,17 @@ octokit.rest.repos.listBranchesForHeadCommit({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + commit_shayes -commit_sha parameter +The SHA of the commit. diff --git a/docs/repos/listCollaborators.md b/docs/repos/listCollaborators.md index bc786e6a6..1f374be0e 100644 --- a/docs/repos/listCollaborators.md +++ b/docs/repos/listCollaborators.md @@ -9,9 +9,14 @@ type: API method # List repository collaborators For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. +Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. Team members will include the members of child teams. +You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this +endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this +endpoint. + ```js octokit.rest.repos.listCollaborators({ owner, @@ -32,21 +37,22 @@ octokit.rest.repos.listCollaborators({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + affiliationno -Filter collaborators returned by their affiliation. Can be one of: -\* `outside`: All outside collaborators of an organization-owned repository. -\* `direct`: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. -\* `all`: All collaborators the authenticated user can see. +Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` means all collaborators with permissions to an organization-owned repository, regardless of organization membership status. `all` means all collaborators the authenticated user can see. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/repos/listCommentsForCommit.md b/docs/repos/listCommentsForCommit.md index f3a054589..add17a2e6 100644 --- a/docs/repos/listCommentsForCommit.md +++ b/docs/repos/listCommentsForCommit.md @@ -31,18 +31,22 @@ octokit.rest.repos.listCommentsForCommit({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + commit_shayes -commit_sha parameter +The SHA of the commit. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/repos/listCommitCommentsForRepo.md b/docs/repos/listCommitCommentsForRepo.md index ed1935350..fdb323f6d 100644 --- a/docs/repos/listCommitCommentsForRepo.md +++ b/docs/repos/listCommitCommentsForRepo.md @@ -32,13 +32,17 @@ octokit.rest.repos.listCommitCommentsForRepo({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/repos/listCommitStatusesForRef.md b/docs/repos/listCommitStatusesForRef.md index aec060805..9e7685a8f 100644 --- a/docs/repos/listCommitStatusesForRef.md +++ b/docs/repos/listCommitStatusesForRef.md @@ -33,9 +33,13 @@ octokit.rest.repos.listCommitStatusesForRef({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + refyes @@ -44,7 +48,7 @@ ref parameter per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/repos/listCommits.md b/docs/repos/listCommits.md index d7ae2e0b9..437f22d4b 100644 --- a/docs/repos/listCommits.md +++ b/docs/repos/listCommits.md @@ -57,9 +57,13 @@ octokit.rest.repos.listCommits({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + shano @@ -88,7 +92,7 @@ Only commits before this date will be returned. This is a timestamp in [ISO 8601 per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/repos/listContributors.md b/docs/repos/listContributors.md index b2577669e..f1c6d3bd7 100644 --- a/docs/repos/listContributors.md +++ b/docs/repos/listContributors.md @@ -32,9 +32,13 @@ octokit.rest.repos.listContributors({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + anonno @@ -43,7 +47,7 @@ Set to `1` or `true` to include anonymous contributors in results. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/repos/listDeployKeys.md b/docs/repos/listDeployKeys.md index 1ddc8ac36..410861365 100644 --- a/docs/repos/listDeployKeys.md +++ b/docs/repos/listDeployKeys.md @@ -28,13 +28,17 @@ octokit.rest.repos.listDeployKeys({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/repos/listDeploymentStatuses.md b/docs/repos/listDeploymentStatuses.md index 67dcef283..819201b48 100644 --- a/docs/repos/listDeploymentStatuses.md +++ b/docs/repos/listDeploymentStatuses.md @@ -31,9 +31,13 @@ octokit.rest.repos.listDeploymentStatuses({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + deployment_idyes @@ -42,7 +46,7 @@ deployment_id parameter per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/repos/listDeployments.md b/docs/repos/listDeployments.md index b86939f4b..e969a02b0 100644 --- a/docs/repos/listDeployments.md +++ b/docs/repos/listDeployments.md @@ -30,9 +30,13 @@ octokit.rest.repos.listDeployments({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + shano @@ -56,7 +60,7 @@ The name of the environment that was deployed to (e.g., `staging` or `production per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/repos/listForAuthenticatedUser.md b/docs/repos/listForAuthenticatedUser.md index 7ec9572b9..b3e8ed396 100644 --- a/docs/repos/listForAuthenticatedUser.md +++ b/docs/repos/listForAuthenticatedUser.md @@ -29,7 +29,7 @@ octokit.rest.repos.listForAuthenticatedUser(); visibilityno -Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`. +Limit results to repositories with the specified visibility. affiliationno @@ -42,24 +42,22 @@ Comma-separated list of values. Can include: typeno -Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` - -Will cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**. +Limit results to repositories of the specified type. Will cause a `422` error if used in the same request as **visibility** or **affiliation**. sortno -Can be one of `created`, `updated`, `pushed`, `full_name`. +The property to sort the results by. directionno -Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc` +The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/repos/listForOrg.md b/docs/repos/listForOrg.md index f803e1c3d..347142332 100644 --- a/docs/repos/listForOrg.md +++ b/docs/repos/listForOrg.md @@ -29,25 +29,27 @@ octokit.rest.repos.listForOrg({ orgyes +The organization name. The name is not case sensitive. + typeno -Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`. However, the `internal` value is not yet supported when a GitHub App calls this API with an installation access token. +Specifies the types of repositories you want returned. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`. However, the `internal` value is not yet supported when a GitHub App calls this API with an installation access token. sortno -Can be one of `created`, `updated`, `pushed`, `full_name`. +The property to sort the results by. directionno -Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc` +The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/repos/listForUser.md b/docs/repos/listForUser.md index beedbe582..09df94570 100644 --- a/docs/repos/listForUser.md +++ b/docs/repos/listForUser.md @@ -29,25 +29,27 @@ octokit.rest.repos.listForUser({ usernameyes +The handle for the GitHub user account. + typeno -Can be one of `all`, `owner`, `member`. +Limit results to repositories of the specified type. sortno -Can be one of `created`, `updated`, `pushed`, `full_name`. +The property to sort the results by. directionno -Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc` +The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/repos/listForks.md b/docs/repos/listForks.md index 74b3bfc81..33b16c0cb 100644 --- a/docs/repos/listForks.md +++ b/docs/repos/listForks.md @@ -28,9 +28,13 @@ octokit.rest.repos.listForks({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + sortno @@ -39,7 +43,7 @@ The sort order. Can be either `newest`, `oldest`, or `stargazers`. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/repos/listInvitations.md b/docs/repos/listInvitations.md index bdc6c9664..b59f17188 100644 --- a/docs/repos/listInvitations.md +++ b/docs/repos/listInvitations.md @@ -30,13 +30,17 @@ octokit.rest.repos.listInvitations({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/repos/listInvitationsForAuthenticatedUser.md b/docs/repos/listInvitationsForAuthenticatedUser.md index 89bbf4df4..0032c8d4f 100644 --- a/docs/repos/listInvitationsForAuthenticatedUser.md +++ b/docs/repos/listInvitationsForAuthenticatedUser.md @@ -27,7 +27,7 @@ octokit.rest.repos.listInvitationsForAuthenticatedUser(); per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/repos/listLanguages.md b/docs/repos/listLanguages.md index b51632120..206bc27ec 100644 --- a/docs/repos/listLanguages.md +++ b/docs/repos/listLanguages.md @@ -30,9 +30,13 @@ octokit.rest.repos.listLanguages({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/repos/listPagesBuilds.md b/docs/repos/listPagesBuilds.md index 3184b0cdb..7dccc4a32 100644 --- a/docs/repos/listPagesBuilds.md +++ b/docs/repos/listPagesBuilds.md @@ -28,13 +28,17 @@ octokit.rest.repos.listPagesBuilds({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/repos/listPullRequestsAssociatedWithCommit.md b/docs/repos/listPullRequestsAssociatedWithCommit.md index 534918f31..7ee78a2b6 100644 --- a/docs/repos/listPullRequestsAssociatedWithCommit.md +++ b/docs/repos/listPullRequestsAssociatedWithCommit.md @@ -8,7 +8,7 @@ type: API method # List pull requests associated with a commit -Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests) endpoint. +Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. ```js octokit.rest.repos.listPullRequestsAssociatedWithCommit({ @@ -31,18 +31,22 @@ octokit.rest.repos.listPullRequestsAssociatedWithCommit({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + commit_shayes -commit_sha parameter +The SHA of the commit. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/repos/listReleaseAssets.md b/docs/repos/listReleaseAssets.md index e2abac8df..3069a4ea1 100644 --- a/docs/repos/listReleaseAssets.md +++ b/docs/repos/listReleaseAssets.md @@ -29,18 +29,22 @@ octokit.rest.repos.listReleaseAssets({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + release_idyes -release_id parameter +The unique identifier of the release. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/repos/listReleases.md b/docs/repos/listReleases.md index dabdb2431..8752ff68d 100644 --- a/docs/repos/listReleases.md +++ b/docs/repos/listReleases.md @@ -32,13 +32,17 @@ octokit.rest.repos.listReleases({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/repos/listTagProtection.md b/docs/repos/listTagProtection.md new file mode 100644 index 000000000..abb5eab61 --- /dev/null +++ b/docs/repos/listTagProtection.md @@ -0,0 +1,46 @@ +--- +name: List tag protection states for a repository +example: octokit.rest.repos.listTagProtection({ owner, repo }) +route: GET /repos/{owner}/{repo}/tags/protection +scope: repos +type: API method +--- + +# List tag protection states for a repository + +This returns the tag protection states of a repository. + +This information is only available to repository administrators. + +```js +octokit.rest.repos.listTagProtection({ + owner, + repo, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#list-tag-protection-state-of-a-repository). diff --git a/docs/repos/listTags.md b/docs/repos/listTags.md index fda7e80db..cf1122b4e 100644 --- a/docs/repos/listTags.md +++ b/docs/repos/listTags.md @@ -28,13 +28,17 @@ octokit.rest.repos.listTags({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/repos/listTeams.md b/docs/repos/listTeams.md index 4b598f813..e931791b7 100644 --- a/docs/repos/listTeams.md +++ b/docs/repos/listTeams.md @@ -28,13 +28,17 @@ octokit.rest.repos.listTeams({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/repos/listWebhookDeliveries.md b/docs/repos/listWebhookDeliveries.md index b2820c19a..46fb0af61 100644 --- a/docs/repos/listWebhookDeliveries.md +++ b/docs/repos/listWebhookDeliveries.md @@ -31,16 +31,22 @@ octokit.rest.repos.listWebhookDeliveries({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + hook_idyes +The unique identifier of the hook. + per_pageno -Results per page (max 100) +The number of results per page (max 100). cursorno diff --git a/docs/repos/listWebhooks.md b/docs/repos/listWebhooks.md index cbb7e774b..69844faad 100644 --- a/docs/repos/listWebhooks.md +++ b/docs/repos/listWebhooks.md @@ -28,13 +28,17 @@ octokit.rest.repos.listWebhooks({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/repos/merge.md b/docs/repos/merge.md index 1399435f0..738e69aaa 100644 --- a/docs/repos/merge.md +++ b/docs/repos/merge.md @@ -30,9 +30,13 @@ octokit.rest.repos.merge({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + baseyes diff --git a/docs/repos/mergeUpstream.md b/docs/repos/mergeUpstream.md index 19dd1b51e..81375f3c8 100644 --- a/docs/repos/mergeUpstream.md +++ b/docs/repos/mergeUpstream.md @@ -8,8 +8,6 @@ type: API method # Sync a fork branch with the upstream repository -**Note:** This endpoint is currently in beta and subject to change. - Sync a branch of a forked repository to keep it up-to-date with the upstream repository. ```js @@ -33,9 +31,13 @@ octokit.rest.repos.mergeUpstream({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/pingWebhook.md b/docs/repos/pingWebhook.md index bc3f20279..fd78c617f 100644 --- a/docs/repos/pingWebhook.md +++ b/docs/repos/pingWebhook.md @@ -31,12 +31,18 @@ octokit.rest.repos.pingWebhook({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + hook_idyes +The unique identifier of the hook. + diff --git a/docs/repos/redeliverWebhookDelivery.md b/docs/repos/redeliverWebhookDelivery.md index fcca44af0..29de3c8b8 100644 --- a/docs/repos/redeliverWebhookDelivery.md +++ b/docs/repos/redeliverWebhookDelivery.md @@ -32,12 +32,18 @@ octokit.rest.repos.redeliverWebhookDelivery({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + hook_idyes +The unique identifier of the hook. + delivery_idyes diff --git a/docs/repos/removeAppAccessRestrictions.md b/docs/repos/removeAppAccessRestrictions.md index 590d37e56..1d6df3ab2 100644 --- a/docs/repos/removeAppAccessRestrictions.md +++ b/docs/repos/removeAppAccessRestrictions.md @@ -8,7 +8,7 @@ type: API method # Remove app access restrictions -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Removes the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. @@ -38,9 +38,13 @@ octokit.rest.repos.removeAppAccessRestrictions({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/removeCollaborator.md b/docs/repos/removeCollaborator.md index 14f5d8e20..47342e020 100644 --- a/docs/repos/removeCollaborator.md +++ b/docs/repos/removeCollaborator.md @@ -29,12 +29,18 @@ octokit.rest.repos.removeCollaborator({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + usernameyes +The handle for the GitHub user account. + diff --git a/docs/repos/removeStatusCheckContexts.md b/docs/repos/removeStatusCheckContexts.md index 1d648c984..bf4e49238 100644 --- a/docs/repos/removeStatusCheckContexts.md +++ b/docs/repos/removeStatusCheckContexts.md @@ -8,7 +8,7 @@ type: API method # Remove status check contexts -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. ```js octokit.rest.repos.removeStatusCheckContexts({ @@ -32,9 +32,13 @@ octokit.rest.repos.removeStatusCheckContexts({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/removeStatusCheckProtection.md b/docs/repos/removeStatusCheckProtection.md index 009b69fdc..ebe44067a 100644 --- a/docs/repos/removeStatusCheckProtection.md +++ b/docs/repos/removeStatusCheckProtection.md @@ -8,7 +8,7 @@ type: API method # Remove status check protection -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. ```js octokit.rest.repos.removeStatusCheckProtection({ @@ -31,9 +31,13 @@ octokit.rest.repos.removeStatusCheckProtection({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/removeTeamAccessRestrictions.md b/docs/repos/removeTeamAccessRestrictions.md index 82b50f22c..f88e36ab7 100644 --- a/docs/repos/removeTeamAccessRestrictions.md +++ b/docs/repos/removeTeamAccessRestrictions.md @@ -8,7 +8,7 @@ type: API method # Remove team access restrictions -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Removes the ability of a team to push to this branch. You can also remove push access for child teams. @@ -38,9 +38,13 @@ octokit.rest.repos.removeTeamAccessRestrictions({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/removeUserAccessRestrictions.md b/docs/repos/removeUserAccessRestrictions.md index 1f6c95bb1..e607b130f 100644 --- a/docs/repos/removeUserAccessRestrictions.md +++ b/docs/repos/removeUserAccessRestrictions.md @@ -8,7 +8,7 @@ type: API method # Remove user access restrictions -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Removes the ability of a user to push to this branch. @@ -38,9 +38,13 @@ octokit.rest.repos.removeUserAccessRestrictions({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/renameBranch.md b/docs/repos/renameBranch.md index 872dc36fe..a856bb24d 100644 --- a/docs/repos/renameBranch.md +++ b/docs/repos/renameBranch.md @@ -46,9 +46,13 @@ octokit.rest.repos.renameBranch({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/replaceAllTopics.md b/docs/repos/replaceAllTopics.md index 37c03b524..e1982ae43 100644 --- a/docs/repos/replaceAllTopics.md +++ b/docs/repos/replaceAllTopics.md @@ -29,9 +29,13 @@ octokit.rest.repos.replaceAllTopics({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + namesyes diff --git a/docs/repos/requestPagesBuild.md b/docs/repos/requestPagesBuild.md index 3f55ee8a3..809dc75a9 100644 --- a/docs/repos/requestPagesBuild.md +++ b/docs/repos/requestPagesBuild.md @@ -32,9 +32,13 @@ octokit.rest.repos.requestPagesBuild({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/repos/setAdminBranchProtection.md b/docs/repos/setAdminBranchProtection.md index 3dd8c717d..dcfd757cf 100644 --- a/docs/repos/setAdminBranchProtection.md +++ b/docs/repos/setAdminBranchProtection.md @@ -8,7 +8,7 @@ type: API method # Set admin branch protection -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. @@ -33,9 +33,13 @@ octokit.rest.repos.setAdminBranchProtection({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/setAppAccessRestrictions.md b/docs/repos/setAppAccessRestrictions.md index 1ceff7503..ca523f8e6 100644 --- a/docs/repos/setAppAccessRestrictions.md +++ b/docs/repos/setAppAccessRestrictions.md @@ -8,7 +8,7 @@ type: API method # Set app access restrictions -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. @@ -38,9 +38,13 @@ octokit.rest.repos.setAppAccessRestrictions({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/setStatusCheckContexts.md b/docs/repos/setStatusCheckContexts.md index abf93e67f..40d6ae426 100644 --- a/docs/repos/setStatusCheckContexts.md +++ b/docs/repos/setStatusCheckContexts.md @@ -8,7 +8,7 @@ type: API method # Set status check contexts -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. ```js octokit.rest.repos.setStatusCheckContexts({ @@ -32,9 +32,13 @@ octokit.rest.repos.setStatusCheckContexts({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/setTeamAccessRestrictions.md b/docs/repos/setTeamAccessRestrictions.md index cec083b8a..c6011e2d4 100644 --- a/docs/repos/setTeamAccessRestrictions.md +++ b/docs/repos/setTeamAccessRestrictions.md @@ -8,7 +8,7 @@ type: API method # Set team access restrictions -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams. @@ -38,9 +38,13 @@ octokit.rest.repos.setTeamAccessRestrictions({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/setUserAccessRestrictions.md b/docs/repos/setUserAccessRestrictions.md index 218de0a5c..ea51928fe 100644 --- a/docs/repos/setUserAccessRestrictions.md +++ b/docs/repos/setUserAccessRestrictions.md @@ -8,7 +8,7 @@ type: API method # Set user access restrictions -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people. @@ -38,9 +38,13 @@ octokit.rest.repos.setUserAccessRestrictions({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes diff --git a/docs/repos/testPushWebhook.md b/docs/repos/testPushWebhook.md index 2ef189716..108f763f2 100644 --- a/docs/repos/testPushWebhook.md +++ b/docs/repos/testPushWebhook.md @@ -33,12 +33,18 @@ octokit.rest.repos.testPushWebhook({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + hook_idyes +The unique identifier of the hook. + diff --git a/docs/repos/transfer.md b/docs/repos/transfer.md index 4f0d24eae..069374f00 100644 --- a/docs/repos/transfer.md +++ b/docs/repos/transfer.md @@ -8,7 +8,7 @@ type: API method # Transfer a repository -A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://help.github.com/articles/about-repository-transfers/). +A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). ```js octokit.rest.repos.transfer({ @@ -31,9 +31,13 @@ octokit.rest.repos.transfer({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + new_owneryes diff --git a/docs/repos/update.md b/docs/repos/update.md index 58a68454f..3b6696ceb 100644 --- a/docs/repos/update.md +++ b/docs/repos/update.md @@ -30,9 +30,13 @@ octokit.rest.repos.update({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + nameno @@ -52,7 +56,7 @@ A URL with more information about the repository. privateno Either `true` to make the repository private or `false` to make it public. Default: `false`. -**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. +**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. visibilityno @@ -84,6 +88,16 @@ Use the `status` property to enable or disable secret scanning for this reposito Can be `enabled` or `disabled`. + +security_and_analysis.secret_scanning_push_protectionno + +Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see "[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." + + +security_and_analysis.secret_scanning_push_protection.statusno + +Can be `enabled` or `disabled`. + has_issuesno @@ -134,6 +148,16 @@ Either `true` to allow auto-merge on pull requests, or `false` to disallow auto- Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. + +allow_update_branchno + +Either `true` to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise. + + +use_squash_pr_title_as_defaultno + +Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. + archivedno diff --git a/docs/repos/updateBranchProtection.md b/docs/repos/updateBranchProtection.md index 3fbdce9bf..ec831cc6e 100644 --- a/docs/repos/updateBranchProtection.md +++ b/docs/repos/updateBranchProtection.md @@ -1,6 +1,6 @@ --- name: Update branch protection -example: octokit.rest.repos.updateBranchProtection({ owner, repo, branch, required_status_checks, required_status_checks.strict, required_status_checks.contexts, enforce_admins, required_pull_request_reviews, restrictions, restrictions.users, restrictions.teams }) +example: octokit.rest.repos.updateBranchProtection({ owner, repo, branch, required_status_checks, required_status_checks.strict, required_status_checks.contexts, required_status_checks.checks[].context, enforce_admins, required_pull_request_reviews, restrictions, restrictions.users, restrictions.teams }) route: PUT /repos/{owner}/{repo}/branches/{branch}/protection scope: repos type: API method @@ -8,7 +8,7 @@ type: API method # Update branch protection -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Protecting a branch requires admin or owner permissions to the repository. @@ -24,6 +24,7 @@ branch, required_status_checks, required_status_checks.strict, required_status_checks.contexts, +required_status_checks.checks[].context, enforce_admins, required_pull_request_reviews, restrictions, @@ -45,9 +46,13 @@ restrictions.teams owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes @@ -66,7 +71,22 @@ Require branches to be up to date before merging. required_status_checks.contextsyes -The list of status checks to require in order to merge into this branch +**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + + +required_status_checks.checksno + +The list of status checks to require in order to merge into this branch. + + +required_status_checks.checks[].contextyes + +The name of the required check + + +required_status_checks.checks[].app_idno + +The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status. enforce_adminsyes @@ -81,7 +101,7 @@ Require at least one approving review on a pull request, before merging. Set to required_pull_request_reviews.dismissal_restrictionsno -Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. +Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. required_pull_request_reviews.dismissal_restrictions.usersno @@ -93,6 +113,11 @@ The list of user `login`s with dismissal access The list of team `slug`s with dismissal access + +required_pull_request_reviews.dismissal_restrictions.appsno + +The list of app `slug`s with dismissal access + required_pull_request_reviews.dismiss_stale_reviewsno @@ -101,12 +126,32 @@ Set to `true` if you want to automatically dismiss approving reviews when someon required_pull_request_reviews.require_code_owner_reviewsno -Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) review them. +Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them. required_pull_request_reviews.required_approving_review_countno -Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6. +Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. + + +required_pull_request_reviews.bypass_pull_request_allowancesno + +Allow specific users, teams, or apps to bypass pull request requirements. + + +required_pull_request_reviews.bypass_pull_request_allowances.usersno + +The list of user `login`s allowed to bypass pull request requirements. + + +required_pull_request_reviews.bypass_pull_request_allowances.teamsno + +The list of team `slug`s allowed to bypass pull request requirements. + + +required_pull_request_reviews.bypass_pull_request_allowances.appsno + +The list of app `slug`s allowed to bypass pull request requirements. restrictionsyes @@ -131,17 +176,22 @@ The list of app `slug`s with push access required_linear_historyno -Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://help.github.com/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation. +Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation. allow_force_pushesno -Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." +Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." allow_deletionsno -Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation. +Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation. + + +block_creationsno + +If set to `true`, the `restrictions` branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to `true` to restrict new branch creation. Default: `false`. required_conversation_resolutionno diff --git a/docs/repos/updateCommitComment.md b/docs/repos/updateCommitComment.md index e61e46a04..261033e24 100644 --- a/docs/repos/updateCommitComment.md +++ b/docs/repos/updateCommitComment.md @@ -30,13 +30,17 @@ octokit.rest.repos.updateCommitComment({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + comment_idyes -comment_id parameter +The unique identifier of the comment. bodyyes diff --git a/docs/repos/updateInformationAboutPagesSite.md b/docs/repos/updateInformationAboutPagesSite.md index bd28a7817..bbb855af6 100644 --- a/docs/repos/updateInformationAboutPagesSite.md +++ b/docs/repos/updateInformationAboutPagesSite.md @@ -30,13 +30,17 @@ octokit.rest.repos.updateInformationAboutPagesSite({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + cnameno -Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://help.github.com/articles/using-a-custom-domain-with-github-pages/)." +Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/)." https_enforcedno diff --git a/docs/repos/updateInvitation.md b/docs/repos/updateInvitation.md index 9fff2782f..ddb4414a6 100644 --- a/docs/repos/updateInvitation.md +++ b/docs/repos/updateInvitation.md @@ -29,13 +29,17 @@ octokit.rest.repos.updateInvitation({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + invitation_idyes -invitation_id parameter +The unique identifier of the invitation. permissionsno diff --git a/docs/repos/updatePullRequestReviewProtection.md b/docs/repos/updatePullRequestReviewProtection.md index 4b98bba23..0a7626648 100644 --- a/docs/repos/updatePullRequestReviewProtection.md +++ b/docs/repos/updatePullRequestReviewProtection.md @@ -8,7 +8,7 @@ type: API method # Update pull request review protection -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. @@ -35,9 +35,13 @@ octokit.rest.repos.updatePullRequestReviewProtection({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes @@ -46,7 +50,7 @@ The name of the branch. dismissal_restrictionsno -Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. +Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. dismissal_restrictions.usersno @@ -58,6 +62,11 @@ The list of user `login`s with dismissal access The list of team `slug`s with dismissal access + +dismissal_restrictions.appsno + +The list of app `slug`s with dismissal access + dismiss_stale_reviewsno @@ -66,12 +75,32 @@ Set to `true` if you want to automatically dismiss approving reviews when someon require_code_owner_reviewsno -Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed. +Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) have reviewed. required_approving_review_countno -Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6. +Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. + + +bypass_pull_request_allowancesno + +Allow specific users, teams, or apps to bypass pull request requirements. + + +bypass_pull_request_allowances.usersno + +The list of user `login`s allowed to bypass pull request requirements. + + +bypass_pull_request_allowances.teamsno + +The list of team `slug`s allowed to bypass pull request requirements. + + +bypass_pull_request_allowances.appsno + +The list of app `slug`s allowed to bypass pull request requirements. diff --git a/docs/repos/updateRelease.md b/docs/repos/updateRelease.md index cb00b2479..8102f7df2 100644 --- a/docs/repos/updateRelease.md +++ b/docs/repos/updateRelease.md @@ -31,13 +31,17 @@ octokit.rest.repos.updateRelease({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + release_idyes -release_id parameter +The unique identifier of the release. tag_nameno diff --git a/docs/repos/updateReleaseAsset.md b/docs/repos/updateReleaseAsset.md index a2ec501f7..20ff3c093 100644 --- a/docs/repos/updateReleaseAsset.md +++ b/docs/repos/updateReleaseAsset.md @@ -31,13 +31,17 @@ octokit.rest.repos.updateReleaseAsset({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + asset_idyes -asset_id parameter +The unique identifier of the asset. nameno diff --git a/docs/repos/updateStatusCheckPotection.md b/docs/repos/updateStatusCheckPotection.md index 003b9737b..a23928d8f 100644 --- a/docs/repos/updateStatusCheckPotection.md +++ b/docs/repos/updateStatusCheckPotection.md @@ -1,6 +1,6 @@ --- name: Update status check protection -example: octokit.rest.repos.updateStatusCheckPotection({ owner, repo, branch }) +example: octokit.rest.repos.updateStatusCheckPotection({ owner, repo, branch, checks[].context }) route: PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks scope: repos type: API method @@ -10,16 +10,17 @@ type: API method **Deprecated:** This method has been renamed to repos.updateStatusCheckProtection -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. ```js octokit.rest.repos.updateStatusCheckPotection({ - owner, - repo, - branch, -}); + owner, +repo, +branch, +checks[].context + }) ``` ## Parameters @@ -35,9 +36,13 @@ octokit.rest.repos.updateStatusCheckPotection({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes @@ -51,10 +56,25 @@ Require branches to be up to date before merging. contextsno -The list of status checks to require in order to merge into this branch +**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + + +checksno + +The list of status checks to require in order to merge into this branch. + + +checks[].contextyes + +The name of the required check + + +checks[].app_idno + +The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#update-status-check-potection). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#update-status-check-protection). diff --git a/docs/repos/updateStatusCheckProtection.md b/docs/repos/updateStatusCheckProtection.md index 787bed573..3f9eb9d73 100644 --- a/docs/repos/updateStatusCheckProtection.md +++ b/docs/repos/updateStatusCheckProtection.md @@ -1,6 +1,6 @@ --- name: Update status check protection -example: octokit.rest.repos.updateStatusCheckProtection({ owner, repo, branch }) +example: octokit.rest.repos.updateStatusCheckProtection({ owner, repo, branch, checks[].context }) route: PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks scope: repos type: API method @@ -8,16 +8,17 @@ type: API method # Update status check protection -Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. ```js octokit.rest.repos.updateStatusCheckProtection({ - owner, - repo, - branch, -}); + owner, +repo, +branch, +checks[].context + }) ``` ## Parameters @@ -33,9 +34,13 @@ octokit.rest.repos.updateStatusCheckProtection({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + branchyes @@ -49,10 +54,25 @@ Require branches to be up to date before merging. contextsno -The list of status checks to require in order to merge into this branch +**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + + +checksno + +The list of status checks to require in order to merge into this branch. + + +checks[].contextyes + +The name of the required check + + +checks[].app_idno + +The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#update-status-check-potection). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#update-status-check-protection). diff --git a/docs/repos/updateWebhook.md b/docs/repos/updateWebhook.md index 4d46d4557..8b0e187f4 100644 --- a/docs/repos/updateWebhook.md +++ b/docs/repos/updateWebhook.md @@ -32,12 +32,18 @@ config.url owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + hook_idyes +The unique identifier of the hook. + configno diff --git a/docs/repos/updateWebhookConfigForRepo.md b/docs/repos/updateWebhookConfigForRepo.md index 0d06265fa..630fd49b5 100644 --- a/docs/repos/updateWebhookConfigForRepo.md +++ b/docs/repos/updateWebhookConfigForRepo.md @@ -33,12 +33,18 @@ octokit.rest.repos.updateWebhookConfigForRepo({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + hook_idyes +The unique identifier of the hook. + urlno diff --git a/docs/repos/uploadReleaseAsset.md b/docs/repos/uploadReleaseAsset.md index e67b4c26e..45c675178 100644 --- a/docs/repos/uploadReleaseAsset.md +++ b/docs/repos/uploadReleaseAsset.md @@ -51,13 +51,17 @@ octokit.rest.repos.uploadReleaseAsset({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + release_idyes -release_id parameter +The unique identifier of the release. nameyes diff --git a/docs/search/code.md b/docs/search/code.md index a9a2605e8..15bdb1919 100644 --- a/docs/search/code.md +++ b/docs/search/code.md @@ -45,7 +45,7 @@ octokit.rest.search.code({ qyes -The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching code](https://help.github.com/articles/searching-code/)" for a detailed list of qualifiers. +The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching code](https://docs.github.com/search-github/searching-on-github/searching-code)" for a detailed list of qualifiers. sortno @@ -60,7 +60,7 @@ Determines whether the first search result returned is the highest number of mat per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/search/commits.md b/docs/search/commits.md index 613a16fa6..556143437 100644 --- a/docs/search/commits.md +++ b/docs/search/commits.md @@ -36,7 +36,7 @@ octokit.rest.search.commits({ qyes -The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching commits](https://help.github.com/articles/searching-commits/)" for a detailed list of qualifiers. +The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching commits](https://docs.github.com/search-github/searching-on-github/searching-commits)" for a detailed list of qualifiers. sortno @@ -51,7 +51,7 @@ Determines whether the first search result returned is the highest number of mat per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/search/issuesAndPullRequests.md b/docs/search/issuesAndPullRequests.md index 744c501eb..2c89cc098 100644 --- a/docs/search/issuesAndPullRequests.md +++ b/docs/search/issuesAndPullRequests.md @@ -40,7 +40,7 @@ octokit.rest.search.issuesAndPullRequests({ qyes -The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)" for a detailed list of qualifiers. +The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching issues and pull requests](https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests)" for a detailed list of qualifiers. sortno @@ -55,7 +55,7 @@ Determines whether the first search result returned is the highest number of mat per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/search/labels.md b/docs/search/labels.md index f5803e25a..36276b50c 100644 --- a/docs/search/labels.md +++ b/docs/search/labels.md @@ -58,7 +58,7 @@ Determines whether the first search result returned is the highest number of mat per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/search/repos.md b/docs/search/repos.md index b8a172bb3..aa654395d 100644 --- a/docs/search/repos.md +++ b/docs/search/repos.md @@ -18,10 +18,6 @@ For example, if you want to search for popular Tetris repositories written in as This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. -When you include the `mercy` preview header, you can also search for multiple topics by adding more `topic:` instances. For example, your query might look like this: - -`q=topic:ruby+topic:rails` - ```js octokit.rest.search.repos({ q, @@ -41,7 +37,7 @@ octokit.rest.search.repos({ qyes -The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching for repositories](https://help.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. +The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. sortno @@ -56,7 +52,7 @@ Determines whether the first search result returned is the highest number of mat per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/search/topics.md b/docs/search/topics.md index fdf5071b5..7d3b9335d 100644 --- a/docs/search/topics.md +++ b/docs/search/topics.md @@ -8,7 +8,7 @@ type: API method # Search topics -Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://help.github.com/articles/searching-topics/)" for a detailed list of qualifiers. +Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. When searching for topics, you can get text match metadata for the topic's **short_description**, **description**, **name**, or **display_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). @@ -37,12 +37,12 @@ octokit.rest.search.topics({ qyes -The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). +The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/search/users.md b/docs/search/users.md index 732b4012e..0391e9fac 100644 --- a/docs/search/users.md +++ b/docs/search/users.md @@ -37,7 +37,7 @@ octokit.rest.search.users({ qyes -The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching users](https://help.github.com/articles/searching-users/)" for a detailed list of qualifiers. +The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching users](https://docs.github.com/search-github/searching-on-github/searching-users)" for a detailed list of qualifiers. sortno @@ -52,7 +52,7 @@ Determines whether the first search result returned is the highest number of mat per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/secretScanning/getAlert.md b/docs/secretScanning/getAlert.md index 1d3ac66cb..8f02529c6 100644 --- a/docs/secretScanning/getAlert.md +++ b/docs/secretScanning/getAlert.md @@ -8,7 +8,9 @@ type: API method # Get a secret scanning alert -Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. +Gets a single secret scanning alert detected in an eligible repository. +To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. +For public repositories, you may instead use the `public_repo` scope. GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. @@ -33,9 +35,13 @@ octokit.rest.secretScanning.getAlert({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + alert_numberyes diff --git a/docs/secretScanning/listAlertsForEnterprise.md b/docs/secretScanning/listAlertsForEnterprise.md new file mode 100644 index 000000000..d6a079abd --- /dev/null +++ b/docs/secretScanning/listAlertsForEnterprise.md @@ -0,0 +1,81 @@ +--- +name: List secret scanning alerts for an enterprise +example: octokit.rest.secretScanning.listAlertsForEnterprise({ enterprise }) +route: GET /enterprises/{enterprise}/secret-scanning/alerts +scope: secretScanning +type: API method +--- + +# List secret scanning alerts for an enterprise + +Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. +To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). + +```js +octokit.rest.secretScanning.listAlertsForEnterprise({ + enterprise, +}); +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + +
namerequireddescription
enterpriseyes + +The slug version of the enterprise name. You can also substitute this value with the enterprise id. + +
stateno + +Set to `open` or `resolved` to only list secret scanning alerts in a specific state. + +
secret_typeno + +A comma-separated list of secret types to return. By default all secret types are returned. +See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" +for a complete list of secret types. + +
resolutionno + +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`. + +
sortno + +The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. + +
directionno + +The direction to sort the results by. + +
per_pageno + +The number of results per page (max 100). + +
beforeno + +A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. + +
afterno + +A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-an-enterprise). diff --git a/docs/secretScanning/listAlertsForOrg.md b/docs/secretScanning/listAlertsForOrg.md index 2ec457e80..b73721618 100644 --- a/docs/secretScanning/listAlertsForOrg.md +++ b/docs/secretScanning/listAlertsForOrg.md @@ -1,15 +1,16 @@ --- -name: List secret scanning alerts by organization +name: List secret scanning alerts for an organization example: octokit.rest.secretScanning.listAlertsForOrg({ org }) route: GET /orgs/{org}/secret-scanning/alerts scope: secretScanning type: API method --- -# List secret scanning alerts by organization +# List secret scanning alerts for an organization -Lists all secret scanning alerts for all eligible repositories in an organization, from newest to oldest. -To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. +Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. +To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. +For public repositories, you may instead use the `public_repo` scope. GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. @@ -32,6 +33,8 @@ octokit.rest.secretScanning.listAlertsForOrg({ orgyes +The organization name. The name is not case sensitive. + stateno @@ -41,12 +44,24 @@ Set to `open` or `resolved` to only list secret scanning alerts in a specific st secret_typeno A comma-separated list of secret types to return. By default all secret types are returned. +See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" +for a complete list of secret types. resolutionno 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`. + +sortno + +The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. + + +directionno + +The direction to sort the results by. + pageno @@ -55,10 +70,10 @@ Page number of the results to fetch. per_pageno -Results per page (max 100) +The number of results per page (max 100). -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-by-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-an-organization). diff --git a/docs/secretScanning/listAlertsForRepo.md b/docs/secretScanning/listAlertsForRepo.md index 9ee70f76c..a62b5cf82 100644 --- a/docs/secretScanning/listAlertsForRepo.md +++ b/docs/secretScanning/listAlertsForRepo.md @@ -8,7 +8,9 @@ type: API method # List secret scanning alerts for a repository -Lists all secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. +Lists secret scanning alerts for an eligible repository, from newest to oldest. +To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. +For public repositories, you may instead use the `public_repo` scope. GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. @@ -32,9 +34,13 @@ octokit.rest.secretScanning.listAlertsForRepo({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + stateno @@ -43,13 +49,25 @@ Set to `open` or `resolved` to only list secret scanning alerts in a specific st secret_typeno -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). +A comma-separated list of secret types to return. By default all secret types are returned. +See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" +for a complete list of secret types. resolutionno 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`. + +sortno + +The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. + + +directionno + +The direction to sort the results by. + pageno @@ -58,7 +76,7 @@ Page number of the results to fetch. per_pageno -Results per page (max 100) +The number of results per page (max 100). diff --git a/docs/secretScanning/listLocationsForAlert.md b/docs/secretScanning/listLocationsForAlert.md new file mode 100644 index 000000000..fe643f6ab --- /dev/null +++ b/docs/secretScanning/listLocationsForAlert.md @@ -0,0 +1,64 @@ +--- +name: List locations for a secret scanning alert +example: octokit.rest.secretScanning.listLocationsForAlert({ owner, repo, alert_number }) +route: GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations +scope: secretScanning +type: API method +--- + +# List locations for a secret scanning alert + +Lists all locations for a given secret scanning alert for an eligible repository. +To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. +For public repositories, you may instead use the `public_repo` scope. + +GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + +```js +octokit.rest.secretScanning.listLocationsForAlert({ + owner, + repo, + alert_number, +}); +``` + +## Parameters + + + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository. The name is not case sensitive. + +
alert_numberyes + +The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. + +
pageno + +Page number of the results to fetch. + +
per_pageno + +The number of results per page (max 100). + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/secret-scanning#list-locations-for-a-secret-scanning-alert). diff --git a/docs/secretScanning/updateAlert.md b/docs/secretScanning/updateAlert.md index 336f130e0..1a24c021e 100644 --- a/docs/secretScanning/updateAlert.md +++ b/docs/secretScanning/updateAlert.md @@ -8,7 +8,9 @@ type: API method # Update a secret scanning alert -Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. +Updates the status of a secret scanning alert in an eligible repository. +To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. +For public repositories, you may instead use the `public_repo` scope. GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. @@ -34,9 +36,13 @@ octokit.rest.secretScanning.updateAlert({ owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + alert_numberyes @@ -50,7 +56,7 @@ Sets the state of the secret scanning alert. Can be either `open` or `resolved`. resolutionno -**Required when the `state` is `resolved`.** The reason for resolving the alert. Can be one of `false_positive`, `wont_fix`, `revoked`, or `used_in_tests`. +**Required when the `state` is `resolved`.** The reason for resolving the alert. diff --git a/docs/teams/addOrUpdateMembershipForUserInOrg.md b/docs/teams/addOrUpdateMembershipForUserInOrg.md index 16f7767d3..6f5565eeb 100644 --- a/docs/teams/addOrUpdateMembershipForUserInOrg.md +++ b/docs/teams/addOrUpdateMembershipForUserInOrg.md @@ -8,11 +8,11 @@ type: API method # Add or update team membership for a user -Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team. -**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." +**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. @@ -41,20 +41,22 @@ octokit.rest.teams.addOrUpdateMembershipForUserInOrg({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. usernameyes +The handle for the GitHub user account. + roleno -The role that this user should have in the team. Can be one of: -\* `member` - a normal member of the team. -\* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description. +The role that this user should have in the team. diff --git a/docs/teams/addOrUpdateProjectPermissionsInOrg.md b/docs/teams/addOrUpdateProjectPermissionsInOrg.md index 6b9e9a6a7..5e85a2297 100644 --- a/docs/teams/addOrUpdateProjectPermissionsInOrg.md +++ b/docs/teams/addOrUpdateProjectPermissionsInOrg.md @@ -33,22 +33,22 @@ octokit.rest.teams.addOrUpdateProjectPermissionsInOrg({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. project_idyes +The unique identifier of the project. + permissionno -The permission to grant to the team for this project. Can be one of: -\* `read` - team members can read, but not write to or administer this project. -\* `write` - team members can read and write, but not administer this project. -\* `admin` - team members can read, write and administer this project. -Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." +The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." diff --git a/docs/teams/addOrUpdateRepoPermissionsInOrg.md b/docs/teams/addOrUpdateRepoPermissionsInOrg.md index 1a84d8d6f..2508c90a7 100644 --- a/docs/teams/addOrUpdateRepoPermissionsInOrg.md +++ b/docs/teams/addOrUpdateRepoPermissionsInOrg.md @@ -12,7 +12,7 @@ To add a repository to a team or update the team's permission on a repository, t **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. -For more information about the permission levels, see "[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". +For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". ```js octokit.rest.teams.addOrUpdateRepoPermissionsInOrg({ @@ -36,28 +36,27 @@ octokit.rest.teams.addOrUpdateRepoPermissionsInOrg({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + permissionno -The permission to grant the team on this repository. Can be one of: -\* `pull` - team members can pull, but not push to or administer this repository. -\* `push` - team members can pull and push, but not administer this repository. -\* `admin` - team members can pull, push and administer this repository. -\* `maintain` - team members can manage the repository without access to sensitive or destructive actions. Recommended for project managers. Only applies to repositories owned by organizations. -\* `triage` - team members can proactively manage issues and pull requests without write access. Recommended for contributors who triage a repository. Only applies to repositories owned by organizations. - -If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. +The permission to grant the team on this repository. In addition to the enumerated values, you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. diff --git a/docs/teams/checkPermissionsForProjectInOrg.md b/docs/teams/checkPermissionsForProjectInOrg.md index 2dea447e7..72f88185e 100644 --- a/docs/teams/checkPermissionsForProjectInOrg.md +++ b/docs/teams/checkPermissionsForProjectInOrg.md @@ -33,14 +33,18 @@ octokit.rest.teams.checkPermissionsForProjectInOrg({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. project_idyes +The unique identifier of the project. + diff --git a/docs/teams/checkPermissionsForRepoInOrg.md b/docs/teams/checkPermissionsForRepoInOrg.md index 0c7a4282a..7bb3eb705 100644 --- a/docs/teams/checkPermissionsForRepoInOrg.md +++ b/docs/teams/checkPermissionsForRepoInOrg.md @@ -38,17 +38,23 @@ octokit.rest.teams.checkPermissionsForRepoInOrg({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/teams/create.md b/docs/teams/create.md index 5b0b7b77e..470bdafb8 100644 --- a/docs/teams/create.md +++ b/docs/teams/create.md @@ -8,9 +8,9 @@ type: API method # Create a team -To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://help.github.com/en/articles/setting-team-creation-permissions-in-your-organization)." +To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/en/articles/setting-team-creation-permissions-in-your-organization)." -When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)". +When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)". ```js octokit.rest.teams.create({ @@ -32,6 +32,8 @@ octokit.rest.teams.create({ orgyes +The organization name. The name is not case sensitive. + nameyes @@ -67,10 +69,7 @@ Default for child team: `closed` permissionno -**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: -\* `pull` - team members can pull, but not push to or administer newly-added repositories. -\* `push` - team members can pull and push, but not administer newly-added repositories. -\* `admin` - team members can pull, push and administer newly-added repositories. +**Deprecated**. The permission that new repositories will be added to the team with when none is specified. parent_team_idno diff --git a/docs/teams/createDiscussionCommentInOrg.md b/docs/teams/createDiscussionCommentInOrg.md index ff8985a1b..0a94a92ff 100644 --- a/docs/teams/createDiscussionCommentInOrg.md +++ b/docs/teams/createDiscussionCommentInOrg.md @@ -36,14 +36,18 @@ octokit.rest.teams.createDiscussionCommentInOrg({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. discussion_numberyes +The number that identifies the discussion. + bodyyes diff --git a/docs/teams/createDiscussionInOrg.md b/docs/teams/createDiscussionInOrg.md index d8c47408b..3aa386836 100644 --- a/docs/teams/createDiscussionInOrg.md +++ b/docs/teams/createDiscussionInOrg.md @@ -36,10 +36,12 @@ octokit.rest.teams.createDiscussionInOrg({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. titleyes diff --git a/docs/teams/deleteDiscussionCommentInOrg.md b/docs/teams/deleteDiscussionCommentInOrg.md index 03fb9e28b..af0b5a03a 100644 --- a/docs/teams/deleteDiscussionCommentInOrg.md +++ b/docs/teams/deleteDiscussionCommentInOrg.md @@ -34,17 +34,23 @@ octokit.rest.teams.deleteDiscussionCommentInOrg({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. discussion_numberyes +The number that identifies the discussion. + comment_numberyes +The number that identifies the comment. + diff --git a/docs/teams/deleteDiscussionInOrg.md b/docs/teams/deleteDiscussionInOrg.md index 50a291743..cfa611617 100644 --- a/docs/teams/deleteDiscussionInOrg.md +++ b/docs/teams/deleteDiscussionInOrg.md @@ -33,14 +33,18 @@ octokit.rest.teams.deleteDiscussionInOrg({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. discussion_numberyes +The number that identifies the discussion. + diff --git a/docs/teams/deleteInOrg.md b/docs/teams/deleteInOrg.md index e6f22e1be..ba6188b28 100644 --- a/docs/teams/deleteInOrg.md +++ b/docs/teams/deleteInOrg.md @@ -34,10 +34,12 @@ octokit.rest.teams.deleteInOrg({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. diff --git a/docs/teams/getByName.md b/docs/teams/getByName.md index 3845f6004..8f5db20cc 100644 --- a/docs/teams/getByName.md +++ b/docs/teams/getByName.md @@ -32,10 +32,12 @@ octokit.rest.teams.getByName({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. diff --git a/docs/teams/getDiscussionCommentInOrg.md b/docs/teams/getDiscussionCommentInOrg.md index 474a8128f..3051a7afe 100644 --- a/docs/teams/getDiscussionCommentInOrg.md +++ b/docs/teams/getDiscussionCommentInOrg.md @@ -34,17 +34,23 @@ octokit.rest.teams.getDiscussionCommentInOrg({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. discussion_numberyes +The number that identifies the discussion. + comment_numberyes +The number that identifies the comment. + diff --git a/docs/teams/getDiscussionInOrg.md b/docs/teams/getDiscussionInOrg.md index a8a077168..6960d8b49 100644 --- a/docs/teams/getDiscussionInOrg.md +++ b/docs/teams/getDiscussionInOrg.md @@ -33,14 +33,18 @@ octokit.rest.teams.getDiscussionInOrg({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. discussion_numberyes +The number that identifies the discussion. + diff --git a/docs/teams/getMembershipForUserInOrg.md b/docs/teams/getMembershipForUserInOrg.md index 34e123c14..63e1ce7c4 100644 --- a/docs/teams/getMembershipForUserInOrg.md +++ b/docs/teams/getMembershipForUserInOrg.md @@ -40,14 +40,18 @@ octokit.rest.teams.getMembershipForUserInOrg({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. usernameyes +The handle for the GitHub user account. + diff --git a/docs/teams/list.md b/docs/teams/list.md index 41067a153..842a8cf19 100644 --- a/docs/teams/list.md +++ b/docs/teams/list.md @@ -29,10 +29,12 @@ octokit.rest.teams.list({ orgyes +The organization name. The name is not case sensitive. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/teams/listChildInOrg.md b/docs/teams/listChildInOrg.md index 91407125a..055dea78e 100644 --- a/docs/teams/listChildInOrg.md +++ b/docs/teams/listChildInOrg.md @@ -32,15 +32,17 @@ octokit.rest.teams.listChildInOrg({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/teams/listDiscussionCommentsInOrg.md b/docs/teams/listDiscussionCommentsInOrg.md index 80505fe06..4ad381a05 100644 --- a/docs/teams/listDiscussionCommentsInOrg.md +++ b/docs/teams/listDiscussionCommentsInOrg.md @@ -33,23 +33,27 @@ octokit.rest.teams.listDiscussionCommentsInOrg({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. discussion_numberyes +The number that identifies the discussion. + directionno -One of `asc` (ascending) or `desc` (descending). +The direction to sort the results by. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/teams/listDiscussionsInOrg.md b/docs/teams/listDiscussionsInOrg.md index c8e0c7a6b..9127dd1e9 100644 --- a/docs/teams/listDiscussionsInOrg.md +++ b/docs/teams/listDiscussionsInOrg.md @@ -32,20 +32,22 @@ octokit.rest.teams.listDiscussionsInOrg({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. directionno -One of `asc` (ascending) or `desc` (descending). +The direction to sort the results by. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/teams/listForAuthenticatedUser.md b/docs/teams/listForAuthenticatedUser.md index a79163c37..42c0c886c 100644 --- a/docs/teams/listForAuthenticatedUser.md +++ b/docs/teams/listForAuthenticatedUser.md @@ -27,7 +27,7 @@ octokit.rest.teams.listForAuthenticatedUser(); per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/teams/listMembersInOrg.md b/docs/teams/listMembersInOrg.md index acc860eac..0cf8ae16b 100644 --- a/docs/teams/listMembersInOrg.md +++ b/docs/teams/listMembersInOrg.md @@ -32,23 +32,22 @@ octokit.rest.teams.listMembersInOrg({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. roleno -Filters members returned by their role in the team. Can be one of: -\* `member` - normal members of the team. -\* `maintainer` - team maintainers. -\* `all` - all members of the team. +Filters members returned by their role in the team. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/teams/listPendingInvitationsInOrg.md b/docs/teams/listPendingInvitationsInOrg.md index 5412f1f21..c65f8947c 100644 --- a/docs/teams/listPendingInvitationsInOrg.md +++ b/docs/teams/listPendingInvitationsInOrg.md @@ -32,15 +32,17 @@ octokit.rest.teams.listPendingInvitationsInOrg({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/teams/listProjectsInOrg.md b/docs/teams/listProjectsInOrg.md index 97e142191..69c355bf4 100644 --- a/docs/teams/listProjectsInOrg.md +++ b/docs/teams/listProjectsInOrg.md @@ -32,15 +32,17 @@ octokit.rest.teams.listProjectsInOrg({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/teams/listReposInOrg.md b/docs/teams/listReposInOrg.md index a47ccfdcb..3250ba415 100644 --- a/docs/teams/listReposInOrg.md +++ b/docs/teams/listReposInOrg.md @@ -32,15 +32,17 @@ octokit.rest.teams.listReposInOrg({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/teams/removeMembershipForUserInOrg.md b/docs/teams/removeMembershipForUserInOrg.md index 918059585..e7debfa3a 100644 --- a/docs/teams/removeMembershipForUserInOrg.md +++ b/docs/teams/removeMembershipForUserInOrg.md @@ -8,11 +8,11 @@ type: API method # Remove team membership for a user -Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. +Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. -**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." +**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. @@ -37,14 +37,18 @@ octokit.rest.teams.removeMembershipForUserInOrg({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. usernameyes +The handle for the GitHub user account. + diff --git a/docs/teams/removeProjectInOrg.md b/docs/teams/removeProjectInOrg.md index cce6dee4d..b836a84ca 100644 --- a/docs/teams/removeProjectInOrg.md +++ b/docs/teams/removeProjectInOrg.md @@ -33,14 +33,18 @@ octokit.rest.teams.removeProjectInOrg({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. project_idyes +The unique identifier of the project. + diff --git a/docs/teams/removeRepoInOrg.md b/docs/teams/removeRepoInOrg.md index eef694772..4b65970fa 100644 --- a/docs/teams/removeRepoInOrg.md +++ b/docs/teams/removeRepoInOrg.md @@ -34,17 +34,23 @@ octokit.rest.teams.removeRepoInOrg({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. owneryes +The account owner of the repository. The name is not case sensitive. + repoyes +The name of the repository. The name is not case sensitive. + diff --git a/docs/teams/updateDiscussionCommentInOrg.md b/docs/teams/updateDiscussionCommentInOrg.md index 082229985..ab73f3e5a 100644 --- a/docs/teams/updateDiscussionCommentInOrg.md +++ b/docs/teams/updateDiscussionCommentInOrg.md @@ -35,17 +35,23 @@ octokit.rest.teams.updateDiscussionCommentInOrg({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. discussion_numberyes +The number that identifies the discussion. + comment_numberyes +The number that identifies the comment. + bodyyes diff --git a/docs/teams/updateDiscussionInOrg.md b/docs/teams/updateDiscussionInOrg.md index 3ada8dbc1..46ba14743 100644 --- a/docs/teams/updateDiscussionInOrg.md +++ b/docs/teams/updateDiscussionInOrg.md @@ -33,14 +33,18 @@ octokit.rest.teams.updateDiscussionInOrg({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. discussion_numberyes +The number that identifies the discussion. + titleno diff --git a/docs/teams/updateInOrg.md b/docs/teams/updateInOrg.md index 8e094100d..708aeb61e 100644 --- a/docs/teams/updateInOrg.md +++ b/docs/teams/updateInOrg.md @@ -32,10 +32,12 @@ octokit.rest.teams.updateInOrg({ orgyes +The organization name. The name is not case sensitive. + team_slugyes -team_slug parameter +The slug of the team name. nameno @@ -60,10 +62,7 @@ The level of privacy this team should have. Editing teams without specifying thi permissionno -**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: -\* `pull` - team members can pull, but not push to or administer newly-added repositories. -\* `push` - team members can pull and push, but not administer newly-added repositories. -\* `admin` - team members can pull, push and administer newly-added repositories. +**Deprecated**. The permission that new repositories will be added to the team with when none is specified. parent_team_idno diff --git a/docs/users/block.md b/docs/users/block.md index 946f6100e..b5c48d0ad 100644 --- a/docs/users/block.md +++ b/docs/users/block.md @@ -27,6 +27,8 @@ octokit.rest.users.block({ usernameyes +The handle for the GitHub user account. + diff --git a/docs/users/checkBlocked.md b/docs/users/checkBlocked.md index 4a3751b14..fd6c5065d 100644 --- a/docs/users/checkBlocked.md +++ b/docs/users/checkBlocked.md @@ -27,6 +27,8 @@ octokit.rest.users.checkBlocked({ usernameyes +The handle for the GitHub user account. + diff --git a/docs/users/checkFollowingForUser.md b/docs/users/checkFollowingForUser.md index 7a4ec70ea..462410255 100644 --- a/docs/users/checkFollowingForUser.md +++ b/docs/users/checkFollowingForUser.md @@ -28,6 +28,8 @@ octokit.rest.users.checkFollowingForUser({ usernameyes +The handle for the GitHub user account. + target_useryes diff --git a/docs/users/checkPersonIsFollowedByAuthenticated.md b/docs/users/checkPersonIsFollowedByAuthenticated.md index 166042ec6..6660d89d9 100644 --- a/docs/users/checkPersonIsFollowedByAuthenticated.md +++ b/docs/users/checkPersonIsFollowedByAuthenticated.md @@ -27,6 +27,8 @@ octokit.rest.users.checkPersonIsFollowedByAuthenticated({ usernameyes +The handle for the GitHub user account. + diff --git a/docs/users/createGpgKeyForAuthenticated.md b/docs/users/createGpgKeyForAuthenticated.md index 9499214bd..4f2622be6 100644 --- a/docs/users/createGpgKeyForAuthenticated.md +++ b/docs/users/createGpgKeyForAuthenticated.md @@ -29,7 +29,12 @@ octokit.rest.users.createGpgKeyForAuthenticated({ - armored_public_keyyes + nameno + +A descriptive name for the new key. + + +armored_public_keyyes A GPG key in ASCII-armored format. diff --git a/docs/users/createGpgKeyForAuthenticatedUser.md b/docs/users/createGpgKeyForAuthenticatedUser.md index 083cd7f8c..767abfb30 100644 --- a/docs/users/createGpgKeyForAuthenticatedUser.md +++ b/docs/users/createGpgKeyForAuthenticatedUser.md @@ -27,7 +27,12 @@ octokit.rest.users.createGpgKeyForAuthenticatedUser({ - armored_public_keyyes + nameno + +A descriptive name for the new key. + + +armored_public_keyyes A GPG key in ASCII-armored format. diff --git a/docs/users/deleteGpgKeyForAuthenticated.md b/docs/users/deleteGpgKeyForAuthenticated.md index 4c15dc3a9..630db850e 100644 --- a/docs/users/deleteGpgKeyForAuthenticated.md +++ b/docs/users/deleteGpgKeyForAuthenticated.md @@ -31,7 +31,7 @@ octokit.rest.users.deleteGpgKeyForAuthenticated({ gpg_key_idyes -gpg_key_id parameter +The unique identifier of the GPG key. diff --git a/docs/users/deleteGpgKeyForAuthenticatedUser.md b/docs/users/deleteGpgKeyForAuthenticatedUser.md index 8ca3ed38f..3ee70efd8 100644 --- a/docs/users/deleteGpgKeyForAuthenticatedUser.md +++ b/docs/users/deleteGpgKeyForAuthenticatedUser.md @@ -29,7 +29,7 @@ octokit.rest.users.deleteGpgKeyForAuthenticatedUser({ gpg_key_idyes -gpg_key_id parameter +The unique identifier of the GPG key. diff --git a/docs/users/deletePublicSshKeyForAuthenticated.md b/docs/users/deletePublicSshKeyForAuthenticated.md index acd4a3e54..1100e4469 100644 --- a/docs/users/deletePublicSshKeyForAuthenticated.md +++ b/docs/users/deletePublicSshKeyForAuthenticated.md @@ -31,7 +31,7 @@ octokit.rest.users.deletePublicSshKeyForAuthenticated({ key_idyes -key_id parameter +The unique identifier of the key. diff --git a/docs/users/deletePublicSshKeyForAuthenticatedUser.md b/docs/users/deletePublicSshKeyForAuthenticatedUser.md index 5a48cc6e6..eeec96777 100644 --- a/docs/users/deletePublicSshKeyForAuthenticatedUser.md +++ b/docs/users/deletePublicSshKeyForAuthenticatedUser.md @@ -29,7 +29,7 @@ octokit.rest.users.deletePublicSshKeyForAuthenticatedUser({ key_idyes -key_id parameter +The unique identifier of the key. diff --git a/docs/users/follow.md b/docs/users/follow.md index aec667103..d38199354 100644 --- a/docs/users/follow.md +++ b/docs/users/follow.md @@ -31,6 +31,8 @@ octokit.rest.users.follow({ usernameyes +The handle for the GitHub user account. + diff --git a/docs/users/getByUsername.md b/docs/users/getByUsername.md index b54037162..d3816d05a 100644 --- a/docs/users/getByUsername.md +++ b/docs/users/getByUsername.md @@ -35,6 +35,8 @@ octokit.rest.users.getByUsername({ usernameyes +The handle for the GitHub user account. + diff --git a/docs/users/getContextForUser.md b/docs/users/getContextForUser.md index 60c228118..993888069 100644 --- a/docs/users/getContextForUser.md +++ b/docs/users/getContextForUser.md @@ -36,6 +36,8 @@ octokit.rest.users.getContextForUser({ usernameyes +The handle for the GitHub user account. + subject_typeno diff --git a/docs/users/getGpgKeyForAuthenticated.md b/docs/users/getGpgKeyForAuthenticated.md index 2874f6777..75c724f73 100644 --- a/docs/users/getGpgKeyForAuthenticated.md +++ b/docs/users/getGpgKeyForAuthenticated.md @@ -31,7 +31,7 @@ octokit.rest.users.getGpgKeyForAuthenticated({ gpg_key_idyes -gpg_key_id parameter +The unique identifier of the GPG key. diff --git a/docs/users/getGpgKeyForAuthenticatedUser.md b/docs/users/getGpgKeyForAuthenticatedUser.md index fba7c7824..745a41cce 100644 --- a/docs/users/getGpgKeyForAuthenticatedUser.md +++ b/docs/users/getGpgKeyForAuthenticatedUser.md @@ -29,7 +29,7 @@ octokit.rest.users.getGpgKeyForAuthenticatedUser({ gpg_key_idyes -gpg_key_id parameter +The unique identifier of the GPG key. diff --git a/docs/users/getPublicSshKeyForAuthenticated.md b/docs/users/getPublicSshKeyForAuthenticated.md index 1059f80bc..6a4617573 100644 --- a/docs/users/getPublicSshKeyForAuthenticated.md +++ b/docs/users/getPublicSshKeyForAuthenticated.md @@ -31,7 +31,7 @@ octokit.rest.users.getPublicSshKeyForAuthenticated({ key_idyes -key_id parameter +The unique identifier of the key. diff --git a/docs/users/getPublicSshKeyForAuthenticatedUser.md b/docs/users/getPublicSshKeyForAuthenticatedUser.md index 1d4fbc10a..76d0386ae 100644 --- a/docs/users/getPublicSshKeyForAuthenticatedUser.md +++ b/docs/users/getPublicSshKeyForAuthenticatedUser.md @@ -29,7 +29,7 @@ octokit.rest.users.getPublicSshKeyForAuthenticatedUser({ key_idyes -key_id parameter +The unique identifier of the key. diff --git a/docs/users/list.md b/docs/users/list.md index d4c50b5e2..64efb33dd 100644 --- a/docs/users/list.md +++ b/docs/users/list.md @@ -34,7 +34,7 @@ A user ID. Only return users with an ID greater than this ID. per_pageno -Results per page (max 100) +The number of results per page (max 100). diff --git a/docs/users/listEmailsForAuthenticated.md b/docs/users/listEmailsForAuthenticated.md index 627984273..783c39265 100644 --- a/docs/users/listEmailsForAuthenticated.md +++ b/docs/users/listEmailsForAuthenticated.md @@ -29,7 +29,7 @@ octokit.rest.users.listEmailsForAuthenticated(); per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/users/listEmailsForAuthenticatedUser.md b/docs/users/listEmailsForAuthenticatedUser.md index e8d1120e0..171ebee16 100644 --- a/docs/users/listEmailsForAuthenticatedUser.md +++ b/docs/users/listEmailsForAuthenticatedUser.md @@ -27,7 +27,7 @@ octokit.rest.users.listEmailsForAuthenticatedUser(); per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/users/listFollowedByAuthenticated.md b/docs/users/listFollowedByAuthenticated.md index 77c90e702..25a0099c6 100644 --- a/docs/users/listFollowedByAuthenticated.md +++ b/docs/users/listFollowedByAuthenticated.md @@ -29,7 +29,7 @@ octokit.rest.users.listFollowedByAuthenticated(); per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/users/listFollowedByAuthenticatedUser.md b/docs/users/listFollowedByAuthenticatedUser.md index af36edc8f..2a630952f 100644 --- a/docs/users/listFollowedByAuthenticatedUser.md +++ b/docs/users/listFollowedByAuthenticatedUser.md @@ -27,7 +27,7 @@ octokit.rest.users.listFollowedByAuthenticatedUser(); per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/users/listFollowersForAuthenticatedUser.md b/docs/users/listFollowersForAuthenticatedUser.md index 0b511cb4d..9c3ddd5e8 100644 --- a/docs/users/listFollowersForAuthenticatedUser.md +++ b/docs/users/listFollowersForAuthenticatedUser.md @@ -27,7 +27,7 @@ octokit.rest.users.listFollowersForAuthenticatedUser(); per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/users/listFollowersForUser.md b/docs/users/listFollowersForUser.md index ccfb577e3..bae2c478a 100644 --- a/docs/users/listFollowersForUser.md +++ b/docs/users/listFollowersForUser.md @@ -29,10 +29,12 @@ octokit.rest.users.listFollowersForUser({ usernameyes +The handle for the GitHub user account. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/users/listFollowingForUser.md b/docs/users/listFollowingForUser.md index 9286806dc..a93b5ade5 100644 --- a/docs/users/listFollowingForUser.md +++ b/docs/users/listFollowingForUser.md @@ -29,10 +29,12 @@ octokit.rest.users.listFollowingForUser({ usernameyes +The handle for the GitHub user account. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/users/listGpgKeysForAuthenticated.md b/docs/users/listGpgKeysForAuthenticated.md index 784a73b4a..4dd477325 100644 --- a/docs/users/listGpgKeysForAuthenticated.md +++ b/docs/users/listGpgKeysForAuthenticated.md @@ -29,7 +29,7 @@ octokit.rest.users.listGpgKeysForAuthenticated(); per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/users/listGpgKeysForAuthenticatedUser.md b/docs/users/listGpgKeysForAuthenticatedUser.md index 2db81898c..6df89f258 100644 --- a/docs/users/listGpgKeysForAuthenticatedUser.md +++ b/docs/users/listGpgKeysForAuthenticatedUser.md @@ -27,7 +27,7 @@ octokit.rest.users.listGpgKeysForAuthenticatedUser(); per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/users/listGpgKeysForUser.md b/docs/users/listGpgKeysForUser.md index d4e1f4a18..be199478b 100644 --- a/docs/users/listGpgKeysForUser.md +++ b/docs/users/listGpgKeysForUser.md @@ -29,10 +29,12 @@ octokit.rest.users.listGpgKeysForUser({ usernameyes +The handle for the GitHub user account. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/users/listPublicEmailsForAuthenticated.md b/docs/users/listPublicEmailsForAuthenticated.md index 91dbb8b1b..52f8ad537 100644 --- a/docs/users/listPublicEmailsForAuthenticated.md +++ b/docs/users/listPublicEmailsForAuthenticated.md @@ -29,7 +29,7 @@ octokit.rest.users.listPublicEmailsForAuthenticated(); per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/users/listPublicEmailsForAuthenticatedUser.md b/docs/users/listPublicEmailsForAuthenticatedUser.md index 1da066154..a234c1caf 100644 --- a/docs/users/listPublicEmailsForAuthenticatedUser.md +++ b/docs/users/listPublicEmailsForAuthenticatedUser.md @@ -27,7 +27,7 @@ octokit.rest.users.listPublicEmailsForAuthenticatedUser(); per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/users/listPublicKeysForUser.md b/docs/users/listPublicKeysForUser.md index 045451bbe..f656579e3 100644 --- a/docs/users/listPublicKeysForUser.md +++ b/docs/users/listPublicKeysForUser.md @@ -29,10 +29,12 @@ octokit.rest.users.listPublicKeysForUser({ usernameyes +The handle for the GitHub user account. + per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/users/listPublicSshKeysForAuthenticated.md b/docs/users/listPublicSshKeysForAuthenticated.md index d76a38cd9..e5c723260 100644 --- a/docs/users/listPublicSshKeysForAuthenticated.md +++ b/docs/users/listPublicSshKeysForAuthenticated.md @@ -29,7 +29,7 @@ octokit.rest.users.listPublicSshKeysForAuthenticated(); per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/users/listPublicSshKeysForAuthenticatedUser.md b/docs/users/listPublicSshKeysForAuthenticatedUser.md index 2d386849f..54ddf04a7 100644 --- a/docs/users/listPublicSshKeysForAuthenticatedUser.md +++ b/docs/users/listPublicSshKeysForAuthenticatedUser.md @@ -27,7 +27,7 @@ octokit.rest.users.listPublicSshKeysForAuthenticatedUser(); per_pageno -Results per page (max 100) +The number of results per page (max 100). pageno diff --git a/docs/users/unblock.md b/docs/users/unblock.md index 64e5f24f0..b05ba0445 100644 --- a/docs/users/unblock.md +++ b/docs/users/unblock.md @@ -27,6 +27,8 @@ octokit.rest.users.unblock({ usernameyes +The handle for the GitHub user account. + diff --git a/docs/users/unfollow.md b/docs/users/unfollow.md index d63507fe8..45a7fae47 100644 --- a/docs/users/unfollow.md +++ b/docs/users/unfollow.md @@ -29,6 +29,8 @@ octokit.rest.users.unfollow({ usernameyes +The handle for the GitHub user account. + diff --git a/package-lock.json b/package-lock.json index b0a7b65f3..e3761f269 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,7 +9,7 @@ "version": "0.0.0-development", "license": "MIT", "dependencies": { - "@octokit/types": "^6.34.0", + "@octokit/types": "^6.35.0", "deprecation": "^2.3.1" }, "devDependencies": { @@ -2515,9 +2515,9 @@ } }, "node_modules/@octokit/openapi-types": { - "version": "11.2.0", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-11.2.0.tgz", - "integrity": "sha512-PBsVO+15KSlGmiI8QAzaqvsNlZlrDlyAJYcrXBCvVUxCp7VnXjkwPoFHgjEJXx3WF9BAwkA6nfCUA7i9sODzKA==" + "version": "12.1.0", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-12.1.0.tgz", + "integrity": "sha512-kQzJh3ZUv3lDpi6M+uekMRHULvf9DlWoI1XgKN6nPeGDzkSgtkhVq1MMz3bFKQ6H6GbdC3ZqG/a6VzKhIx0VeA==" }, "node_modules/@octokit/plugin-paginate-rest": { "version": "2.16.7", @@ -2591,11 +2591,11 @@ } }, "node_modules/@octokit/types": { - "version": "6.34.0", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-6.34.0.tgz", - "integrity": "sha512-s1zLBjWhdEI2zwaoSgyOFoKSl109CUcVBCc7biPJ3aAf6LGLU6szDvi31JPU7bxfla2lqfhjbbg/5DdFNxOwHw==", + "version": "6.35.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-6.35.0.tgz", + "integrity": "sha512-DhLfdUuv3H37u6jBDfkwamypx3HflHg29b26nbA6iVFYkAlZ5cMEtu/9pQoihGnQE5M7jJFnNo25Rr1UwQNF8Q==", "dependencies": { - "@octokit/openapi-types": "^11.2.0" + "@octokit/openapi-types": "^12.1.0" } }, "node_modules/@pika/babel-plugin-esm-import-rewrite": { @@ -4083,14 +4083,20 @@ } }, "node_modules/caniuse-lite": { - "version": "1.0.30001264", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001264.tgz", - "integrity": "sha512-Ftfqqfcs/ePiUmyaySsQ4PUsdcYyXG2rfoBVsk3iY1ahHaJEw65vfb7Suzqm+cEkwwPIv/XWkg27iCpRavH4zA==", + "version": "1.0.30001352", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001352.tgz", + "integrity": "sha512-GUgH8w6YergqPQDGWhJGt8GDRnY0L/iJVQcU3eJ46GYf52R8tk0Wxp0PymuFVZboJYXGiCqwozAYZNRjVj6IcA==", "dev": true, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/browserslist" - } + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/caniuse-lite" + } + ] }, "node_modules/cardinal": { "version": "2.1.1", @@ -18972,9 +18978,9 @@ } }, "@octokit/openapi-types": { - "version": "11.2.0", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-11.2.0.tgz", - "integrity": "sha512-PBsVO+15KSlGmiI8QAzaqvsNlZlrDlyAJYcrXBCvVUxCp7VnXjkwPoFHgjEJXx3WF9BAwkA6nfCUA7i9sODzKA==" + "version": "12.1.0", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-12.1.0.tgz", + "integrity": "sha512-kQzJh3ZUv3lDpi6M+uekMRHULvf9DlWoI1XgKN6nPeGDzkSgtkhVq1MMz3bFKQ6H6GbdC3ZqG/a6VzKhIx0VeA==" }, "@octokit/plugin-paginate-rest": { "version": "2.16.7", @@ -19040,11 +19046,11 @@ } }, "@octokit/types": { - "version": "6.34.0", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-6.34.0.tgz", - "integrity": "sha512-s1zLBjWhdEI2zwaoSgyOFoKSl109CUcVBCc7biPJ3aAf6LGLU6szDvi31JPU7bxfla2lqfhjbbg/5DdFNxOwHw==", + "version": "6.35.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-6.35.0.tgz", + "integrity": "sha512-DhLfdUuv3H37u6jBDfkwamypx3HflHg29b26nbA6iVFYkAlZ5cMEtu/9pQoihGnQE5M7jJFnNo25Rr1UwQNF8Q==", "requires": { - "@octokit/openapi-types": "^11.2.0" + "@octokit/openapi-types": "^12.1.0" } }, "@pika/babel-plugin-esm-import-rewrite": { @@ -20246,9 +20252,9 @@ } }, "caniuse-lite": { - "version": "1.0.30001264", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001264.tgz", - "integrity": "sha512-Ftfqqfcs/ePiUmyaySsQ4PUsdcYyXG2rfoBVsk3iY1ahHaJEw65vfb7Suzqm+cEkwwPIv/XWkg27iCpRavH4zA==", + "version": "1.0.30001352", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001352.tgz", + "integrity": "sha512-GUgH8w6YergqPQDGWhJGt8GDRnY0L/iJVQcU3eJ46GYf52R8tk0Wxp0PymuFVZboJYXGiCqwozAYZNRjVj6IcA==", "dev": true }, "cardinal": { diff --git a/package.json b/package.json index 8fcc4fda9..74936abf4 100644 --- a/package.json +++ b/package.json @@ -24,7 +24,7 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "dependencies": { - "@octokit/types": "^6.34.0", + "@octokit/types": "^6.35.0", "deprecation": "^2.3.1" }, "devDependencies": { diff --git a/scripts/update-endpoints/generated/endpoints.json b/scripts/update-endpoints/generated/endpoints.json index 2e4797ec7..3e509beaa 100644 --- a/scripts/update-endpoints/generated/endpoints.json +++ b/scripts/update-endpoints/generated/endpoints.json @@ -1,4 +1,155 @@ [ + { + "name": "Add custom labels to a self-hosted runner for an organization", + "scope": "actions", + "id": "addCustomLabelsToSelfHostedRunnerForOrg", + "method": "POST", + "url": "/orgs/{org}/actions/runners/{runner_id}/labels", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Add custom labels to a self-hosted runner configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "labels", + "description": "The names of the custom labels to add to the runner.", + "in": "BODY", + "type": "string[]", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_count\":4,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" + } + ] + }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 422, "description": "Validation failed", "examples": null } + ], + "renamed": null + }, + { + "name": "Add custom labels to a self-hosted runner for a repository", + "scope": "actions", + "id": "addCustomLabelsToSelfHostedRunnerForRepo", + "method": "POST", + "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Add custom labels to a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-a-repository", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "labels", + "description": "The names of the custom labels to add to the runner.", + "in": "BODY", + "type": "string[]", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_count\":4,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" + } + ] + }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 422, "description": "Validation failed", "examples": null } + ], + "renamed": null + }, { "name": "Add selected repository to an organization secret", "scope": "actions", @@ -15,7 +166,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -28,7 +179,7 @@ }, { "name": "secret_name", - "description": "secret_name parameter", + "description": "The name of the secret.", "in": "PATH", "type": "string", "required": true, @@ -83,7 +234,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -96,7 +247,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -109,7 +260,7 @@ }, { "name": "run_id", - "description": "The id of the workflow run.", + "description": "The unique identifier of the workflow run.", "in": "PATH", "type": "integer", "required": true, @@ -144,7 +295,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -157,7 +308,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -170,7 +321,7 @@ }, { "name": "run_id", - "description": "The id of the workflow run.", + "description": "The unique identifier of the workflow run.", "in": "PATH", "type": "integer", "required": true, @@ -182,7 +333,10 @@ "deprecated": null } ], - "responses": [{ "code": 202, "description": "Response", "examples": null }], + "responses": [ + { "code": 202, "description": "Response", "examples": null }, + { "code": 409, "description": "Conflict", "examples": null } + ], "renamed": null }, { @@ -194,14 +348,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", + "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", "documentationUrl": "https://docs.github.com/rest/reference/actions#create-or-update-an-environment-secret", "previews": [], "headers": [], "parameters": [ { "name": "repository_id", - "description": "", + "description": "The unique identifier of the repository.", "in": "PATH", "type": "integer", "required": true, @@ -227,7 +381,7 @@ }, { "name": "secret_name", - "description": "secret_name parameter", + "description": "The name of the secret.", "in": "PATH", "type": "string", "required": true, @@ -288,14 +442,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to\nuse this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", + "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to\nuse this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", "documentationUrl": "https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret", "previews": [], "headers": [], "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -308,7 +462,7 @@ }, { "name": "secret_name", - "description": "secret_name parameter", + "description": "The name of the secret.", "in": "PATH", "type": "string", "required": true, @@ -347,7 +501,7 @@ }, { "name": "visibility", - "description": "Configures the access that repositories have to the organization secret. Can be one of: \n\\- `all` - All repositories in an organization can access the secret. \n\\- `private` - Private repositories in an organization can access the secret. \n\\- `selected` - Only specific repositories can access the secret.", + "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", "in": "BODY", "type": "string", "required": true, @@ -395,14 +549,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", + "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", "documentationUrl": "https://docs.github.com/rest/reference/actions#create-or-update-a-repository-secret", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -415,7 +569,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -428,7 +582,7 @@ }, { "name": "secret_name", - "description": "secret_name parameter", + "description": "The name of the secret.", "in": "PATH", "type": "string", "required": true, @@ -496,7 +650,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -537,7 +691,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -550,7 +704,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -591,7 +745,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -632,7 +786,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -645,7 +799,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -679,14 +833,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see \"[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see \"[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line).\"", + "description": "You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see \"[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see \"[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line).\"", "documentationUrl": "https://docs.github.com/rest/reference/actions#create-a-workflow-dispatch-event", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -699,7 +853,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -782,7 +936,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -795,7 +949,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -808,7 +962,7 @@ }, { "name": "artifact_id", - "description": "artifact_id parameter", + "description": "The unique identifier of the artifact.", "in": "PATH", "type": "integer", "required": true, @@ -839,7 +993,7 @@ "parameters": [ { "name": "repository_id", - "description": "", + "description": "The unique identifier of the repository.", "in": "PATH", "type": "integer", "required": true, @@ -865,7 +1019,7 @@ }, { "name": "secret_name", - "description": "secret_name parameter", + "description": "The name of the secret.", "in": "PATH", "type": "string", "required": true, @@ -898,7 +1052,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -911,7 +1065,7 @@ }, { "name": "secret_name", - "description": "secret_name parameter", + "description": "The name of the secret.", "in": "PATH", "type": "string", "required": true, @@ -942,7 +1096,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -955,7 +1109,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -968,7 +1122,7 @@ }, { "name": "secret_name", - "description": "secret_name parameter", + "description": "The name of the secret.", "in": "PATH", "type": "string", "required": true, @@ -999,7 +1153,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -1043,7 +1197,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -1056,7 +1210,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -1100,7 +1254,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -1113,7 +1267,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -1126,7 +1280,7 @@ }, { "name": "run_id", - "description": "The id of the workflow run.", + "description": "The unique identifier of the workflow run.", "in": "PATH", "type": "integer", "required": true, @@ -1157,7 +1311,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -1170,7 +1324,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -1183,7 +1337,7 @@ }, { "name": "run_id", - "description": "The id of the workflow run.", + "description": "The unique identifier of the workflow run.", "in": "PATH", "type": "integer", "required": true, @@ -1195,7 +1349,11 @@ "deprecated": null } ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], + "responses": [ + { "code": 204, "description": "Response", "examples": null }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 500, "description": "Internal Error", "examples": null } + ], "renamed": null }, { @@ -1214,7 +1372,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -1227,7 +1385,7 @@ }, { "name": "repository_id", - "description": "", + "description": "The unique identifier of the repository.", "in": "PATH", "type": "integer", "required": true, @@ -1258,7 +1416,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -1271,7 +1429,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -1315,7 +1473,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -1328,7 +1486,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -1341,7 +1499,7 @@ }, { "name": "artifact_id", - "description": "artifact_id parameter", + "description": "The unique identifier of the artifact.", "in": "PATH", "type": "integer", "required": true, @@ -1385,7 +1543,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -1398,7 +1556,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -1411,7 +1569,7 @@ }, { "name": "job_id", - "description": "job_id parameter", + "description": "The unique identifier of the job.", "in": "PATH", "type": "integer", "required": true, @@ -1442,7 +1600,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -1455,7 +1613,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -1468,7 +1626,7 @@ }, { "name": "run_id", - "description": "The id of the workflow run.", + "description": "The unique identifier of the workflow run.", "in": "PATH", "type": "integer", "required": true, @@ -1512,7 +1670,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -1525,7 +1683,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -1538,7 +1696,7 @@ }, { "name": "run_id", - "description": "The id of the workflow run.", + "description": "The unique identifier of the workflow run.", "in": "PATH", "type": "integer", "required": true, @@ -1569,7 +1727,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -1582,7 +1740,7 @@ }, { "name": "repository_id", - "description": "", + "description": "The unique identifier of the repository.", "in": "PATH", "type": "integer", "required": true, @@ -1613,7 +1771,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -1626,7 +1784,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -1655,63 +1813,22 @@ "renamed": null }, { - "name": "Get allowed actions for an organization", + "name": "Get GitHub Actions cache usage for a repository", "scope": "actions", - "id": "getAllowedActionsOrganization", + "id": "getActionsCacheUsage", "method": "GET", - "url": "/orgs/{org}/actions/permissions/selected-actions", + "url": "/repos/{owner}/{repo}/actions/cache/usage", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#get-allowed-actions-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"github_owned_allowed\":true,\"verified_allowed\":false,\"patterns_allowed\":[\"monalisa/octocat@*\",\"docker/*\"]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get allowed actions for a repository", - "scope": "actions", - "id": "getAllowedActionsRepository", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/permissions/selected-actions", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#get-allowed-actions-for-a-repository", + "description": "Gets GitHub Actions cache usage for a repository.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#get-github-actions-cache-usage-for-a-repository", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -1724,7 +1841,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -1742,7 +1859,7 @@ "description": "Response", "examples": [ { - "data": "{\"github_owned_allowed\":true,\"verified_allowed\":false,\"patterns_allowed\":[\"monalisa/octocat@*\",\"docker/*\"]}" + "data": "{\"full_name\":\"octo-org/Hello-World\",\"active_caches_size_in_bytes\":2322142,\"active_caches_count\":3}" } ] } @@ -1750,22 +1867,22 @@ "renamed": null }, { - "name": "Get an artifact", + "name": "List repositories with GitHub Actions cache usage for an organization", "scope": "actions", - "id": "getArtifact", + "id": "getActionsCacheUsageByRepoForOrg", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", + "url": "/orgs/{org}/actions/cache/usage-by-repository", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#get-an-artifact", + "description": "Lists repositories and their GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\nYou must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#list-repositories-with-github-actions-cache-usage-for-an-organization", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -1777,11 +1894,11 @@ "deprecated": null }, { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -1790,11 +1907,11 @@ "deprecated": null }, { - "name": "artifact_id", - "description": "artifact_id parameter", - "in": "PATH", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", "type": "integer", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -1809,7 +1926,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":11,\"node_id\":\"MDg6QXJ0aWZhY3QxMQ==\",\"name\":\"Rails\",\"size_in_bytes\":556,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-01-21T14:59:22Z\",\"updated_at\":\"2020-01-21T14:59:22Z\"}" + "data": "{\"total_count\":2,\"repository_cache_usages\":[{\"full_name\":\"octo-org/Hello-World\",\"active_caches_size_in_bytes\":2322142,\"active_caches_count\":3},{\"full_name\":\"octo-org/server\",\"active_caches_size_in_bytes\":1022142,\"active_caches_count\":2}]}" } ] } @@ -1817,24 +1934,24 @@ "renamed": null }, { - "name": "Get an environment public key", + "name": "Get GitHub Actions cache usage for an enterprise", "scope": "actions", - "id": "getEnvironmentPublicKey", + "id": "getActionsCacheUsageForEnterprise", "method": "GET", - "url": "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key", + "url": "/enterprises/{enterprise}/actions/cache/usage", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#get-an-environment-public-key", + "description": "Gets the total GitHub Actions cache usage for an enterprise.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#get-github-actions-cache-usage-for-an-enterprise", "previews": [], "headers": [], "parameters": [ { - "name": "repository_id", - "description": "", + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -1842,10 +1959,38 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "environment_name", - "description": "The name of the environment", + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_active_caches_size_in_bytes\":3344284,\"total_active_caches_count\":5}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Get GitHub Actions cache usage for an organization", + "scope": "actions", + "id": "getActionsCacheUsageForOrg", + "method": "GET", + "url": "/orgs/{org}/actions/cache/usage", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\nYou must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#get-github-actions-cache-usage-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -1863,7 +2008,7 @@ "description": "Response", "examples": [ { - "data": "{\"key_id\":\"012345678912345678\",\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\"}" + "data": "{\"total_active_caches_size_in_bytes\":3344284,\"total_active_caches_count\":5}" } ] } @@ -1871,24 +2016,24 @@ "renamed": null }, { - "name": "Get an environment secret", + "name": "Get allowed actions and reusable workflows for an organization", "scope": "actions", - "id": "getEnvironmentSecret", + "id": "getAllowedActionsOrganization", "method": "GET", - "url": "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", + "url": "/orgs/{org}/actions/permissions/selected-actions", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#get-an-environment-secret", + "description": "Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#get-allowed-actions-for-an-organization", "previews": [], "headers": [], "parameters": [ { - "name": "repository_id", - "description": "", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -1896,10 +2041,38 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "environment_name", - "description": "The name of the environment", + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"github_owned_allowed\":true,\"verified_allowed\":false,\"patterns_allowed\":[\"monalisa/octocat@*\",\"docker/*\"]}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Get allowed actions and reusable workflows for a repository", + "scope": "actions", + "id": "getAllowedActionsRepository", + "method": "GET", + "url": "/repos/{owner}/{repo}/actions/permissions/selected-actions", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#get-allowed-actions-for-a-repository", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -1911,8 +2084,8 @@ "deprecated": null }, { - "name": "secret_name", - "description": "secret_name parameter", + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -1930,7 +2103,7 @@ "description": "Response", "examples": [ { - "data": "{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"}" + "data": "{\"github_owned_allowed\":true,\"verified_allowed\":false,\"patterns_allowed\":[\"monalisa/octocat@*\",\"docker/*\"]}" } ] } @@ -1938,22 +2111,35 @@ "renamed": null }, { - "name": "Get GitHub Actions permissions for an organization", + "name": "Get an artifact", "scope": "actions", - "id": "getGithubActionsPermissionsOrganization", + "id": "getArtifact", "method": "GET", - "url": "/orgs/{org}/actions/permissions", + "url": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#get-github-actions-permissions-for-an-organization", + "description": "Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#get-an-artifact", "previews": [], "headers": [], "parameters": [ { - "name": "org", - "description": "", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -1963,6 +2149,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "artifact_id", + "description": "The unique identifier of the artifact.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -1971,7 +2170,7 @@ "description": "Response", "examples": [ { - "data": "{\"enabled_repositories\":\"all\",\"allowed_actions\":\"selected\",\"selected_actions_url\":\"https://api.github.com/organizations/42/actions/permissions/selected-actions\"}" + "data": "{\"id\":11,\"node_id\":\"MDg6QXJ0aWZhY3QxMQ==\",\"name\":\"Rails\",\"size_in_bytes\":556,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-01-21T14:59:22Z\",\"updated_at\":\"2020-01-21T14:59:22Z\",\"workflow_run\":{\"id\":2332938,\"repository_id\":1296269,\"head_repository_id\":1296269,\"head_branch\":\"main\",\"head_sha\":\"328faa0536e6fef19753d9d91dc96a9931694ce3\"}}" } ] } @@ -1979,24 +2178,24 @@ "renamed": null }, { - "name": "Get GitHub Actions permissions for a repository", + "name": "Get an environment public key", "scope": "actions", - "id": "getGithubActionsPermissionsRepository", + "id": "getEnvironmentPublicKey", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/permissions", + "url": "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint. GitHub Apps must have the `administration` repository permission to use this API.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#get-github-actions-permissions-for-a-repository", + "description": "Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#get-an-environment-public-key", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "", + "name": "repository_id", + "description": "The unique identifier of the repository.", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -2006,8 +2205,8 @@ "deprecated": null }, { - "name": "repo", - "description": "", + "name": "environment_name", + "description": "The name of the environment", "in": "PATH", "type": "string", "required": true, @@ -2025,7 +2224,7 @@ "description": "Response", "examples": [ { - "data": "{\"enabled\":true,\"allowed_actions\":\"selected\",\"selected_actions_url\":\"https://api.github.com/repositories/42/actions/permissions/selected-actions\"}" + "data": "{\"key_id\":\"012345678912345678\",\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\"}" } ] } @@ -2033,24 +2232,24 @@ "renamed": null }, { - "name": "Get a job for a workflow run", + "name": "Get an environment secret", "scope": "actions", - "id": "getJobForWorkflowRun", + "id": "getEnvironmentSecret", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/jobs/{job_id}", + "url": "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-job-for-a-workflow-run", + "description": "Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#get-an-environment-secret", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "", + "name": "repository_id", + "description": "The unique identifier of the repository.", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -2060,8 +2259,8 @@ "deprecated": null }, { - "name": "repo", - "description": "", + "name": "environment_name", + "description": "The name of the environment", "in": "PATH", "type": "string", "required": true, @@ -2073,10 +2272,10 @@ "deprecated": null }, { - "name": "job_id", - "description": "job_id parameter", + "name": "secret_name", + "description": "The name of the secret.", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -2092,7 +2291,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":399444496,\"run_id\":29679449,\"run_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\"node_id\":\"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\"head_sha\":\"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\"html_url\":\"https://github.com/octo-org/octo-repo/runs/399444496\",\"status\":\"completed\",\"conclusion\":\"success\",\"started_at\":\"2020-01-20T17:42:40Z\",\"completed_at\":\"2020-01-20T17:44:39Z\",\"name\":\"build\",\"steps\":[{\"name\":\"Set up job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":1,\"started_at\":\"2020-01-20T09:42:40.000-08:00\",\"completed_at\":\"2020-01-20T09:42:41.000-08:00\"},{\"name\":\"Run actions/checkout@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":2,\"started_at\":\"2020-01-20T09:42:41.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Set up Ruby\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":3,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Run actions/cache@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":4,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:48.000-08:00\"},{\"name\":\"Install Bundler\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":5,\"started_at\":\"2020-01-20T09:42:48.000-08:00\",\"completed_at\":\"2020-01-20T09:42:52.000-08:00\"},{\"name\":\"Install Gems\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":6,\"started_at\":\"2020-01-20T09:42:52.000-08:00\",\"completed_at\":\"2020-01-20T09:42:53.000-08:00\"},{\"name\":\"Run Tests\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":7,\"started_at\":\"2020-01-20T09:42:53.000-08:00\",\"completed_at\":\"2020-01-20T09:42:59.000-08:00\"},{\"name\":\"Deploy to Heroku\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":8,\"started_at\":\"2020-01-20T09:42:59.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Post actions/cache@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":16,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Complete job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":17,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"}],\"check_run_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\",\"labels\":[\"self-hosted\",\"foo\",\"bar\"],\"runner_id\":1,\"runner_name\":\"my runner\",\"runner_group_id\":2,\"runner_group_name\":\"my runner group\"}" + "data": "{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"}" } ] } @@ -2100,22 +2299,22 @@ "renamed": null }, { - "name": "Get an organization public key", + "name": "Get default workflow permissions for an enterprise", "scope": "actions", - "id": "getOrgPublicKey", + "id": "getGithubActionsDefaultWorkflowPermissionsEnterprise", "method": "GET", - "url": "/orgs/{org}/actions/secrets/public-key", + "url": "/enterprises/{enterprise}/actions/permissions/workflow", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#get-an-organization-public-key", + "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\nGitHub Apps must have the `enterprise_administration:write` permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#get-default-workflow-permissions-for-an-enterprise", "previews": [], "headers": [], "parameters": [ { - "name": "org", - "description": "", + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "PATH", "type": "string", "required": true, @@ -2130,10 +2329,10 @@ "responses": [ { "code": 200, - "description": "Response", + "description": "Success response", "examples": [ { - "data": "{\"key_id\":\"012345678912345678\",\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\"}" + "data": "{\"default_workflow_permissions\":\"read\",\"can_approve_pull_request_reviews\":true}" } ] } @@ -2141,35 +2340,22 @@ "renamed": null }, { - "name": "Get an organization secret", + "name": "Get default workflow permissions for an organization", "scope": "actions", - "id": "getOrgSecret", + "id": "getGithubActionsDefaultWorkflowPermissionsOrganization", "method": "GET", - "url": "/orgs/{org}/actions/secrets/{secret_name}", + "url": "/orgs/{org}/actions/permissions/workflow", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#get-an-organization-secret", + "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#get-default-workflow-permissions", "previews": [], "headers": [], "parameters": [ { "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "secret_name parameter", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -2187,7 +2373,7 @@ "description": "Response", "examples": [ { - "data": "{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"selected\",\"selected_repositories_url\":\"https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories\"}" + "data": "{\"default_workflow_permissions\":\"read\",\"can_approve_pull_request_reviews\":true}" } ] } @@ -2195,22 +2381,22 @@ "renamed": null }, { - "name": "Get pending deployments for a workflow run", + "name": "Get default workflow permissions for a repository", "scope": "actions", - "id": "getPendingDeploymentsForRun", + "id": "getGithubActionsDefaultWorkflowPermissionsRepository", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", + "url": "/repos/{owner}/{repo}/actions/permissions/workflow", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Get all deployment environments for a workflow run that are waiting for protection rules to pass.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#get-pending-deployments-for-a-workflow-run", + "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#get-default-workflow-permissions-for-a-repository", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -2223,7 +2409,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -2233,12 +2419,40 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "run_id", - "description": "The id of the workflow run.", + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"default_workflow_permissions\":\"read\",\"can_approve_pull_request_reviews\":true}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Get GitHub Actions permissions for an organization", + "scope": "actions", + "id": "getGithubActionsPermissionsOrganization", + "method": "GET", + "url": "/orgs/{org}/actions/permissions", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#get-github-actions-permissions-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -2254,7 +2468,7 @@ "description": "Response", "examples": [ { - "data": "[{\"environment\":{\"id\":161088068,\"node_id\":\"MDExOkVudmlyb25tZW50MTYxMDg4MDY4\",\"name\":\"staging\",\"url\":\"https://api.github.com/repos/github/hello-world/environments/staging\",\"html_url\":\"https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging\"},\"wait_timer\":30,\"wait_timer_started_at\":\"2020-11-23T22:00:40Z\",\"current_user_can_approve\":true,\"reviewers\":[{\"type\":\"User\",\"reviewer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}},{\"type\":\"Team\",\"reviewer\":{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}}]}]" + "data": "{\"enabled_repositories\":\"all\",\"allowed_actions\":\"selected\",\"selected_actions_url\":\"https://api.github.com/organizations/42/actions/permissions/selected-actions\"}" } ] } @@ -2264,20 +2478,20 @@ { "name": "Get GitHub Actions permissions for a repository", "scope": "actions", - "id": "getRepoPermissions", + "id": "getGithubActionsPermissionsRepository", "method": "GET", "url": "/repos/{owner}/{repo}/actions/permissions", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", "documentationUrl": "https://docs.github.com/rest/reference/actions#get-github-actions-permissions-for-a-repository", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -2290,7 +2504,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -2313,33 +2527,25 @@ ] } ], - "renamed": { - "before": { "scope": "actions", "id": "getRepoPermissions" }, - "after": { - "scope": "actions", - "id": "getGithubActionsPermissionsRepository" - }, - "date": "2020-11-10", - "note": null - } + "renamed": null }, { - "name": "Get a repository public key", + "name": "Get a job for a workflow run", "scope": "actions", - "id": "getRepoPublicKey", + "id": "getJobForWorkflowRun", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/secrets/public-key", + "url": "/repos/{owner}/{repo}/actions/jobs/{job_id}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-repository-public-key", + "description": "Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-job-for-a-workflow-run", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -2352,7 +2558,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -2362,6 +2568,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "job_id", + "description": "The unique identifier of the job.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -2370,7 +2589,7 @@ "description": "Response", "examples": [ { - "data": "{\"key_id\":\"012345678912345678\",\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\"}" + "data": "{\"id\":399444496,\"run_id\":29679449,\"run_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\"node_id\":\"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\"head_sha\":\"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\"html_url\":\"https://github.com/octo-org/octo-repo/runs/399444496\",\"status\":\"completed\",\"conclusion\":\"success\",\"started_at\":\"2020-01-20T17:42:40Z\",\"completed_at\":\"2020-01-20T17:44:39Z\",\"name\":\"build\",\"steps\":[{\"name\":\"Set up job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":1,\"started_at\":\"2020-01-20T09:42:40.000-08:00\",\"completed_at\":\"2020-01-20T09:42:41.000-08:00\"},{\"name\":\"Run actions/checkout@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":2,\"started_at\":\"2020-01-20T09:42:41.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Set up Ruby\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":3,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Run actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":4,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:48.000-08:00\"},{\"name\":\"Install Bundler\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":5,\"started_at\":\"2020-01-20T09:42:48.000-08:00\",\"completed_at\":\"2020-01-20T09:42:52.000-08:00\"},{\"name\":\"Install Gems\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":6,\"started_at\":\"2020-01-20T09:42:52.000-08:00\",\"completed_at\":\"2020-01-20T09:42:53.000-08:00\"},{\"name\":\"Run Tests\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":7,\"started_at\":\"2020-01-20T09:42:53.000-08:00\",\"completed_at\":\"2020-01-20T09:42:59.000-08:00\"},{\"name\":\"Deploy to Heroku\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":8,\"started_at\":\"2020-01-20T09:42:59.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Post actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":16,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Complete job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":17,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"}],\"check_run_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\",\"labels\":[\"self-hosted\",\"foo\",\"bar\"],\"runner_id\":1,\"runner_name\":\"my runner\",\"runner_group_id\":2,\"runner_group_name\":\"my runner group\"}" } ] } @@ -2378,22 +2597,22 @@ "renamed": null }, { - "name": "Get a repository secret", + "name": "Get an organization public key", "scope": "actions", - "id": "getRepoSecret", + "id": "getOrgPublicKey", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", + "url": "/orgs/{org}/actions/secrets/public-key", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-repository-secret", + "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#get-an-organization-public-key", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -2403,10 +2622,38 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "repo", - "description": "", + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"key_id\":\"012345678912345678\",\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\"}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Get an organization secret", + "scope": "actions", + "id": "getOrgSecret", + "method": "GET", + "url": "/orgs/{org}/actions/secrets/{secret_name}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#get-an-organization-secret", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -2419,7 +2666,7 @@ }, { "name": "secret_name", - "description": "secret_name parameter", + "description": "The name of the secret.", "in": "PATH", "type": "string", "required": true, @@ -2437,7 +2684,7 @@ "description": "Response", "examples": [ { - "data": "{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"}" + "data": "{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"selected\",\"selected_repositories_url\":\"https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories\"}" } ] } @@ -2445,22 +2692,22 @@ "renamed": null }, { - "name": "Get the review history for a workflow run", + "name": "Get pending deployments for a workflow run", "scope": "actions", - "id": "getReviewsForRun", + "id": "getPendingDeploymentsForRun", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals", + "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#get-the-review-history-for-a-workflow-run", + "description": "Get all deployment environments for a workflow run that are waiting for protection rules to pass.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#get-pending-deployments-for-a-workflow-run", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -2473,7 +2720,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -2486,7 +2733,7 @@ }, { "name": "run_id", - "description": "The id of the workflow run.", + "description": "The unique identifier of the workflow run.", "in": "PATH", "type": "integer", "required": true, @@ -2504,7 +2751,7 @@ "description": "Response", "examples": [ { - "data": "[{\"state\":\"approved\",\"comment\":\"Ship it!\",\"environments\":[{\"id\":161088068,\"node_id\":\"MDExOkVudmlyb25tZW50MTYxMDg4MDY4\",\"name\":\"staging\",\"url\":\"https://api.github.com/repos/github/hello-world/environments/staging\",\"html_url\":\"https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging\",\"created_at\":\"2020-11-23T22:00:40Z\",\"updated_at\":\"2020-11-23T22:00:40Z\"}],\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]" + "data": "[{\"environment\":{\"id\":161088068,\"node_id\":\"MDExOkVudmlyb25tZW50MTYxMDg4MDY4\",\"name\":\"staging\",\"url\":\"https://api.github.com/repos/github/hello-world/environments/staging\",\"html_url\":\"https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging\"},\"wait_timer\":30,\"wait_timer_started_at\":\"2020-11-23T22:00:40Z\",\"current_user_can_approve\":true,\"reviewers\":[{\"type\":\"User\",\"reviewer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}},{\"type\":\"Team\",\"reviewer\":{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}}]}]" } ] } @@ -2512,22 +2759,22 @@ "renamed": null }, { - "name": "Get a self-hosted runner for an organization", + "name": "Get GitHub Actions permissions for a repository", "scope": "actions", - "id": "getSelfHostedRunnerForOrg", + "id": "getRepoPermissions", "method": "GET", - "url": "/orgs/{org}/actions/runners/{runner_id}", + "url": "/repos/{owner}/{repo}/actions/permissions", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specific self-hosted runner configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-self-hosted-runner-for-an-organization", + "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#get-github-actions-permissions-for-a-repository", "previews": [], "headers": [], "parameters": [ { - "name": "org", - "description": "", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -2539,10 +2786,10 @@ "deprecated": null }, { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -2558,30 +2805,38 @@ "description": "Response", "examples": [ { - "data": "{\"id\":23,\"name\":\"MBP\",\"os\":\"macos\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" + "data": "{\"enabled\":true,\"allowed_actions\":\"selected\",\"selected_actions_url\":\"https://api.github.com/repositories/42/actions/permissions/selected-actions\"}" } ] } ], - "renamed": null + "renamed": { + "before": { "scope": "actions", "id": "getRepoPermissions" }, + "after": { + "scope": "actions", + "id": "getGithubActionsPermissionsRepository" + }, + "date": "2020-11-10", + "note": null + } }, { - "name": "Get a self-hosted runner for a repository", + "name": "Get a repository public key", "scope": "actions", - "id": "getSelfHostedRunnerForRepo", + "id": "getRepoPublicKey", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}", + "url": "/repos/{owner}/{repo}/actions/secrets/public-key", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-self-hosted-runner-for-a-repository", + "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-repository-public-key", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -2594,7 +2849,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -2604,19 +2859,6 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null } ], "responses": [ @@ -2625,7 +2867,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":23,\"name\":\"MBP\",\"os\":\"macos\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" + "data": "{\"key_id\":\"012345678912345678\",\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\"}" } ] } @@ -2633,22 +2875,22 @@ "renamed": null }, { - "name": "Get a workflow", + "name": "Get a repository secret", "scope": "actions", - "id": "getWorkflow", + "id": "getRepoSecret", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}", + "url": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-workflow", + "description": "Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-repository-secret", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -2661,7 +2903,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -2673,10 +2915,10 @@ "deprecated": null }, { - "name": "workflow_id", - "description": "The ID of the workflow. You can also pass the workflow file name as a string.", + "name": "secret_name", + "description": "The name of the secret.", "in": "PATH", - "type": null, + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -2692,7 +2934,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":161335,\"node_id\":\"MDg6V29ya2Zsb3cxNjEzMzU=\",\"name\":\"CI\",\"path\":\".github/workflows/blank.yaml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/CI/badge.svg\"}" + "data": "{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"}" } ] } @@ -2700,22 +2942,22 @@ "renamed": null }, { - "name": "Get a workflow run", + "name": "Get the review history for a workflow run", "scope": "actions", - "id": "getWorkflowRun", + "id": "getReviewsForRun", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}", + "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-workflow-run", + "description": "Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#get-the-review-history-for-a-workflow-run", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -2728,7 +2970,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -2741,7 +2983,7 @@ }, { "name": "run_id", - "description": "The id of the workflow run.", + "description": "The unique identifier of the workflow run.", "in": "PATH", "type": "integer", "required": true, @@ -2751,19 +2993,6 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "exclude_pull_requests", - "description": "If `true` pull requests are omitted from the response (empty array).", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null } ], "responses": [ @@ -2772,7 +3001,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"check_suite_id\":42,\"check_suite_node_id\":\"MDEwOkNoZWNrU3VpdGU0Mg==\",\"head_branch\":\"master\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"run_number\":562,\"event\":\"push\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}" + "data": "[{\"state\":\"approved\",\"comment\":\"Ship it!\",\"environments\":[{\"id\":161088068,\"node_id\":\"MDExOkVudmlyb25tZW50MTYxMDg4MDY4\",\"name\":\"staging\",\"url\":\"https://api.github.com/repos/github/hello-world/environments/staging\",\"html_url\":\"https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging\",\"created_at\":\"2020-11-23T22:00:40Z\",\"updated_at\":\"2020-11-23T22:00:40Z\"}],\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]" } ] } @@ -2780,35 +3009,22 @@ "renamed": null }, { - "name": "Get a workflow run attempt", + "name": "Get a self-hosted runner for an organization", "scope": "actions", - "id": "getWorkflowRunAttempt", + "id": "getSelfHostedRunnerForOrg", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}", + "url": "/orgs/{org}/actions/runners/{runner_id}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specific workflow run attempt. Anyone with read access to the repository\ncan use this endpoint. If the repository is private you must use an access token\nwith the `repo` scope. GitHub Apps must have the `actions:read` permission to\nuse this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-workflow-run-attempt", + "description": "Gets a specific self-hosted runner configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-self-hosted-runner-for-an-organization", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -2820,21 +3036,8 @@ "deprecated": null }, { - "name": "run_id", - "description": "The id of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "attempt_number", - "description": "The attempt number of the workflow run.", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "PATH", "type": "integer", "required": true, @@ -2844,19 +3047,6 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "exclude_pull_requests", - "description": "If `true` pull requests are omitted from the response (empty array).", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null } ], "responses": [ @@ -2865,7 +3055,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"check_suite_id\":42,\"check_suite_node_id\":\"MDEwOkNoZWNrU3VpdGU0Mg==\",\"head_branch\":\"master\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"run_number\":562,\"event\":\"push\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}" + "data": "{\"id\":23,\"name\":\"MBP\",\"os\":\"macos\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" } ] } @@ -2873,22 +3063,22 @@ "renamed": null }, { - "name": "Get workflow run usage", + "name": "Get a self-hosted runner for a repository", "scope": "actions", - "id": "getWorkflowRunUsage", + "id": "getSelfHostedRunnerForRepo", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/timing", + "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#get-workflow-run-usage", + "description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-self-hosted-runner-for-a-repository", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -2901,7 +3091,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -2913,8 +3103,8 @@ "deprecated": null }, { - "name": "run_id", - "description": "The id of the workflow run.", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "PATH", "type": "integer", "required": true, @@ -2932,7 +3122,7 @@ "description": "Response", "examples": [ { - "data": "{\"billable\":{\"UBUNTU\":{\"total_ms\":180000,\"jobs\":1,\"job_runs\":[{\"job_id\":1,\"duration_ms\":180000}]},\"MACOS\":{\"total_ms\":240000,\"jobs\":4,\"job_runs\":[{\"job_id\":2,\"duration_ms\":60000},{\"job_id\":3,\"duration_ms\":60000},{\"job_id\":4,\"duration_ms\":60000},{\"job_id\":5,\"duration_ms\":60000}]},\"WINDOWS\":{\"total_ms\":300000,\"jobs\":2,\"job_runs\":[{\"job_id\":6,\"duration_ms\":150000},{\"job_id\":7,\"duration_ms\":150000}]}},\"run_duration_ms\":500000}" + "data": "{\"id\":23,\"name\":\"MBP\",\"os\":\"macos\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" } ] } @@ -2940,22 +3130,22 @@ "renamed": null }, { - "name": "Get workflow usage", + "name": "Get a workflow", "scope": "actions", - "id": "getWorkflowUsage", + "id": "getWorkflow", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing", + "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#get-workflow-usage", + "description": "Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-workflow", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -2968,7 +3158,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -2999,7 +3189,7 @@ "description": "Response", "examples": [ { - "data": "{\"billable\":{\"UBUNTU\":{\"total_ms\":180000},\"MACOS\":{\"total_ms\":240000},\"WINDOWS\":{\"total_ms\":300000}}}" + "data": "{\"id\":161335,\"node_id\":\"MDg6V29ya2Zsb3cxNjEzMzU=\",\"name\":\"CI\",\"path\":\".github/workflows/blank.yaml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/CI/badge.svg\"}" } ] } @@ -3007,22 +3197,22 @@ "renamed": null }, { - "name": "List artifacts for a repository", + "name": "Get the level of access for workflows outside of the repository", "scope": "actions", - "id": "listArtifactsForRepo", + "id": "getWorkflowAccessToRepository", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/artifacts", + "url": "/repos/{owner}/{repo}/actions/permissions/access", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#list-artifacts-for-a-repository", + "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal repositories. For more information, see \"[Managing GitHub Actions settings for a repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#get-workflow-access-level-to-a-repository", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -3035,7 +3225,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -3045,66 +3235,36 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null } ], "responses": [ { "code": 200, "description": "Response", - "examples": [ - { - "data": "{\"total_count\":2,\"artifacts\":[{\"id\":11,\"node_id\":\"MDg6QXJ0aWZhY3QxMQ==\",\"name\":\"Rails\",\"size_in_bytes\":556,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\"},{\"id\":13,\"node_id\":\"MDg6QXJ0aWZhY3QxMw==\",\"name\":\"\",\"size_in_bytes\":453,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\"}]}" - } - ] + "examples": [{ "data": "{\"access_level\":\"organization\"}" }] } ], "renamed": null }, { - "name": "List environment secrets", + "name": "Get a workflow run", "scope": "actions", - "id": "listEnvironmentSecrets", + "id": "getWorkflowRun", "method": "GET", - "url": "/repositories/{repository_id}/environments/{environment_name}/secrets", + "url": "/repos/{owner}/{repo}/actions/runs/{run_id}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#list-environment-secrets", + "description": "Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-workflow-run", "previews": [], "headers": [], "parameters": [ { - "name": "repository_id", - "description": "", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -3114,8 +3274,8 @@ "deprecated": null }, { - "name": "environment_name", - "description": "The name of the environment", + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -3127,11 +3287,11 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", + "name": "run_id", + "description": "The unique identifier of the workflow run.", + "in": "PATH", "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -3140,10 +3300,10 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", + "name": "exclude_pull_requests", + "description": "If `true` pull requests are omitted from the response (empty array).", "in": "QUERY", - "type": "integer", + "type": "boolean", "required": false, "enum": null, "allowNull": false, @@ -3159,7 +3319,7 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":2,\"secrets\":[{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"GIST_ID\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}" + "data": "{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"check_suite_id\":42,\"check_suite_node_id\":\"MDEwOkNoZWNrU3VpdGU0Mg==\",\"head_branch\":\"main\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"path\":\".github/workflows/build.yml@main\",\"run_number\":562,\"event\":\"push\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"run_attempt\":1,\"referenced_workflows\":[{\"path\":\"octocat/Hello-World/.github/workflows/deploy.yml@main\",\"sha\":\"86e8bc9ecf7d38b1ed2d2cfb8eb87ba9b35b01db\",\"ref\":\"refs/heads/main\"},{\"path\":\"octo-org/octo-repo/.github/workflows/report.yml@v2\",\"sha\":\"79e9790903e1c3373b1a3e3a941d57405478a232\",\"ref\":\"refs/tags/v2\"},{\"path\":\"octo-org/octo-repo/.github/workflows/secure.yml@1595d4b6de6a9e9751fb270a41019ce507d4099e\",\"sha\":\"1595d4b6de6a9e9751fb270a41019ce507d4099e\"}],\"run_started_at\":\"2020-01-22T19:33:08Z\",\"triggering_actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"previous_attempt_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/attempts/1\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}" } ] } @@ -3167,22 +3327,22 @@ "renamed": null }, { - "name": "List jobs for a workflow run", + "name": "Get a workflow run attempt", "scope": "actions", - "id": "listJobsForWorkflowRun", + "id": "getWorkflowRunAttempt", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs", + "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).", - "documentationUrl": "https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run", + "description": "Gets a specific workflow run attempt. Anyone with read access to the repository\ncan use this endpoint. If the repository is private you must use an access token\nwith the `repo` scope. GitHub Apps must have the `actions:read` permission to\nuse this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-workflow-run-attempt", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -3195,7 +3355,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -3208,7 +3368,7 @@ }, { "name": "run_id", - "description": "The id of the workflow run.", + "description": "The unique identifier of the workflow run.", "in": "PATH", "type": "integer", "required": true, @@ -3220,24 +3380,11 @@ "deprecated": null }, { - "name": "filter", - "description": "Filters jobs by their `completed_at` timestamp. Can be one of: \n\\* `latest`: Returns jobs from the most recent execution of the workflow run. \n\\* `all`: Returns all jobs for a workflow run, including from old executions of the workflow run.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["latest", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", + "name": "attempt_number", + "description": "The attempt number of the workflow run.", + "in": "PATH", "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -3246,10 +3393,10 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", + "name": "exclude_pull_requests", + "description": "If `true` pull requests are omitted from the response (empty array).", "in": "QUERY", - "type": "integer", + "type": "boolean", "required": false, "enum": null, "allowNull": false, @@ -3265,7 +3412,7 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":1,\"jobs\":[{\"id\":399444496,\"run_id\":29679449,\"run_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\"node_id\":\"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\"head_sha\":\"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\"html_url\":\"https://github.com/octo-org/octo-repo/runs/399444496\",\"status\":\"completed\",\"conclusion\":\"success\",\"started_at\":\"2020-01-20T17:42:40Z\",\"completed_at\":\"2020-01-20T17:44:39Z\",\"name\":\"build\",\"steps\":[{\"name\":\"Set up job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":1,\"started_at\":\"2020-01-20T09:42:40.000-08:00\",\"completed_at\":\"2020-01-20T09:42:41.000-08:00\"},{\"name\":\"Run actions/checkout@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":2,\"started_at\":\"2020-01-20T09:42:41.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Set up Ruby\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":3,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Run actions/cache@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":4,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:48.000-08:00\"},{\"name\":\"Install Bundler\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":5,\"started_at\":\"2020-01-20T09:42:48.000-08:00\",\"completed_at\":\"2020-01-20T09:42:52.000-08:00\"},{\"name\":\"Install Gems\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":6,\"started_at\":\"2020-01-20T09:42:52.000-08:00\",\"completed_at\":\"2020-01-20T09:42:53.000-08:00\"},{\"name\":\"Run Tests\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":7,\"started_at\":\"2020-01-20T09:42:53.000-08:00\",\"completed_at\":\"2020-01-20T09:42:59.000-08:00\"},{\"name\":\"Deploy to Heroku\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":8,\"started_at\":\"2020-01-20T09:42:59.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Post actions/cache@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":16,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Complete job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":17,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"}],\"check_run_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\",\"labels\":[\"self-hosted\",\"foo\",\"bar\"],\"runner_id\":1,\"runner_name\":\"my runner\",\"runner_group_id\":2,\"runner_group_name\":\"my runner group\"}]}" + "data": "{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"check_suite_id\":42,\"check_suite_node_id\":\"MDEwOkNoZWNrU3VpdGU0Mg==\",\"head_branch\":\"main\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"path\":\".github/workflows/build.yml@main\",\"run_number\":562,\"event\":\"push\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"run_attempt\":1,\"referenced_workflows\":[{\"path\":\"octocat/Hello-World/.github/workflows/deploy.yml@main\",\"sha\":\"86e8bc9ecf7d38b1ed2d2cfb8eb87ba9b35b01db\",\"ref\":\"refs/heads/main\"},{\"path\":\"octo-org/octo-repo/.github/workflows/report.yml@v2\",\"sha\":\"79e9790903e1c3373b1a3e3a941d57405478a232\",\"ref\":\"refs/tags/v2\"},{\"path\":\"octo-org/octo-repo/.github/workflows/secure.yml@1595d4b6de6a9e9751fb270a41019ce507d4099e\",\"sha\":\"1595d4b6de6a9e9751fb270a41019ce507d4099e\"}],\"run_started_at\":\"2020-01-22T19:33:08Z\",\"triggering_actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"previous_attempt_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/attempts/1\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}" } ] } @@ -3273,22 +3420,22 @@ "renamed": null }, { - "name": "List jobs for a workflow run attempt", + "name": "Get workflow run usage", "scope": "actions", - "id": "listJobsForWorkflowRunAttempt", + "id": "getWorkflowRunUsage", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs", + "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/timing", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).", - "documentationUrl": "https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run-attempt", + "description": "Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#get-workflow-run-usage", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -3301,7 +3448,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -3314,7 +3461,7 @@ }, { "name": "run_id", - "description": "The id of the workflow run.", + "description": "The unique identifier of the workflow run.", "in": "PATH", "type": "integer", "required": true, @@ -3324,12 +3471,40 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "attempt_number", - "description": "The attempt number of the workflow run.", + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"billable\":{\"UBUNTU\":{\"total_ms\":180000,\"jobs\":1,\"job_runs\":[{\"job_id\":1,\"duration_ms\":180000}]},\"MACOS\":{\"total_ms\":240000,\"jobs\":4,\"job_runs\":[{\"job_id\":2,\"duration_ms\":60000},{\"job_id\":3,\"duration_ms\":60000},{\"job_id\":4,\"duration_ms\":60000},{\"job_id\":5,\"duration_ms\":60000}]},\"WINDOWS\":{\"total_ms\":300000,\"jobs\":2,\"job_runs\":[{\"job_id\":6,\"duration_ms\":150000},{\"job_id\":7,\"duration_ms\":150000}]}},\"run_duration_ms\":500000}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Get workflow usage", + "scope": "actions", + "id": "getWorkflowUsage", + "method": "GET", + "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#get-workflow-usage", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -3339,11 +3514,11 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -3352,11 +3527,11 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "workflow_id", + "description": "The ID of the workflow. You can also pass the workflow file name as a string.", + "in": "PATH", + "type": null, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -3371,31 +3546,43 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":1,\"jobs\":[{\"id\":399444496,\"run_id\":29679449,\"run_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\"node_id\":\"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\"head_sha\":\"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\"html_url\":\"https://github.com/octo-org/octo-repo/runs/399444496\",\"status\":\"completed\",\"conclusion\":\"success\",\"started_at\":\"2020-01-20T17:42:40Z\",\"completed_at\":\"2020-01-20T17:44:39Z\",\"name\":\"build\",\"steps\":[{\"name\":\"Set up job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":1,\"started_at\":\"2020-01-20T09:42:40.000-08:00\",\"completed_at\":\"2020-01-20T09:42:41.000-08:00\"},{\"name\":\"Run actions/checkout@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":2,\"started_at\":\"2020-01-20T09:42:41.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Set up Ruby\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":3,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Run actions/cache@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":4,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:48.000-08:00\"},{\"name\":\"Install Bundler\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":5,\"started_at\":\"2020-01-20T09:42:48.000-08:00\",\"completed_at\":\"2020-01-20T09:42:52.000-08:00\"},{\"name\":\"Install Gems\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":6,\"started_at\":\"2020-01-20T09:42:52.000-08:00\",\"completed_at\":\"2020-01-20T09:42:53.000-08:00\"},{\"name\":\"Run Tests\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":7,\"started_at\":\"2020-01-20T09:42:53.000-08:00\",\"completed_at\":\"2020-01-20T09:42:59.000-08:00\"},{\"name\":\"Deploy to Heroku\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":8,\"started_at\":\"2020-01-20T09:42:59.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Post actions/cache@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":16,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Complete job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":17,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"}],\"check_run_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\",\"labels\":[\"self-hosted\",\"foo\",\"bar\"],\"runner_id\":1,\"runner_name\":\"my runner\",\"runner_group_id\":2,\"runner_group_name\":\"my runner group\"}]}" + "data": "{\"billable\":{\"UBUNTU\":{\"total_ms\":180000},\"MACOS\":{\"total_ms\":240000},\"WINDOWS\":{\"total_ms\":300000}}}" } ] - }, - { "code": 404, "description": "Resource not found", "examples": null } + } ], "renamed": null }, { - "name": "List organization secrets", + "name": "List artifacts for a repository", "scope": "actions", - "id": "listOrgSecrets", + "id": "listArtifactsForRepo", "method": "GET", - "url": "/orgs/{org}/actions/secrets", + "url": "/repos/{owner}/{repo}/actions/artifacts", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#list-organization-secrets", + "description": "Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#list-artifacts-for-a-repository", "previews": [], "headers": [], "parameters": [ { - "name": "org", - "description": "", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -3408,7 +3595,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -3439,7 +3626,7 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":3,\"secrets\":[{\"name\":\"GIST_ID\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"private\"},{\"name\":\"DEPLOY_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"all\"},{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"selected\",\"selected_repositories_url\":\"https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories\"}]}" + "data": "{\"total_count\":2,\"artifacts\":[{\"id\":11,\"node_id\":\"MDg6QXJ0aWZhY3QxMQ==\",\"name\":\"Rails\",\"size_in_bytes\":556,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\",\"workflow_run\":{\"id\":2332938,\"repository_id\":1296269,\"head_repository_id\":1296269,\"head_branch\":\"main\",\"head_sha\":\"328faa0536e6fef19753d9d91dc96a9931694ce3\"}},{\"id\":13,\"node_id\":\"MDg6QXJ0aWZhY3QxMw==\",\"name\":\"Test output\",\"size_in_bytes\":453,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\",\"workflow_run\":{\"id\":2332942,\"repository_id\":1296269,\"head_repository_id\":1296269,\"head_branch\":\"main\",\"head_sha\":\"178f4f6090b3fccad4a65b3e83d076a622d59652\"}}]}" } ] } @@ -3447,24 +3634,24 @@ "renamed": null }, { - "name": "List repository secrets", + "name": "List environment secrets", "scope": "actions", - "id": "listRepoSecrets", + "id": "listEnvironmentSecrets", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/secrets", + "url": "/repositories/{repository_id}/environments/{environment_name}/secrets", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#list-repository-secrets", + "description": "Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#list-environment-secrets", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "", + "name": "repository_id", + "description": "The unique identifier of the repository.", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -3474,8 +3661,8 @@ "deprecated": null }, { - "name": "repo", - "description": "", + "name": "environment_name", + "description": "The name of the environment", "in": "PATH", "type": "string", "required": true, @@ -3488,7 +3675,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -3527,22 +3714,22 @@ "renamed": null }, { - "name": "List repository workflows", + "name": "List jobs for a workflow run", "scope": "actions", - "id": "listRepoWorkflows", + "id": "listJobsForWorkflowRun", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/workflows", + "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#list-repository-workflows", + "description": "Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).", + "documentationUrl": "https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -3555,7 +3742,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -3566,9 +3753,35 @@ "alias": null, "deprecated": null }, + { + "name": "run_id", + "description": "The unique identifier of the workflow run.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "filter", + "description": "Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all jobs for a workflow run, including from old executions of the workflow run.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["latest", "all"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -3599,7 +3812,7 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":2,\"workflows\":[{\"id\":161335,\"node_id\":\"MDg6V29ya2Zsb3cxNjEzMzU=\",\"name\":\"CI\",\"path\":\".github/workflows/blank.yaml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/CI/badge.svg\"},{\"id\":269289,\"node_id\":\"MDE4OldvcmtmbG93IFNlY29uZGFyeTI2OTI4OQ==\",\"name\":\"Linter\",\"path\":\".github/workflows/linter.yaml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/269289\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg\"}]}" + "data": "{\"total_count\":1,\"jobs\":[{\"id\":399444496,\"run_id\":29679449,\"run_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\"node_id\":\"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\"head_sha\":\"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\"html_url\":\"https://github.com/octo-org/octo-repo/runs/399444496\",\"status\":\"completed\",\"conclusion\":\"success\",\"started_at\":\"2020-01-20T17:42:40Z\",\"completed_at\":\"2020-01-20T17:44:39Z\",\"name\":\"build\",\"steps\":[{\"name\":\"Set up job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":1,\"started_at\":\"2020-01-20T09:42:40.000-08:00\",\"completed_at\":\"2020-01-20T09:42:41.000-08:00\"},{\"name\":\"Run actions/checkout@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":2,\"started_at\":\"2020-01-20T09:42:41.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Set up Ruby\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":3,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Run actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":4,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:48.000-08:00\"},{\"name\":\"Install Bundler\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":5,\"started_at\":\"2020-01-20T09:42:48.000-08:00\",\"completed_at\":\"2020-01-20T09:42:52.000-08:00\"},{\"name\":\"Install Gems\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":6,\"started_at\":\"2020-01-20T09:42:52.000-08:00\",\"completed_at\":\"2020-01-20T09:42:53.000-08:00\"},{\"name\":\"Run Tests\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":7,\"started_at\":\"2020-01-20T09:42:53.000-08:00\",\"completed_at\":\"2020-01-20T09:42:59.000-08:00\"},{\"name\":\"Deploy to Heroku\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":8,\"started_at\":\"2020-01-20T09:42:59.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Post actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":16,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Complete job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":17,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"}],\"check_run_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\",\"labels\":[\"self-hosted\",\"foo\",\"bar\"],\"runner_id\":1,\"runner_name\":\"my runner\",\"runner_group_id\":2,\"runner_group_name\":\"my runner group\"}]}" } ] } @@ -3607,22 +3820,22 @@ "renamed": null }, { - "name": "List runner applications for an organization", + "name": "List jobs for a workflow run attempt", "scope": "actions", - "id": "listRunnerApplicationsForOrg", + "id": "listJobsForWorkflowRunAttempt", "method": "GET", - "url": "/orgs/{org}/actions/runners/downloads", + "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#list-runner-applications-for-an-organization", + "description": "Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).", + "documentationUrl": "https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run-attempt", "previews": [], "headers": [], "parameters": [ { - "name": "org", - "description": "", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -3632,6 +3845,71 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "run_id", + "description": "The unique identifier of the workflow run.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "attempt_number", + "description": "The attempt number of the workflow run.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -3640,30 +3918,31 @@ "description": "Response", "examples": [ { - "data": "[{\"os\":\"osx\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-osx-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"arm\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm-2.164.0.tar.gz\"},{\"os\":\"win\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip\",\"filename\":\"actions-runner-win-x64-2.164.0.zip\"},{\"os\":\"linux\",\"architecture\":\"arm64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm64-2.164.0.tar.gz\"}]" + "data": "{\"total_count\":1,\"jobs\":[{\"id\":399444496,\"run_id\":29679449,\"run_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\"node_id\":\"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\"head_sha\":\"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\"html_url\":\"https://github.com/octo-org/octo-repo/runs/399444496\",\"status\":\"completed\",\"conclusion\":\"success\",\"started_at\":\"2020-01-20T17:42:40Z\",\"completed_at\":\"2020-01-20T17:44:39Z\",\"name\":\"build\",\"steps\":[{\"name\":\"Set up job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":1,\"started_at\":\"2020-01-20T09:42:40.000-08:00\",\"completed_at\":\"2020-01-20T09:42:41.000-08:00\"},{\"name\":\"Run actions/checkout@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":2,\"started_at\":\"2020-01-20T09:42:41.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Set up Ruby\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":3,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Run actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":4,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:48.000-08:00\"},{\"name\":\"Install Bundler\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":5,\"started_at\":\"2020-01-20T09:42:48.000-08:00\",\"completed_at\":\"2020-01-20T09:42:52.000-08:00\"},{\"name\":\"Install Gems\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":6,\"started_at\":\"2020-01-20T09:42:52.000-08:00\",\"completed_at\":\"2020-01-20T09:42:53.000-08:00\"},{\"name\":\"Run Tests\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":7,\"started_at\":\"2020-01-20T09:42:53.000-08:00\",\"completed_at\":\"2020-01-20T09:42:59.000-08:00\"},{\"name\":\"Deploy to Heroku\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":8,\"started_at\":\"2020-01-20T09:42:59.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Post actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":16,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Complete job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":17,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"}],\"check_run_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\",\"labels\":[\"self-hosted\",\"foo\",\"bar\"],\"runner_id\":1,\"runner_name\":\"my runner\",\"runner_group_id\":2,\"runner_group_name\":\"my runner group\"}]}" } ] - } + }, + { "code": 404, "description": "Resource not found", "examples": null } ], "renamed": null }, { - "name": "List runner applications for a repository", + "name": "List labels for a self-hosted runner for an organization", "scope": "actions", - "id": "listRunnerApplicationsForRepo", + "id": "listLabelsForSelfHostedRunnerForOrg", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runners/downloads", + "url": "/orgs/{org}/actions/runners/{runner_id}/labels", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#list-runner-applications-for-a-repository", + "description": "Lists all labels for a self-hosted runner configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-an-organization", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -3675,10 +3954,10 @@ "deprecated": null }, { - "name": "repo", - "description": "", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -3694,30 +3973,31 @@ "description": "Response", "examples": [ { - "data": "[{\"os\":\"osx\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-osx-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"arm\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm-2.164.0.tar.gz\"},{\"os\":\"win\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip\",\"filename\":\"actions-runner-win-x64-2.164.0.zip\"},{\"os\":\"linux\",\"architecture\":\"arm64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm64-2.164.0.tar.gz\"}]" + "data": "{\"total_count\":4,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" } ] - } + }, + { "code": 404, "description": "Resource not found", "examples": null } ], "renamed": null }, { - "name": "List selected repositories for an organization secret", + "name": "List labels for a self-hosted runner for a repository", "scope": "actions", - "id": "listSelectedReposForOrgSecret", + "id": "listLabelsForSelfHostedRunnerForRepo", "method": "GET", - "url": "/orgs/{org}/actions/secrets/{secret_name}/repositories", + "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#list-selected-repositories-for-an-organization-secret", + "description": "Lists all labels for a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-a-repository", "previews": [], "headers": [], "parameters": [ { - "name": "org", - "description": "", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -3729,8 +4009,8 @@ "deprecated": null }, { - "name": "secret_name", - "description": "secret_name parameter", + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -3742,24 +4022,11 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "PATH", "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -3774,30 +4041,31 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"}]}" + "data": "{\"total_count\":4,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" } ] - } + }, + { "code": 404, "description": "Resource not found", "examples": null } ], "renamed": null }, { - "name": "List selected repositories enabled for GitHub Actions in an organization", + "name": "List organization secrets", "scope": "actions", - "id": "listSelectedRepositoriesEnabledGithubActionsOrganization", + "id": "listOrgSecrets", "method": "GET", - "url": "/orgs/{org}/actions/permissions/repositories", + "url": "/orgs/{org}/actions/secrets", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#list-selected-repositories-enabled-for-github-actions-in-an-organization", + "description": "Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#list-organization-secrets", "previews": [], "headers": [], "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -3810,7 +4078,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -3841,7 +4109,7 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]}" + "data": "{\"total_count\":3,\"secrets\":[{\"name\":\"GIST_ID\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"private\"},{\"name\":\"DEPLOY_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"all\"},{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"selected\",\"selected_repositories_url\":\"https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories\"}]}" } ] } @@ -3849,22 +4117,35 @@ "renamed": null }, { - "name": "List self-hosted runners for an organization", + "name": "List repository secrets", "scope": "actions", - "id": "listSelfHostedRunnersForOrg", + "id": "listRepoSecrets", "method": "GET", - "url": "/orgs/{org}/actions/runners", + "url": "/repos/{owner}/{repo}/actions/secrets", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all self-hosted runners configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#list-self-hosted-runners-for-an-organization", + "description": "Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#list-repository-secrets", "previews": [], "headers": [], "parameters": [ { - "name": "org", - "description": "", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -3877,7 +4158,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -3908,7 +4189,7 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":2,\"runners\":[{\"id\":23,\"name\":\"linux_runner\",\"os\":\"linux\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":11,\"name\":\"Linux\",\"type\":\"read-only\"}]},{\"id\":24,\"name\":\"mac_runner\",\"os\":\"macos\",\"status\":\"offline\",\"busy\":false,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}]}" + "data": "{\"total_count\":2,\"secrets\":[{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"GIST_ID\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}" } ] } @@ -3916,22 +4197,22 @@ "renamed": null }, { - "name": "List self-hosted runners for a repository", + "name": "List repository workflows", "scope": "actions", - "id": "listSelfHostedRunnersForRepo", + "id": "listRepoWorkflows", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runners", + "url": "/repos/{owner}/{repo}/actions/workflows", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#list-self-hosted-runners-for-a-repository", + "description": "Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#list-repository-workflows", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -3944,7 +4225,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -3957,7 +4238,396 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_count\":2,\"workflows\":[{\"id\":161335,\"node_id\":\"MDg6V29ya2Zsb3cxNjEzMzU=\",\"name\":\"CI\",\"path\":\".github/workflows/blank.yaml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/CI/badge.svg\"},{\"id\":269289,\"node_id\":\"MDE4OldvcmtmbG93IFNlY29uZGFyeTI2OTI4OQ==\",\"name\":\"Linter\",\"path\":\".github/workflows/linter.yaml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/269289\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg\"}]}" + } + ] + } + ], + "renamed": null + }, + { + "name": "List runner applications for an organization", + "scope": "actions", + "id": "listRunnerApplicationsForOrg", + "method": "GET", + "url": "/orgs/{org}/actions/runners/downloads", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#list-runner-applications-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"os\":\"osx\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-osx-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"arm\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm-2.164.0.tar.gz\"},{\"os\":\"win\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip\",\"filename\":\"actions-runner-win-x64-2.164.0.zip\"},{\"os\":\"linux\",\"architecture\":\"arm64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm64-2.164.0.tar.gz\"}]" + } + ] + } + ], + "renamed": null + }, + { + "name": "List runner applications for a repository", + "scope": "actions", + "id": "listRunnerApplicationsForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/actions/runners/downloads", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#list-runner-applications-for-a-repository", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"os\":\"osx\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-osx-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"arm\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm-2.164.0.tar.gz\"},{\"os\":\"win\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip\",\"filename\":\"actions-runner-win-x64-2.164.0.zip\"},{\"os\":\"linux\",\"architecture\":\"arm64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm64-2.164.0.tar.gz\"}]" + } + ] + } + ], + "renamed": null + }, + { + "name": "List selected repositories for an organization secret", + "scope": "actions", + "id": "listSelectedReposForOrgSecret", + "method": "GET", + "url": "/orgs/{org}/actions/secrets/{secret_name}/repositories", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#list-selected-repositories-for-an-organization-secret", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"}]}" + } + ] + } + ], + "renamed": null + }, + { + "name": "List selected repositories enabled for GitHub Actions in an organization", + "scope": "actions", + "id": "listSelectedRepositoriesEnabledGithubActionsOrganization", + "method": "GET", + "url": "/orgs/{org}/actions/permissions/repositories", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#list-selected-repositories-enabled-for-github-actions-in-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]}" + } + ] + } + ], + "renamed": null + }, + { + "name": "List self-hosted runners for an organization", + "scope": "actions", + "id": "listSelfHostedRunnersForOrg", + "method": "GET", + "url": "/orgs/{org}/actions/runners", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists all self-hosted runners configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#list-self-hosted-runners-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_count\":2,\"runners\":[{\"id\":23,\"name\":\"linux_runner\",\"os\":\"linux\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":11,\"name\":\"Linux\",\"type\":\"read-only\"}]},{\"id\":24,\"name\":\"mac_runner\",\"os\":\"macos\",\"status\":\"offline\",\"busy\":false,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}]}" + } + ] + } + ], + "renamed": null + }, + { + "name": "List self-hosted runners for a repository", + "scope": "actions", + "id": "listSelfHostedRunnersForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/actions/runners", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#list-self-hosted-runners-for-a-repository", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -4011,7 +4681,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -4024,7 +4694,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -4037,7 +4707,7 @@ }, { "name": "run_id", - "description": "The id of the workflow run.", + "description": "The unique identifier of the workflow run.", "in": "PATH", "type": "integer", "required": true, @@ -4050,7 +4720,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -4081,7 +4751,7 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":2,\"artifacts\":[{\"id\":11,\"node_id\":\"MDg6QXJ0aWZhY3QxMQ==\",\"name\":\"Rails\",\"size_in_bytes\":556,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\"},{\"id\":13,\"node_id\":\"MDg6QXJ0aWZhY3QxMw==\",\"name\":\"\",\"size_in_bytes\":453,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\"}]}" + "data": "{\"total_count\":2,\"artifacts\":[{\"id\":11,\"node_id\":\"MDg6QXJ0aWZhY3QxMQ==\",\"name\":\"Rails\",\"size_in_bytes\":556,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\",\"workflow_run\":{\"id\":2332938,\"repository_id\":1296269,\"head_repository_id\":1296269,\"head_branch\":\"main\",\"head_sha\":\"328faa0536e6fef19753d9d91dc96a9931694ce3\"}},{\"id\":13,\"node_id\":\"MDg6QXJ0aWZhY3QxMw==\",\"name\":\"Test output\",\"size_in_bytes\":453,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\",\"workflow_run\":{\"id\":2332942,\"repository_id\":1296269,\"head_repository_id\":1296269,\"head_branch\":\"main\",\"head_sha\":\"178f4f6090b3fccad4a65b3e83d076a622d59652\"}}]}" } ] } @@ -4104,7 +4774,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -4117,7 +4787,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -4169,7 +4839,7 @@ }, { "name": "event", - "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", + "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", "in": "QUERY", "type": "string", "required": false, @@ -4209,7 +4879,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -4235,7 +4905,7 @@ }, { "name": "created", - "description": "", + "description": "Returns workflow runs created within the given date-time range. For more information on the syntax, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", "in": "QUERY", "type": "string", "required": false, @@ -4258,6 +4928,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "check_suite_id", + "description": "Returns workflow runs with the `check_suite_id` that you specify.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -4266,7 +4949,7 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":1,\"workflow_runs\":[{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"head_branch\":\"master\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"run_number\":562,\"event\":\"push\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}]}" + "data": "{\"total_count\":1,\"workflow_runs\":[{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"check_suite_id\":42,\"check_suite_node_id\":\"MDEwOkNoZWNrU3VpdGU0Mg==\",\"head_branch\":\"master\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"run_number\":562,\"event\":\"push\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"run_attempt\":1,\"run_started_at\":\"2020-01-22T19:33:08Z\",\"triggering_actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}]}" } ] } @@ -4289,7 +4972,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -4302,7 +4985,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -4341,7 +5024,7 @@ }, { "name": "event", - "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", + "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", "in": "QUERY", "type": "string", "required": false, @@ -4381,7 +5064,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -4407,7 +5090,7 @@ }, { "name": "created", - "description": "", + "description": "Returns workflow runs created within the given date-time range. For more information on the syntax, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", "in": "QUERY", "type": "string", "required": false, @@ -4430,6 +5113,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "check_suite_id", + "description": "Returns workflow runs with the `check_suite_id` that you specify.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -4438,7 +5134,7 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":1,\"workflow_runs\":[{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"head_branch\":\"master\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"run_number\":562,\"event\":\"push\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}]}" + "data": "{\"total_count\":1,\"workflow_runs\":[{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"check_suite_id\":42,\"check_suite_node_id\":\"MDEwOkNoZWNrU3VpdGU0Mg==\",\"head_branch\":\"master\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"run_number\":562,\"event\":\"push\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"run_attempt\":1,\"run_started_at\":\"2020-01-22T19:33:08Z\",\"triggering_actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}]}" } ] } @@ -4446,22 +5142,22 @@ "renamed": null }, { - "name": "Re-run a workflow", + "name": "Re-run a job from a workflow run", "scope": "actions", - "id": "reRunWorkflow", + "id": "reRunJobForWorkflowRun", "method": "POST", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun", - "isDeprecated": true, - "deprecationDate": "2021-09-14", + "url": "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun", + "isDeprecated": false, + "deprecationDate": null, "removalDate": null, - "description": "Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#re-run-a-workflow", + "description": "Re-run a job and its dependent jobs in a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#re-run-job-for-workflow-run", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -4474,7 +5170,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -4486,8 +5182,8 @@ "deprecated": null }, { - "name": "run_id", - "description": "The id of the workflow run.", + "name": "job_id", + "description": "The unique identifier of the job.", "in": "PATH", "type": "integer", "required": true, @@ -4497,28 +5193,44 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "enable_debug_logging", + "description": "Whether to enable debug logging for the re-run.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], - "responses": [{ "code": 201, "description": "Response", "examples": null }], + "responses": [ + { "code": 201, "description": "Response", "examples": null }, + { "code": 403, "description": "Forbidden", "examples": null } + ], "renamed": null }, { - "name": "Remove selected repository from an organization secret", + "name": "Re-run a workflow", "scope": "actions", - "id": "removeSelectedRepoFromOrgSecret", - "method": "DELETE", - "url": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", + "id": "reRunWorkflow", + "method": "POST", + "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret", + "description": "Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#re-run-a-workflow", "previews": [], "headers": [], "parameters": [ { - "name": "org", - "description": "", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -4530,8 +5242,8 @@ "deprecated": null }, { - "name": "secret_name", - "description": "secret_name parameter", + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -4543,8 +5255,8 @@ "deprecated": null }, { - "name": "repository_id", - "description": "", + "name": "run_id", + "description": "The unique identifier of the workflow run.", "in": "PATH", "type": "integer", "required": true, @@ -4554,39 +5266,41 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 204, - "description": "Response when repository was removed from the selected list", - "examples": null }, { - "code": 409, - "description": "Conflict when visibility type not set to selected", - "examples": null + "name": "enable_debug_logging", + "description": "Whether to enable debug logging for the re-run.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], + "responses": [{ "code": 201, "description": "Response", "examples": null }], "renamed": null }, { - "name": "Review pending deployments for a workflow run", + "name": "Re-run failed jobs from a workflow run", "scope": "actions", - "id": "reviewPendingDeploymentsForRun", + "id": "reRunWorkflowFailedJobs", "method": "POST", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", + "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Approve or reject pending deployments that are waiting on approval by a required reviewer.\n\nAnyone with read access to the repository contents and deployments can use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#review-pending-deployments-for-a-workflow-run", + "description": "Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#re-run-workflow-failed-jobs", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -4599,7 +5313,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -4612,7 +5326,7 @@ }, { "name": "run_id", - "description": "The id of the workflow run.", + "description": "The unique identifier of the workflow run.", "in": "PATH", "type": "integer", "required": true, @@ -4624,25 +5338,43 @@ "deprecated": null }, { - "name": "environment_ids", - "description": "The list of environment ids to approve or reject", + "name": "enable_debug_logging", + "description": "Whether to enable debug logging for the re-run.", "in": "BODY", - "type": "integer[]", - "required": true, + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [{ "code": 201, "description": "Response", "examples": null }], + "renamed": null + }, + { + "name": "Remove all custom labels from a self-hosted runner for an organization", + "scope": "actions", + "id": "removeAllCustomLabelsFromSelfHostedRunnerForOrg", + "method": "DELETE", + "url": "/orgs/{org}/actions/runners/{runner_id}/labels", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ { - "name": "state", - "description": "Whether to approve or reject deployment to the specified environments. Must be one of: `approved` or `rejected`", - "in": "BODY", + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", "type": "string", "required": true, - "enum": ["approved", "rejected"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -4650,10 +5382,10 @@ "deprecated": null }, { - "name": "comment", - "description": "A comment to accompany the deployment review", - "in": "BODY", - "type": "string", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "PATH", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -4669,30 +5401,31 @@ "description": "Response", "examples": [ { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/example/deployments/1\",\"id\":1,\"node_id\":\"MDEwOkRlcGxveW1lbnQx\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"ref\":\"topic-branch\",\"task\":\"deploy\",\"payload\":{},\"original_environment\":\"staging\",\"environment\":\"production\",\"description\":\"Deploy request from hubot\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"statuses_url\":\"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"transient_environment\":false,\"production_environment\":true}]" + "data": "{\"total_count\":3,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"}]}" } ] - } + }, + { "code": 404, "description": "Resource not found", "examples": null } ], "renamed": null }, { - "name": "Set allowed actions for an organization", + "name": "Remove all custom labels from a self-hosted runner for a repository", "scope": "actions", - "id": "setAllowedActionsOrganization", - "method": "PUT", - "url": "/orgs/{org}/actions/permissions/selected-actions", + "id": "removeAllCustomLabelsFromSelfHostedRunnerForRepo", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nIf the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.\n\nTo use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#set-allowed-actions-for-an-organization", + "description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository", "previews": [], "headers": [], "parameters": [ { - "name": "org", - "description": "", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -4704,11 +5437,11 @@ "deprecated": null }, { - "name": "github_owned_allowed", - "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "in": "BODY", - "type": "boolean", - "required": false, + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -4717,24 +5450,79 @@ "deprecated": null }, { - "name": "verified_allowed", - "description": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators.", - "in": "BODY", - "type": "boolean", - "required": false, + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "PATH", + "type": "integer", + "required": true, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_count\":3,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"}]}" + } + ] }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "Remove a custom label from a self-hosted runner for an organization", + "scope": "actions", + "id": "removeCustomLabelFromSelfHostedRunnerForOrg", + "method": "DELETE", + "url": "/orgs/{org}/actions/runners/{runner_id}/labels/{name}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ { - "name": "patterns_allowed", - "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "in": "BODY", - "type": "string[]", - "required": false, + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "name", + "description": "The name of a self-hosted runner's custom label.", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -4743,26 +5531,38 @@ "deprecated": null } ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_count\":4,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" + } + ] + }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 422, "description": "Validation failed", "examples": null } + ], "renamed": null }, { - "name": "Set allowed actions for a repository", + "name": "Remove a custom label from a self-hosted runner for a repository", "scope": "actions", - "id": "setAllowedActionsRepository", - "method": "PUT", - "url": "/repos/{owner}/{repo}/actions/permissions/selected-actions", + "id": "removeCustomLabelFromSelfHostedRunnerForRepo", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nIf the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.\n\nTo use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#set-allowed-actions-for-a-repository", + "description": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -4775,7 +5575,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -4787,24 +5587,11 @@ "deprecated": null }, { - "name": "github_owned_allowed", - "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "verified_allowed", - "description": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators.", - "in": "BODY", - "type": "boolean", - "required": false, + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "PATH", + "type": "integer", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -4813,11 +5600,11 @@ "deprecated": null }, { - "name": "patterns_allowed", - "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "in": "BODY", - "type": "string[]", - "required": false, + "name": "name", + "description": "The name of a self-hosted runner's custom label.", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -4826,26 +5613,38 @@ "deprecated": null } ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_count\":4,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" + } + ] + }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 422, "description": "Validation failed", "examples": null } + ], "renamed": null }, { - "name": "Set GitHub Actions permissions for an organization", + "name": "Remove selected repository from an organization secret", "scope": "actions", - "id": "setGithubActionsPermissionsOrganization", - "method": "PUT", - "url": "/orgs/{org}/actions/permissions", + "id": "removeSelectedRepoFromOrgSecret", + "method": "DELETE", + "url": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.\n\nIf the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#set-github-actions-permissions-for-an-organization", + "description": "Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret", "previews": [], "headers": [], "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -4857,12 +5656,12 @@ "deprecated": null }, { - "name": "enabled_repositories", - "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.", - "in": "BODY", + "name": "secret_name", + "description": "The name of the secret.", + "in": "PATH", "type": "string", "required": true, - "enum": ["all", "none", "selected"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -4870,12 +5669,12 @@ "deprecated": null }, { - "name": "allowed_actions", - "description": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["all", "local_only", "selected"], + "name": "repository_id", + "description": "", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -4883,26 +5682,37 @@ "deprecated": null } ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], + "responses": [ + { + "code": 204, + "description": "Response when repository was removed from the selected list", + "examples": null + }, + { + "code": 409, + "description": "Conflict when visibility type not set to selected", + "examples": null + } + ], "renamed": null }, { - "name": "Set GitHub Actions permissions for a repository", + "name": "Review pending deployments for a workflow run", "scope": "actions", - "id": "setGithubActionsPermissionsRepository", - "method": "PUT", - "url": "/repos/{owner}/{repo}/actions/permissions", + "id": "reviewPendingDeploymentsForRun", + "method": "POST", + "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.\n\nIf the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#set-github-actions-permissions-for-a-repository", + "description": "Approve or reject pending deployments that are waiting on approval by a required reviewer.\n\nAnyone with read access to the repository contents and deployments can use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#review-pending-deployments-for-a-workflow-run", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -4915,7 +5725,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -4927,10 +5737,23 @@ "deprecated": null }, { - "name": "enabled", - "description": "Whether GitHub Actions is enabled on the repository.", + "name": "run_id", + "description": "The unique identifier of the workflow run.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "environment_ids", + "description": "The list of environment ids to approve or reject", "in": "BODY", - "type": "boolean", + "type": "integer[]", "required": true, "enum": null, "allowNull": false, @@ -4940,12 +5763,25 @@ "deprecated": null }, { - "name": "allowed_actions", - "description": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", + "name": "state", + "description": "Whether to approve or reject deployment to the specified environments.", "in": "BODY", "type": "string", - "required": false, - "enum": ["all", "local_only", "selected"], + "required": true, + "enum": ["approved", "rejected"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "comment", + "description": "A comment to accompany the deployment review", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -4953,26 +5789,36 @@ "deprecated": null } ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"url\":\"https://api.github.com/repos/octocat/example/deployments/1\",\"id\":1,\"node_id\":\"MDEwOkRlcGxveW1lbnQx\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"ref\":\"topic-branch\",\"task\":\"deploy\",\"payload\":{},\"original_environment\":\"staging\",\"environment\":\"production\",\"description\":\"Deploy request from hubot\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"statuses_url\":\"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"transient_environment\":false,\"production_environment\":true}]" + } + ] + } + ], "renamed": null }, { - "name": "Set selected repositories for an organization secret", + "name": "Set allowed actions and reusable workflows for an organization", "scope": "actions", - "id": "setSelectedReposForOrgSecret", + "id": "setAllowedActionsOrganization", "method": "PUT", - "url": "/orgs/{org}/actions/secrets/{secret_name}/repositories", + "url": "/orgs/{org}/actions/permissions/selected-actions", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret", + "description": "Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nIf the organization belongs to an enterprise that has `selected` actions and reusable workflows set at the enterprise level, then you cannot override any of the enterprise's allowed actions and reusable workflows settings.\n\nTo use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#set-allowed-actions-for-an-organization", "previews": [], "headers": [], "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -4984,11 +5830,11 @@ "deprecated": null }, { - "name": "secret_name", - "description": "secret_name parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "github_owned_allowed", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", + "in": "BODY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -4997,11 +5843,24 @@ "deprecated": null }, { - "name": "selected_repository_ids", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", + "name": "verified_allowed", + "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators.", "in": "BODY", - "type": "integer[]", - "required": true, + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "patterns_allowed", + "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "in": "BODY", + "type": "string[]", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -5014,22 +5873,22 @@ "renamed": null }, { - "name": "Set selected repositories enabled for GitHub Actions in an organization", + "name": "Set allowed actions and reusable workflows for a repository", "scope": "actions", - "id": "setSelectedRepositoriesEnabledGithubActionsOrganization", + "id": "setAllowedActionsRepository", "method": "PUT", - "url": "/orgs/{org}/actions/permissions/repositories", + "url": "/repos/{owner}/{repo}/actions/permissions/selected-actions", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#set-selected-repositories-enabled-for-github-actions-in-an-organization", + "description": "Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nIf the repository belongs to an organization or enterprise that has `selected` actions and reusable workflows set at the organization or enterprise levels, then you cannot override any of the allowed actions and reusable workflows settings.\n\nTo use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#set-allowed-actions-for-a-repository", "previews": [], "headers": [], "parameters": [ { - "name": "org", - "description": "", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -5041,10 +5900,10 @@ "deprecated": null }, { - "name": "selected_repository_ids", - "description": "List of repository IDs to enable for GitHub Actions.", - "in": "BODY", - "type": "integer[]", + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -5052,28 +5911,67 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "github_owned_allowed", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "verified_allowed", + "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "patterns_allowed", + "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [{ "code": 204, "description": "Response", "examples": null }], "renamed": null }, { - "name": "Check if a repository is starred by the authenticated user", - "scope": "activity", - "id": "checkRepoIsStarredByAuthenticatedUser", - "method": "GET", - "url": "/user/starred/{owner}/{repo}", + "name": "Set custom labels for a self-hosted runner for an organization", + "scope": "actions", + "id": "setCustomLabelsForSelfHostedRunnerForOrg", + "method": "PUT", + "url": "/orgs/{org}/actions/runners/{runner_id}/labels", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/activity#check-if-a-repository-is-starred-by-the-authenticated-user", + "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-an-organization", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -5085,10 +5983,23 @@ "deprecated": null }, { - "name": "repo", - "description": "", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "PATH", - "type": "string", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "labels", + "description": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.", + "in": "BODY", + "type": "string[]", "required": true, "enum": null, "allowNull": false, @@ -5100,42 +6011,36 @@ ], "responses": [ { - "code": 204, - "description": "Response if this repository is starred by you", - "examples": null - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_count\":4,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" + } + ] }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 404, - "description": "Not Found if this repository is not starred by you", - "examples": null - } + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 422, "description": "Validation failed", "examples": null } ], "renamed": null }, { - "name": "Delete a repository subscription", - "scope": "activity", - "id": "deleteRepoSubscription", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/subscription", + "name": "Set custom labels for a self-hosted runner for a repository", + "scope": "actions", + "id": "setCustomLabelsForSelfHostedRunnerForRepo", + "method": "PUT", + "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/reference/activity#set-a-repository-subscription).", - "documentationUrl": "https://docs.github.com/rest/reference/activity#delete-a-repository-subscription", + "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-a-repository", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -5148,7 +6053,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -5158,28 +6063,10 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a thread subscription", - "scope": "activity", - "id": "deleteThreadSubscription", - "method": "DELETE", - "url": "/notifications/threads/{thread_id}/subscription", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/reference/activity#set-a-thread-subscription) endpoint and set `ignore` to `true`.", - "documentationUrl": "https://docs.github.com/rest/reference/activity#delete-a-thread-subscription", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "thread_id", - "description": "thread_id parameter", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "PATH", "type": "integer", "required": true, @@ -5189,64 +6076,53 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null } + { + "name": "labels", + "description": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.", + "in": "BODY", + "type": "string[]", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } ], - "renamed": null - }, - { - "name": "Get feeds", - "scope": "activity", - "id": "getFeeds", - "method": "GET", - "url": "/feeds", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:\n\n* **Timeline**: The GitHub global public timeline\n* **User**: The public timeline for any user, using [URI template](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia)\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", - "documentationUrl": "https://docs.github.com/rest/reference/activity#get-feeds", - "previews": [], - "headers": [], - "parameters": [], "responses": [ { "code": 200, "description": "Response", "examples": [ { - "data": "{\"timeline_url\":\"https://github.com/timeline\",\"user_url\":\"https://github.com/{user}\",\"current_user_public_url\":\"https://github.com/octocat\",\"current_user_url\":\"https://github.com/octocat.private?token=abc123\",\"current_user_actor_url\":\"https://github.com/octocat.private.actor?token=abc123\",\"current_user_organization_url\":\"\",\"current_user_organization_urls\":[\"https://github.com/organizations/github/octocat.private.atom?token=abc123\"],\"security_advisories_url\":\"https://github.com/security-advisories\",\"_links\":{\"timeline\":{\"href\":\"https://github.com/timeline\",\"type\":\"application/atom+xml\"},\"user\":{\"href\":\"https://github.com/{user}\",\"type\":\"application/atom+xml\"},\"current_user_public\":{\"href\":\"https://github.com/octocat\",\"type\":\"application/atom+xml\"},\"current_user\":{\"href\":\"https://github.com/octocat.private?token=abc123\",\"type\":\"application/atom+xml\"},\"current_user_actor\":{\"href\":\"https://github.com/octocat.private.actor?token=abc123\",\"type\":\"application/atom+xml\"},\"current_user_organization\":{\"href\":\"\",\"type\":\"\"},\"current_user_organizations\":[{\"href\":\"https://github.com/organizations/github/octocat.private.atom?token=abc123\",\"type\":\"application/atom+xml\"}],\"security_advisories\":{\"href\":\"https://github.com/security-advisories\",\"type\":\"application/atom+xml\"}}}" + "data": "{\"total_count\":4,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" } ] - } + }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 422, "description": "Validation failed", "examples": null } ], "renamed": null }, { - "name": "Get a repository subscription", - "scope": "activity", - "id": "getRepoSubscription", - "method": "GET", - "url": "/repos/{owner}/{repo}/subscription", + "name": "Set default workflow permissions for an enterprise", + "scope": "actions", + "id": "setGithubActionsDefaultWorkflowPermissionsEnterprise", + "method": "PUT", + "url": "/enterprises/{enterprise}/actions/permissions/workflow", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/activity#get-a-repository-subscription", + "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, and sets\nwhether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\nGitHub Apps must have the `enterprise_administration:write` permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#set-default-workflow-permissions-for-an-enterprise", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "", + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "PATH", "type": "string", "required": true, @@ -5258,11 +6134,24 @@ "deprecated": null }, { - "name": "repo", - "description": "", - "in": "PATH", + "name": "default_workflow_permissions", + "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", + "in": "BODY", "type": "string", - "required": true, + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "can_approve_pull_request_reviews", + "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.", + "in": "BODY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -5272,43 +6161,29 @@ } ], "responses": [ - { - "code": 200, - "description": "if you subscribe to the repository", - "examples": [ - { - "data": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/repos/octocat/example/subscription\",\"repository_url\":\"https://api.github.com/repos/octocat/example\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 404, - "description": "Not Found if you don't subscribe to the repository", - "examples": null - } + { "code": 204, "description": "Success response", "examples": null } ], "renamed": null }, { - "name": "Get a thread", - "scope": "activity", - "id": "getThread", - "method": "GET", - "url": "/notifications/threads/{thread_id}", + "name": "Set default workflow permissions for an organization", + "scope": "actions", + "id": "setGithubActionsDefaultWorkflowPermissionsOrganization", + "method": "PUT", + "url": "/orgs/{org}/actions/permissions/workflow", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/activity#get-a-thread", + "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#set-default-workflow-permissions", "previews": [], "headers": [], "parameters": [ { - "name": "thread_id", - "description": "thread_id parameter", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -5316,48 +6191,26 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":\"1\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"subject\":{\"title\":\"Greetings\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/123\",\"latest_comment_url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/comments/123\",\"type\":\"Issue\"},\"reason\":\"subscribed\",\"unread\":true,\"updated_at\":\"2014-11-07T22:01:45Z\",\"last_read_at\":\"2014-11-07T22:01:45Z\",\"url\":\"https://api.github.com/notifications/threads/1\",\"subscription_url\":\"https://api.github.com/notifications/threads/1/subscription\"}" - } - ] }, - { "code": 304, "description": "Not modified", "examples": null }, { - "code": 401, - "description": "Requires authentication", - "examples": null + "name": "default_workflow_permissions", + "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a thread subscription for the authenticated user", - "scope": "activity", - "id": "getThreadSubscriptionForAuthenticatedUser", - "method": "GET", - "url": "/notifications/threads/{thread_id}/subscription", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/reference/activity#get-a-repository-subscription).\n\nNote that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.", - "documentationUrl": "https://docs.github.com/rest/reference/activity#get-a-thread-subscription-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ { - "name": "thread_id", - "description": "thread_id parameter", - "in": "PATH", - "type": "integer", - "required": true, + "name": "can_approve_pull_request_reviews", + "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.", + "in": "BODY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -5367,42 +6220,32 @@ } ], "responses": [ + { "code": 204, "description": "Success response", "examples": null }, { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/notifications/threads/1/subscription\",\"thread_url\":\"https://api.github.com/notifications/threads/1\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", + "code": 409, + "description": "Conflict response when changing a setting is prevented by the owning enterprise", "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } + } ], "renamed": null }, { - "name": "List events for the authenticated user", - "scope": "activity", - "id": "listEventsForAuthenticatedUser", - "method": "GET", - "url": "/users/{username}/events", + "name": "Set default workflow permissions for a repository", + "scope": "actions", + "id": "setGithubActionsDefaultWorkflowPermissionsRepository", + "method": "PUT", + "url": "/repos/{owner}/{repo}/actions/permissions/workflow", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.", - "documentationUrl": "https://docs.github.com/rest/reference/activity#list-events-for-the-authenticated-user", + "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#set-default-workflow-permissions-for-a-repository", "previews": [], "headers": [], "parameters": [ { - "name": "username", - "description": "", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -5414,11 +6257,11 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -5427,10 +6270,23 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", + "name": "default_workflow_permissions", + "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "can_approve_pull_request_reviews", + "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.", + "in": "BODY", + "type": "boolean", "required": false, "enum": null, "allowNull": false, @@ -5440,29 +6296,36 @@ "deprecated": null } ], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { "code": 204, "description": "Success response", "examples": null }, + { + "code": 409, + "description": "Conflict response when changing a setting is prevented by the owning organization or enterprise", + "examples": null + } + ], "renamed": null }, { - "name": "List notifications for the authenticated user", - "scope": "activity", - "id": "listNotificationsForAuthenticatedUser", - "method": "GET", - "url": "/notifications", + "name": "Set GitHub Actions permissions for an organization", + "scope": "actions", + "id": "setGithubActionsPermissionsOrganization", + "method": "PUT", + "url": "/orgs/{org}/actions/permissions", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "List all notifications for the current user, sorted by most recently updated.", - "documentationUrl": "https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user", + "description": "Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.\n\nIf the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions and reusable workflows, then you cannot override them for the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#set-github-actions-permissions-for-an-organization", "previews": [], "headers": [], "parameters": [ { - "name": "all", - "description": "If `true`, show notifications marked as read.", - "in": "QUERY", - "type": "boolean", - "required": false, + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -5471,12 +6334,12 @@ "deprecated": null }, { - "name": "participating", - "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, + "name": "enabled_repositories", + "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.", + "in": "BODY", + "type": "string", + "required": true, + "enum": ["all", "none", "selected"], "allowNull": false, "mapToData": null, "validation": null, @@ -5484,11 +6347,42 @@ "deprecated": null }, { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", + "name": "allowed_actions", + "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", + "in": "BODY", "type": "string", "required": false, + "enum": ["all", "local_only", "selected"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [{ "code": 204, "description": "Response", "examples": null }], + "renamed": null + }, + { + "name": "Set GitHub Actions permissions for a repository", + "scope": "actions", + "id": "setGithubActionsPermissionsRepository", + "method": "PUT", + "url": "/repos/{owner}/{repo}/actions/permissions", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository.\n\nIf the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions and reusable workflows, then you cannot override them for the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#set-github-actions-permissions-for-a-repository", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -5497,11 +6391,11 @@ "deprecated": null }, { - "name": "before", - "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -5510,11 +6404,11 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "enabled", + "description": "Whether GitHub Actions is enabled on the repository.", + "in": "BODY", + "type": "boolean", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -5523,12 +6417,12 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", + "name": "allowed_actions", + "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", + "in": "BODY", + "type": "string", "required": false, - "enum": null, + "enum": ["all", "local_only", "selected"], "allowNull": false, "mapToData": null, "validation": null, @@ -5536,44 +6430,26 @@ "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":\"1\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"subject\":{\"title\":\"Greetings\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/123\",\"latest_comment_url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/comments/123\",\"type\":\"Issue\"},\"reason\":\"subscribed\",\"unread\":true,\"updated_at\":\"2014-11-07T22:01:45Z\",\"last_read_at\":\"2014-11-07T22:01:45Z\",\"url\":\"https://api.github.com/notifications/threads/1\",\"subscription_url\":\"https://api.github.com/notifications/threads/1/subscription\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], + "responses": [{ "code": 204, "description": "Response", "examples": null }], "renamed": null }, { - "name": "List organization events for the authenticated user", - "scope": "activity", - "id": "listOrgEventsForAuthenticatedUser", - "method": "GET", - "url": "/users/{username}/events/orgs/{org}", + "name": "Set selected repositories for an organization secret", + "scope": "actions", + "id": "setSelectedReposForOrgSecret", + "method": "PUT", + "url": "/orgs/{org}/actions/secrets/{secret_name}/repositories", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.", - "documentationUrl": "https://docs.github.com/rest/reference/activity#list-organization-events-for-the-authenticated-user", + "description": "Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret", "previews": [], "headers": [], "parameters": [ { - "name": "username", - "description": "", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -5585,8 +6461,8 @@ "deprecated": null }, { - "name": "org", - "description": "", + "name": "secret_name", + "description": "The name of the secret.", "in": "PATH", "type": "string", "required": true, @@ -5598,24 +6474,11 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "selected_repository_ids", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", + "in": "BODY", + "type": "integer[]", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -5624,29 +6487,29 @@ "deprecated": null } ], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [{ "code": 204, "description": "Response", "examples": null }], "renamed": null }, { - "name": "List public events", - "scope": "activity", - "id": "listPublicEvents", - "method": "GET", - "url": "/events", + "name": "Set selected repositories enabled for GitHub Actions in an organization", + "scope": "actions", + "id": "setSelectedRepositoriesEnabledGithubActionsOrganization", + "method": "PUT", + "url": "/orgs/{org}/actions/permissions/repositories", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.", - "documentationUrl": "https://docs.github.com/rest/reference/activity#list-public-events", + "description": "Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#set-selected-repositories-enabled-for-github-actions-in-an-organization", "previews": [], "headers": [], "parameters": [ { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -5655,11 +6518,11 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "selected_repository_ids", + "description": "List of repository IDs to enable for GitHub Actions.", + "in": "BODY", + "type": "integer[]", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -5668,31 +6531,26 @@ "deprecated": null } ], - "responses": [ - { "code": 200, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], + "responses": [{ "code": 204, "description": "Response", "examples": null }], "renamed": null }, { - "name": "List public events for a network of repositories", - "scope": "activity", - "id": "listPublicEventsForRepoNetwork", - "method": "GET", - "url": "/networks/{owner}/{repo}/events", + "name": "Set the level of access for workflows outside of the repository", + "scope": "actions", + "id": "setWorkflowAccessToRepository", + "method": "PUT", + "url": "/repos/{owner}/{repo}/actions/permissions/access", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/activity#list-public-events-for-a-network-of-repositories", + "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal repositories. For more information, see \"[Managing GitHub Actions settings for a repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#set-workflow-access-to-a-repository", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -5705,7 +6563,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -5717,25 +6575,12 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, + "name": "access_level", + "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository. `none` means access is only possible from workflows in this repository.", + "in": "BODY", + "type": "string", + "required": true, + "enum": ["none", "organization", "enterprise"], "allowNull": false, "mapToData": null, "validation": null, @@ -5743,32 +6588,26 @@ "deprecated": null } ], - "responses": [ - { "code": 200, "description": "Response", "examples": null }, - { "code": 301, "description": "Moved permanently", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], + "responses": [{ "code": 204, "description": "Response", "examples": null }], "renamed": null }, { - "name": "List public events for a user", + "name": "Check if a repository is starred by the authenticated user", "scope": "activity", - "id": "listPublicEventsForUser", + "id": "checkRepoIsStarredByAuthenticatedUser", "method": "GET", - "url": "/users/{username}/events/public", + "url": "/user/starred/{owner}/{repo}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/activity#list-public-events-for-a-user", + "documentationUrl": "https://docs.github.com/rest/reference/activity#check-if-a-repository-is-starred-by-the-authenticated-user", "previews": [], "headers": [], "parameters": [ { - "name": "username", - "description": "", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -5780,52 +6619,57 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null + } + ], + "responses": [ + { + "code": 204, + "description": "Response if this repository is starred by you", + "examples": null }, + { "code": 304, "description": "Not modified", "examples": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { + "code": 404, + "description": "Not Found if this repository is not starred by you", + "examples": null } ], - "responses": [{ "code": 200, "description": "Response", "examples": null }], "renamed": null }, { - "name": "List public organization events", + "name": "Delete a repository subscription", "scope": "activity", - "id": "listPublicOrgEvents", - "method": "GET", - "url": "/orgs/{org}/events", + "id": "deleteRepoSubscription", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/subscription", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/activity#list-public-organization-events", + "description": "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/reference/activity#set-a-repository-subscription).", + "documentationUrl": "https://docs.github.com/rest/reference/activity#delete-a-repository-subscription", "previews": [], "headers": [], "parameters": [ { - "name": "org", - "description": "", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -5837,24 +6681,11 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -5863,28 +6694,28 @@ "deprecated": null } ], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [{ "code": 204, "description": "Response", "examples": null }], "renamed": null }, { - "name": "List events received by the authenticated user", + "name": "Delete a thread subscription", "scope": "activity", - "id": "listReceivedEventsForUser", - "method": "GET", - "url": "/users/{username}/received_events", + "id": "deleteThreadSubscription", + "method": "DELETE", + "url": "/notifications/threads/{thread_id}/subscription", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.", - "documentationUrl": "https://docs.github.com/rest/reference/activity#list-events-received-by-the-authenticated-user", + "description": "Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/reference/activity#set-a-thread-subscription) endpoint and set `ignore` to `true`.", + "documentationUrl": "https://docs.github.com/rest/reference/activity#delete-a-thread-subscription", "previews": [], "headers": [], "parameters": [ { - "name": "username", - "description": "", + "name": "thread_id", + "description": "The unique identifier of the thread.", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -5892,54 +6723,64 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ + { "code": 204, "description": "Response", "examples": null }, + { "code": 304, "description": "Not modified", "examples": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null + "code": 401, + "description": "Requires authentication", + "examples": null }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } + { "code": 403, "description": "Forbidden", "examples": null } ], - "responses": [{ "code": 200, "description": "Response", "examples": null }], "renamed": null }, { - "name": "List public events received by a user", + "name": "Get feeds", "scope": "activity", - "id": "listReceivedPublicEventsForUser", + "id": "getFeeds", "method": "GET", - "url": "/users/{username}/received_events/public", + "url": "/feeds", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:\n\n* **Timeline**: The GitHub global public timeline\n* **User**: The public timeline for any user, using [URI template](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia)\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", + "documentationUrl": "https://docs.github.com/rest/reference/activity#get-feeds", + "previews": [], + "headers": [], + "parameters": [], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"timeline_url\":\"https://github.com/timeline\",\"user_url\":\"https://github.com/{user}\",\"current_user_public_url\":\"https://github.com/octocat\",\"current_user_url\":\"https://github.com/octocat.private?token=abc123\",\"current_user_actor_url\":\"https://github.com/octocat.private.actor?token=abc123\",\"current_user_organization_url\":\"\",\"current_user_organization_urls\":[\"https://github.com/organizations/github/octocat.private.atom?token=abc123\"],\"security_advisories_url\":\"https://github.com/security-advisories\",\"_links\":{\"timeline\":{\"href\":\"https://github.com/timeline\",\"type\":\"application/atom+xml\"},\"user\":{\"href\":\"https://github.com/{user}\",\"type\":\"application/atom+xml\"},\"current_user_public\":{\"href\":\"https://github.com/octocat\",\"type\":\"application/atom+xml\"},\"current_user\":{\"href\":\"https://github.com/octocat.private?token=abc123\",\"type\":\"application/atom+xml\"},\"current_user_actor\":{\"href\":\"https://github.com/octocat.private.actor?token=abc123\",\"type\":\"application/atom+xml\"},\"current_user_organization\":{\"href\":\"\",\"type\":\"\"},\"current_user_organizations\":[{\"href\":\"https://github.com/organizations/github/octocat.private.atom?token=abc123\",\"type\":\"application/atom+xml\"}],\"security_advisories\":{\"href\":\"https://github.com/security-advisories\",\"type\":\"application/atom+xml\"}}}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Get a repository subscription", + "scope": "activity", + "id": "getRepoSubscription", + "method": "GET", + "url": "/repos/{owner}/{repo}/subscription", "isDeprecated": false, "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/activity#list-public-events-received-by-a-user", + "documentationUrl": "https://docs.github.com/rest/reference/activity#get-a-repository-subscription", "previews": [], "headers": [], "parameters": [ { - "name": "username", - "description": "", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -5951,24 +6792,58 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "if you subscribe to the repository", + "examples": [ + { + "data": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/repos/octocat/example/subscription\",\"repository_url\":\"https://api.github.com/repos/octocat/example\"}" + } + ] }, + { "code": 403, "description": "Forbidden", "examples": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", + "code": 404, + "description": "Not Found if you don't subscribe to the repository", + "examples": null + } + ], + "renamed": null + }, + { + "name": "Get a thread", + "scope": "activity", + "id": "getThread", + "method": "GET", + "url": "/notifications/threads/{thread_id}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "", + "documentationUrl": "https://docs.github.com/rest/reference/activity#get-a-thread", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "thread_id", + "description": "The unique identifier of the thread.", + "in": "PATH", "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -5977,28 +6852,45 @@ "deprecated": null } ], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"id\":\"1\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"subject\":{\"title\":\"Greetings\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/123\",\"latest_comment_url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/comments/123\",\"type\":\"Issue\"},\"reason\":\"subscribed\",\"unread\":true,\"updated_at\":\"2014-11-07T22:01:45Z\",\"last_read_at\":\"2014-11-07T22:01:45Z\",\"url\":\"https://api.github.com/notifications/threads/1\",\"subscription_url\":\"https://api.github.com/notifications/threads/1/subscription\"}" + } + ] + }, + { "code": 304, "description": "Not modified", "examples": null }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null } + ], "renamed": null }, { - "name": "List repository events", + "name": "Get a thread subscription for the authenticated user", "scope": "activity", - "id": "listRepoEvents", + "id": "getThreadSubscriptionForAuthenticatedUser", "method": "GET", - "url": "/repos/{owner}/{repo}/events", + "url": "/notifications/threads/{thread_id}/subscription", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/activity#list-repository-events", + "description": "This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/reference/activity#get-a-repository-subscription).\n\nNote that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.", + "documentationUrl": "https://docs.github.com/rest/reference/activity#get-a-thread-subscription-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "", + "name": "thread_id", + "description": "The unique identifier of the thread.", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -6006,10 +6898,45 @@ "validation": null, "alias": null, "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/notifications/threads/1/subscription\",\"thread_url\":\"https://api.github.com/notifications/threads/1\"}" + } + ] }, + { "code": 304, "description": "Not modified", "examples": null }, { - "name": "repo", - "description": "", + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null } + ], + "renamed": null + }, + { + "name": "List events for the authenticated user", + "scope": "activity", + "id": "listEventsForAuthenticatedUser", + "method": "GET", + "url": "/users/{username}/events", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.", + "documentationUrl": "https://docs.github.com/rest/reference/activity#list-events-for-the-authenticated-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -6022,7 +6949,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -6051,45 +6978,19 @@ "renamed": null }, { - "name": "List repository notifications for the authenticated user", + "name": "List notifications for the authenticated user", "scope": "activity", - "id": "listRepoNotificationsForAuthenticatedUser", + "id": "listNotificationsForAuthenticatedUser", "method": "GET", - "url": "/repos/{owner}/{repo}/notifications", + "url": "/notifications", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "List all notifications for the current user.", - "documentationUrl": "https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user", + "description": "List all notifications for the current user, sorted by most recently updated.", + "documentationUrl": "https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "all", "description": "If `true`, show notifications marked as read.", @@ -6144,7 +7045,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -6178,31 +7079,39 @@ "data": "[{\"id\":\"1\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"subject\":{\"title\":\"Greetings\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/123\",\"latest_comment_url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/comments/123\",\"type\":\"Issue\"},\"reason\":\"subscribed\",\"unread\":true,\"updated_at\":\"2014-11-07T22:01:45Z\",\"last_read_at\":\"2014-11-07T22:01:45Z\",\"url\":\"https://api.github.com/notifications/threads/1\",\"subscription_url\":\"https://api.github.com/notifications/threads/1/subscription\"}]" } ] - } + }, + { "code": 304, "description": "Not modified", "examples": null }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 422, "description": "Validation failed", "examples": null } ], "renamed": null }, { - "name": "List repositories starred by the authenticated user", + "name": "List organization events for the authenticated user", "scope": "activity", - "id": "listReposStarredByAuthenticatedUser", + "id": "listOrgEventsForAuthenticatedUser", "method": "GET", - "url": "/user/starred", + "url": "/users/{username}/events/orgs/{org}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists repositories the authenticated user has starred.\n\nYou can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header:", - "documentationUrl": "https://docs.github.com/rest/reference/activity#list-repositories-starred-by-the-authenticated-user", + "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.", + "documentationUrl": "https://docs.github.com/rest/reference/activity#list-organization-events-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ { - "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", - "in": "QUERY", + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "PATH", "type": "string", - "required": false, - "enum": ["created", "updated"], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -6210,12 +7119,12 @@ "deprecated": null }, { - "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", - "in": "QUERY", + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", "type": "string", - "required": false, - "enum": ["asc", "desc"], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -6224,7 +7133,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -6249,55 +7158,29 @@ "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]" - } - ] - }, - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"starred_at\":\"2011-01-16T19:06:43Z\",\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], + "responses": [{ "code": 200, "description": "Response", "examples": null }], "renamed": null }, { - "name": "List repositories starred by a user", + "name": "List public events", "scope": "activity", - "id": "listReposStarredByUser", + "id": "listPublicEvents", "method": "GET", - "url": "/users/{username}/starred", + "url": "/events", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists repositories a user has starred.\n\nYou can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header:", - "documentationUrl": "https://docs.github.com/rest/reference/activity#list-repositories-starred-by-a-user", + "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.", + "documentationUrl": "https://docs.github.com/rest/reference/activity#list-public-events", "previews": [], "headers": [], "parameters": [ { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -6306,12 +7189,48 @@ "deprecated": null }, { - "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", + "name": "page", + "description": "Page number of the results to fetch.", "in": "QUERY", - "type": "string", + "type": "integer", "required": false, - "enum": ["created", "updated"], + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { "code": 200, "description": "Response", "examples": null }, + { "code": 304, "description": "Not modified", "examples": null }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 503, "description": "Service unavailable", "examples": null } + ], + "renamed": null + }, + { + "name": "List public events for a network of repositories", + "scope": "activity", + "id": "listPublicEventsForRepoNetwork", + "method": "GET", + "url": "/networks/{owner}/{repo}/events", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "", + "documentationUrl": "https://docs.github.com/rest/reference/activity#list-public-events-for-a-network-of-repositories", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -6319,12 +7238,12 @@ "deprecated": null }, { - "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", - "in": "QUERY", + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", "type": "string", - "required": false, - "enum": ["asc", "desc"], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -6333,7 +7252,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -6359,35 +7278,31 @@ } ], "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]" - } - ] - } + { "code": 200, "description": "Response", "examples": null }, + { "code": 301, "description": "Moved permanently", "examples": null }, + { "code": 304, "description": "Not modified", "examples": null }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } ], "renamed": null }, { - "name": "List repositories watched by a user", + "name": "List public events for a user", "scope": "activity", - "id": "listReposWatchedByUser", + "id": "listPublicEventsForUser", "method": "GET", - "url": "/users/{username}/subscriptions", + "url": "/users/{username}/events/public", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists repositories a user is watching.", - "documentationUrl": "https://docs.github.com/rest/reference/activity#list-repositories-watched-by-a-user", + "description": "", + "documentationUrl": "https://docs.github.com/rest/reference/activity#list-public-events-for-a-user", "previews": [], "headers": [], "parameters": [ { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -6400,7 +7315,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -6425,36 +7340,26 @@ "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}]" - } - ] - } - ], + "responses": [{ "code": 200, "description": "Response", "examples": null }], "renamed": null }, { - "name": "List stargazers", + "name": "List public organization events", "scope": "activity", - "id": "listStargazersForRepo", + "id": "listPublicOrgEvents", "method": "GET", - "url": "/repos/{owner}/{repo}/stargazers", + "url": "/orgs/{org}/events", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the people that have starred the repository.\n\nYou can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header:", - "documentationUrl": "https://docs.github.com/rest/reference/activity#list-stargazers", + "description": "", + "documentationUrl": "https://docs.github.com/rest/reference/activity#list-public-organization-events", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -6466,8 +7371,52 @@ "deprecated": null }, { - "name": "repo", - "description": "", + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [{ "code": 200, "description": "Response", "examples": null }], + "renamed": null + }, + { + "name": "List events received by the authenticated user", + "scope": "activity", + "id": "listReceivedEventsForUser", + "method": "GET", + "url": "/users/{username}/received_events", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.", + "documentationUrl": "https://docs.github.com/rest/reference/activity#list-events-received-by-the-authenticated-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -6480,7 +7429,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -6505,40 +7454,39 @@ "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - }, - { - "data": "[{\"starred_at\":\"2011-01-16T19:06:43Z\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]" - } - ] - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], + "responses": [{ "code": 200, "description": "Response", "examples": null }], "renamed": null }, { - "name": "List repositories watched by the authenticated user", + "name": "List public events received by a user", "scope": "activity", - "id": "listWatchedReposForAuthenticatedUser", + "id": "listReceivedPublicEventsForUser", "method": "GET", - "url": "/user/subscriptions", + "url": "/users/{username}/received_events/public", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists repositories the authenticated user is watching.", - "documentationUrl": "https://docs.github.com/rest/reference/activity#list-repositories-watched-by-the-authenticated-user", + "description": "", + "documentationUrl": "https://docs.github.com/rest/reference/activity#list-public-events-received-by-a-user", "previews": [], "headers": [], "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -6563,43 +7511,26 @@ "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], + "responses": [{ "code": 200, "description": "Response", "examples": null }], "renamed": null }, { - "name": "List watchers", + "name": "List repository events", "scope": "activity", - "id": "listWatchersForRepo", + "id": "listRepoEvents", "method": "GET", - "url": "/repos/{owner}/{repo}/subscribers", + "url": "/repos/{owner}/{repo}/events", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the people watching the specified repository.", - "documentationUrl": "https://docs.github.com/rest/reference/activity#list-watchers", + "description": "", + "documentationUrl": "https://docs.github.com/rest/reference/activity#list-repository-events", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -6612,7 +7543,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -6625,7 +7556,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -6650,90 +7581,26 @@ "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - } - ], + "responses": [{ "code": 200, "description": "Response", "examples": null }], "renamed": null }, { - "name": "Mark notifications as read", + "name": "List repository notifications for the authenticated user", "scope": "activity", - "id": "markNotificationsAsRead", - "method": "PUT", - "url": "/notifications", + "id": "listRepoNotificationsForAuthenticatedUser", + "method": "GET", + "url": "/repos/{owner}/{repo}/notifications", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Marks all notifications as \"read\" removes it from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", - "documentationUrl": "https://docs.github.com/rest/reference/activity#mark-notifications-as-read", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "last_read_at", - "description": "Describes the last point that notifications were checked.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "read", - "description": "Whether the notification has been read.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 202, "description": "Response", "examples": null }, - { "code": 205, "description": "Reset Content", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Mark repository notifications as read", - "scope": "activity", - "id": "markRepoNotificationsAsRead", - "method": "PUT", - "url": "/repos/{owner}/{repo}/notifications", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", - "documentationUrl": "https://docs.github.com/rest/reference/activity#mark-repository-notifications-as-read", + "description": "List all notifications for the current user.", + "documentationUrl": "https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -6746,7 +7613,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -6758,10 +7625,10 @@ "deprecated": null }, { - "name": "last_read_at", - "description": "Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", - "in": "BODY", - "type": "string", + "name": "all", + "description": "If `true`, show notifications marked as read.", + "in": "QUERY", + "type": "boolean", "required": false, "enum": null, "allowNull": false, @@ -6769,69 +7636,26 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { "code": 202, "description": "Response", "examples": null }, - { "code": 205, "description": "Reset Content", "examples": null } - ], - "renamed": null - }, - { - "name": "Mark a thread as read", - "scope": "activity", - "id": "markThreadAsRead", - "method": "PATCH", - "url": "/notifications/threads/{thread_id}", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/activity#mark-a-thread-as-read", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "thread_id", - "description": "thread_id parameter", - "in": "PATH", - "type": "integer", - "required": true, + "name": "participating", + "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", + "in": "QUERY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { "code": 205, "description": "Reset Content", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Set a repository subscription", - "scope": "activity", - "id": "setRepoSubscription", - "method": "PUT", - "url": "/repos/{owner}/{repo}/subscription", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/reference/activity#delete-a-repository-subscription) completely.", - "documentationUrl": "https://docs.github.com/rest/reference/activity#set-a-repository-subscription", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "owner", - "description": "", - "in": "PATH", + "name": "since", + "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "QUERY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -6840,11 +7664,11 @@ "deprecated": null }, { - "name": "repo", - "description": "", - "in": "PATH", + "name": "before", + "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "QUERY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -6853,10 +7677,10 @@ "deprecated": null }, { - "name": "subscribed", - "description": "Determines if notifications should be received from this repository.", - "in": "BODY", - "type": "boolean", + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -6866,10 +7690,10 @@ "deprecated": null }, { - "name": "ignored", - "description": "Determines if all notifications should be blocked from this repository.", - "in": "BODY", - "type": "boolean", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -6885,7 +7709,7 @@ "description": "Response", "examples": [ { - "data": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/repos/octocat/example/subscription\",\"repository_url\":\"https://api.github.com/repos/octocat/example\"}" + "data": "[{\"id\":\"1\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"subject\":{\"title\":\"Greetings\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/123\",\"latest_comment_url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/comments/123\",\"type\":\"Issue\"},\"reason\":\"subscribed\",\"unread\":true,\"updated_at\":\"2014-11-07T22:01:45Z\",\"last_read_at\":\"2014-11-07T22:01:45Z\",\"url\":\"https://api.github.com/notifications/threads/1\",\"subscription_url\":\"https://api.github.com/notifications/threads/1/subscription\"}]" } ] } @@ -6893,25 +7717,51 @@ "renamed": null }, { - "name": "Set a thread subscription", + "name": "List repositories starred by the authenticated user", "scope": "activity", - "id": "setThreadSubscription", - "method": "PUT", - "url": "/notifications/threads/{thread_id}/subscription", + "id": "listReposStarredByAuthenticatedUser", + "method": "GET", + "url": "/user/starred", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.\n\nYou can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.\n\nUnsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/reference/activity#delete-a-thread-subscription) endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/activity#set-a-thread-subscription", + "description": "Lists repositories the authenticated user has starred.\n\nYou can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header:", + "documentationUrl": "https://docs.github.com/rest/reference/activity#list-repositories-starred-by-the-authenticated-user", "previews": [], "headers": [], "parameters": [ { - "name": "thread_id", - "description": "thread_id parameter", - "in": "PATH", + "name": "sort", + "description": "The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["created", "updated"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["asc", "desc"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", "type": "integer", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -6920,10 +7770,10 @@ "deprecated": null }, { - "name": "ignored", - "description": "Whether to block all notifications from a thread.", - "in": "BODY", - "type": "boolean", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -6939,7 +7789,16 @@ "description": "Response", "examples": [ { - "data": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/notifications/threads/1/subscription\",\"thread_url\":\"https://api.github.com/notifications/threads/1\"}" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]" + } + ] + }, + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"starred_at\":\"2011-01-16T19:06:43Z\",\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}}]" } ] }, @@ -6954,22 +7813,22 @@ "renamed": null }, { - "name": "Star a repository for the authenticated user", + "name": "List repositories starred by a user", "scope": "activity", - "id": "starRepoForAuthenticatedUser", - "method": "PUT", - "url": "/user/starred/{owner}/{repo}", + "id": "listReposStarredByUser", + "method": "GET", + "url": "/users/{username}/starred", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "documentationUrl": "https://docs.github.com/rest/reference/activity#star-a-repository-for-the-authenticated-user", + "description": "Lists repositories a user has starred.\n\nYou can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header:", + "documentationUrl": "https://docs.github.com/rest/reference/activity#list-repositories-starred-by-a-user", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -6981,52 +7840,37 @@ "deprecated": null }, { - "name": "repo", - "description": "", - "in": "PATH", + "name": "sort", + "description": "The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to.", + "in": "QUERY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": ["created", "updated"], "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Unstar a repository for the authenticated user", - "scope": "activity", - "id": "unstarRepoForAuthenticatedUser", - "method": "DELETE", - "url": "/user/starred/{owner}/{repo}", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/activity#unstar-a-repository-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ { - "name": "owner", - "description": "", - "in": "PATH", + "name": "direction", + "description": "The direction to sort the results by.", + "in": "QUERY", "type": "string", - "required": true, + "required": false, + "enum": ["asc", "desc"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -7035,11 +7879,11 @@ "deprecated": null }, { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -7049,37 +7893,37 @@ } ], "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]" + } + ] + } ], "renamed": null }, { - "name": "Add a repository to an app installation", - "scope": "apps", - "id": "addRepoToInstallation", - "method": "PUT", - "url": "/user/installations/{installation_id}/repositories/{repository_id}", + "name": "List repositories watched by a user", + "scope": "activity", + "id": "listReposWatchedByUser", + "method": "GET", + "url": "/users/{username}/subscriptions", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/apps#add-a-repository-to-an-app-installation", + "description": "Lists repositories a user is watching.", + "documentationUrl": "https://docs.github.com/rest/reference/activity#list-repositories-watched-by-a-user", "previews": [], "headers": [], "parameters": [ { - "name": "installation_id", - "description": "installation_id parameter", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -7089,11 +7933,24 @@ "deprecated": null }, { - "name": "repository_id", - "description": "", - "in": "PATH", + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", "type": "integer", - "required": true, + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -7103,40 +7960,37 @@ } ], "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" + } + ] + } ], - "renamed": { - "before": { "scope": "apps", "id": "addRepoToInstallation" }, - "after": { - "scope": "apps", - "id": "addRepoToInstallationForAuthenticatedUser" - }, - "date": "2021-10-05", - "note": null - } + "renamed": null }, { - "name": "Add a repository to an app installation", - "scope": "apps", - "id": "addRepoToInstallationForAuthenticatedUser", - "method": "PUT", - "url": "/user/installations/{installation_id}/repositories/{repository_id}", + "name": "List stargazers", + "scope": "activity", + "id": "listStargazersForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/stargazers", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/apps#add-a-repository-to-an-app-installation", + "description": "Lists the people that have starred the repository.\n\nYou can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header:", + "documentationUrl": "https://docs.github.com/rest/reference/activity#list-stargazers", "previews": [], "headers": [], "parameters": [ { - "name": "installation_id", - "description": "installation_id parameter", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -7146,10 +8000,10 @@ "deprecated": null }, { - "name": "repository_id", - "description": "", + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -7157,36 +8011,13 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Check a token", - "scope": "apps", - "id": "checkToken", - "method": "POST", - "url": "/applications/{client_id}/token", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.", - "documentationUrl": "https://docs.github.com/rest/reference/apps#check-a-token", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "client_id", - "description": "The client ID of your GitHub app.", - "in": "PATH", - "type": "string", - "required": true, + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -7195,11 +8026,11 @@ "deprecated": null }, { - "name": "access_token", - "description": "The access_token of the OAuth application.", - "in": "BODY", - "type": "string", - "required": true, + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -7214,48 +8045,37 @@ "description": "Response", "examples": [ { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\",\"user\"],\"token\":\"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\"token_last_eight\":\"Ae178B4a\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\",\"expires_at\":\"2011-09-08T17:26:27Z\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" + "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" + }, + { + "data": "[{\"starred_at\":\"2011-01-16T19:06:43Z\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]" } ] }, - { "code": 404, "description": "Resource not found", "examples": null }, { "code": 422, "description": "Validation failed", "examples": null } ], "renamed": null }, { - "name": "Create a content attachment", - "scope": "apps", - "id": "createContentAttachment", - "method": "POST", - "url": "/content_references/{content_reference_id}/attachments", + "name": "List repositories watched by the authenticated user", + "scope": "activity", + "id": "listWatchedReposForAuthenticatedUser", + "method": "GET", + "url": "/user/subscriptions", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Deprecated:** use `apps.createContentAttachmentForRepo()` (`POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments`) instead. Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/apps#create-a-content-attachment", - "previews": [{ "name": "corsair" }], + "description": "Lists repositories the authenticated user is watching.", + "documentationUrl": "https://docs.github.com/rest/reference/activity#list-repositories-watched-by-the-authenticated-user", + "previews": [], "headers": [], "parameters": [ { - "name": "content_reference_id", - "description": "", - "in": "PATH", + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The title of the attachment", - "in": "BODY", - "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -7264,11 +8084,11 @@ "deprecated": null }, { - "name": "body", - "description": "The body of the attachment", - "in": "BODY", - "type": "string", - "required": true, + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -7283,40 +8103,37 @@ "description": "Response", "examples": [ { - "data": "{\"id\":101,\"title\":\"[A-1234] Error found in core/models.py file'\",\"body\":\"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"}" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" } ] }, { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, { - "code": 415, - "description": "Preview header missing", + "code": 401, + "description": "Requires authentication", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } + { "code": 403, "description": "Forbidden", "examples": null } ], "renamed": null }, { - "name": "Create a content attachment", - "scope": "apps", - "id": "createContentAttachmentForRepo", - "method": "POST", - "url": "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", + "name": "List watchers", + "scope": "activity", + "id": "listWatchersForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/subscribers", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/apps#create-a-content-attachment", - "previews": [{ "name": "corsair" }], + "description": "Lists the people watching the specified repository.", + "documentationUrl": "https://docs.github.com/rest/reference/activity#list-watchers", + "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -7329,7 +8146,7 @@ }, { "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -7341,11 +8158,11 @@ "deprecated": null }, { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "PATH", + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", "type": "integer", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -7354,24 +8171,11 @@ "deprecated": null }, { - "name": "title", - "description": "The title of the attachment", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The body of the attachment", - "in": "BODY", - "type": "string", - "required": true, + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -7386,43 +8190,46 @@ "description": "Response", "examples": [ { - "data": "{\"id\":101,\"title\":\"[A-1234] Error found in core/models.py file'\",\"body\":\"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"}" + "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" } ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, - { "code": 422, "description": "Validation failed", "examples": null } + } ], "renamed": null }, { - "name": "Create a GitHub App from a manifest", - "scope": "apps", - "id": "createFromManifest", - "method": "POST", - "url": "/app-manifests/{code}/conversions", + "name": "Mark notifications as read", + "scope": "activity", + "id": "markNotificationsAsRead", + "method": "PUT", + "url": "/notifications", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.", - "documentationUrl": "https://docs.github.com/rest/reference/apps#create-a-github-app-from-a-manifest", + "description": "Marks all notifications as \"read\" removes it from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "documentationUrl": "https://docs.github.com/rest/reference/activity#mark-notifications-as-read", "previews": [], "headers": [], "parameters": [ { - "name": "code", - "description": "", - "in": "PATH", + "name": "last_read_at", + "description": "Describes the last point that notifications were checked.", + "in": "BODY", "type": "string", - "required": true, + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "read", + "description": "Whether the notification has been read.", + "in": "BODY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -7432,39 +8239,37 @@ } ], "responses": [ + { "code": 202, "description": "Response", "examples": null }, + { "code": 205, "description": "Reset Content", "examples": null }, + { "code": 304, "description": "Not modified", "examples": null }, { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDxOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"],\"client_id\":\"Iv1.8a61f9b3a7aba766\",\"client_secret\":\"1726be1638095a19edd134c77bde3aa2ece1e5d8\",\"webhook_secret\":\"e340154128314309424b7c8e90325147d99fdafa\",\"pem\":\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEowIBAAKCAQEAuEPzOUE+kiEH1WLiMeBytTEF856j0hOVcSUSUkZxKvqczkWM\\n9vo1gDyC7ZXhdH9fKh32aapba3RSsp4ke+giSmYTk2mGR538ShSDxh0OgpJmjiKP\\nX0Bj4j5sFqfXuCtl9SkH4iueivv4R53ktqM+n6hk98l6hRwC39GVIblAh2lEM4L/\\n6WvYwuQXPMM5OG2Ryh2tDZ1WS5RKfgq+9ksNJ5Q9UtqtqHkO+E63N5OK9sbzpUUm\\noNaOl3udTlZD3A8iqwMPVxH4SxgATBPAc+bmjk6BMJ0qIzDcVGTrqrzUiywCTLma\\nszdk8GjzXtPDmuBgNn+o6s02qVGpyydgEuqmTQIDAQABAoIBACL6AvkjQVVLn8kJ\\ndBYznJJ4M8ECo+YEgaFwgAHODT0zRQCCgzd+Vxl4YwHmKV2Lr+y2s0drZt8GvYva\\nKOK8NYYZyi15IlwFyRXmvvykF1UBpSXluYFDH7KaVroWMgRreHcIys5LqVSIb6Bo\\ngDmK0yBLPp8qR29s2b7ScZRtLaqGJiX+j55rNzrZwxHkxFHyG9OG+u9IsBElcKCP\\nkYCVE8ZdYexfnKOZbgn2kZB9qu0T/Mdvki8yk3I2bI6xYO24oQmhnT36qnqWoCBX\\nNuCNsBQgpYZeZET8mEAUmo9d+ABmIHIvSs005agK8xRaP4+6jYgy6WwoejJRF5yd\\nNBuF7aECgYEA50nZ4FiZYV0vcJDxFYeY3kYOvVuKn8OyW+2rg7JIQTremIjv8FkE\\nZnwuF9ZRxgqLxUIfKKfzp/5l5LrycNoj2YKfHKnRejxRWXqG+ZETfxxlmlRns0QG\\nJ4+BYL0CoanDSeA4fuyn4Bv7cy/03TDhfg/Uq0Aeg+hhcPE/vx3ebPsCgYEAy/Pv\\neDLssOSdeyIxf0Brtocg6aPXIVaLdus+bXmLg77rJIFytAZmTTW8SkkSczWtucI3\\nFI1I6sei/8FdPzAl62/JDdlf7Wd9K7JIotY4TzT7Tm7QU7xpfLLYIP1bOFjN81rk\\n77oOD4LsXcosB/U6s1blPJMZ6AlO2EKs10UuR1cCgYBipzuJ2ADEaOz9RLWwi0AH\\nPza2Sj+c2epQD9ZivD7Zo/Sid3ZwvGeGF13JyR7kLEdmAkgsHUdu1rI7mAolXMaB\\n1pdrsHureeLxGbRM6za3tzMXWv1Il7FQWoPC8ZwXvMOR1VQDv4nzq7vbbA8z8c+c\\n57+8tALQHOTDOgQIzwK61QKBgERGVc0EJy4Uag+VY8J4m1ZQKBluqo7TfP6DQ7O8\\nM5MX73maB/7yAX8pVO39RjrhJlYACRZNMbK+v/ckEQYdJSSKmGCVe0JrGYDuPtic\\nI9+IGfSorf7KHPoMmMN6bPYQ7Gjh7a++tgRFTMEc8956Hnt4xGahy9NcglNtBpVN\\n6G8jAoGBAMCh028pdzJa/xeBHLLaVB2sc0Fe7993WlsPmnVE779dAz7qMscOtXJK\\nfgtriltLSSD6rTA9hUAsL/X62rY0wdXuNdijjBb/qvrx7CAV6i37NK1CjABNjsfG\\nZM372Ac6zc1EqSrid2IjET1YqyIW2KGLI1R2xbQc98UGlt48OdWu\\n-----END RSA PRIVATE KEY-----\\n\"}" - } - ] + "code": 401, + "description": "Requires authentication", + "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } + { "code": 403, "description": "Forbidden", "examples": null } ], "renamed": null }, { - "name": "Create an installation access token for an app", - "scope": "apps", - "id": "createInstallationAccessToken", - "method": "POST", - "url": "/app/installations/{installation_id}/access_tokens", + "name": "Mark repository notifications as read", + "scope": "activity", + "id": "markRepoNotificationsAsRead", + "method": "PUT", + "url": "/repos/{owner}/{repo}/notifications", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/apps/#create-an-installation-access-token-for-an-app", + "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "documentationUrl": "https://docs.github.com/rest/reference/activity#mark-repository-notifications-as-read", "previews": [], "headers": [], "parameters": [ { - "name": "installation_id", - "description": "installation_id parameter", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -7474,11 +8279,11 @@ "deprecated": null }, { - "name": "repositories", - "description": "List of repository names that the token should have access to", - "in": "BODY", - "type": "string[]", - "required": false, + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -7487,10 +8292,10 @@ "deprecated": null }, { - "name": "repository_ids", - "description": "List of repository IDs that the token should have access to", + "name": "last_read_at", + "description": "Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", "in": "BODY", - "type": "integer[]", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -7498,27 +8303,70 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ + { "code": 202, "description": "Response", "examples": null }, + { "code": 205, "description": "Reset Content", "examples": null } + ], + "renamed": null + }, + { + "name": "Mark a thread as read", + "scope": "activity", + "id": "markThreadAsRead", + "method": "PATCH", + "url": "/notifications/threads/{thread_id}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "", + "documentationUrl": "https://docs.github.com/rest/reference/activity#mark-a-thread-as-read", + "previews": [], + "headers": [], + "parameters": [ { - "name": "permissions", - "description": "The permissions granted to the user-to-server access token.", - "in": "BODY", - "type": "object", - "required": false, + "name": "thread_id", + "description": "The unique identifier of the thread.", + "in": "PATH", + "type": "integer", + "required": true, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ + { "code": 205, "description": "Reset Content", "examples": null }, + { "code": 304, "description": "Not modified", "examples": null }, + { "code": 403, "description": "Forbidden", "examples": null } + ], + "renamed": null + }, + { + "name": "Set a repository subscription", + "scope": "activity", + "id": "setRepoSubscription", + "method": "PUT", + "url": "/repos/{owner}/{repo}/subscription", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/reference/activity#delete-a-repository-subscription) completely.", + "documentationUrl": "https://docs.github.com/rest/reference/activity#set-a-repository-subscription", + "previews": [], + "headers": [], + "parameters": [ { - "name": "permissions.actions", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Can be one of: `read` or `write`.", - "in": "BODY", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", "type": "string", - "required": false, - "enum": ["read", "write"], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -7526,12 +8374,12 @@ "deprecated": null }, { - "name": "permissions.administration", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. Can be one of: `read` or `write`.", - "in": "BODY", + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", "type": "string", - "required": false, - "enum": ["read", "write"], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -7539,12 +8387,12 @@ "deprecated": null }, { - "name": "permissions.checks", - "description": "The level of permission to grant the access token for checks on code. Can be one of: `read` or `write`.", + "name": "subscribed", + "description": "Determines if notifications should be received from this repository.", "in": "BODY", - "type": "string", + "type": "boolean", "required": false, - "enum": ["read", "write"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -7552,25 +8400,53 @@ "deprecated": null }, { - "name": "permissions.content_references", - "description": "The level of permission to grant the access token for notification of content references and creation content attachments. Can be one of: `read` or `write`.", + "name": "ignored", + "description": "Determines if all notifications should be blocked from this repository.", "in": "BODY", - "type": "string", + "type": "boolean", "required": false, - "enum": ["read", "write"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "permissions.contents", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/repos/octocat/example/subscription\",\"repository_url\":\"https://api.github.com/repos/octocat/example\"}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Set a thread subscription", + "scope": "activity", + "id": "setThreadSubscription", + "method": "PUT", + "url": "/notifications/threads/{thread_id}/subscription", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.\n\nYou can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.\n\nUnsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/reference/activity#delete-a-thread-subscription) endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/activity#set-a-thread-subscription", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "thread_id", + "description": "The unique identifier of the thread.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -7578,25 +8454,60 @@ "deprecated": null }, { - "name": "permissions.deployments", - "description": "The level of permission to grant the access token for deployments and deployment statuses. Can be one of: `read` or `write`.", + "name": "ignored", + "description": "Whether to block all notifications from a thread.", "in": "BODY", - "type": "string", + "type": "boolean", "required": false, - "enum": ["read", "write"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/notifications/threads/1/subscription\",\"thread_url\":\"https://api.github.com/notifications/threads/1\"}" + } + ] }, + { "code": 304, "description": "Not modified", "examples": null }, { - "name": "permissions.environments", - "description": "The level of permission to grant the access token for managing repository environments. Can be one of: `read` or `write`.", - "in": "BODY", + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null } + ], + "renamed": null + }, + { + "name": "Star a repository for the authenticated user", + "scope": "activity", + "id": "starRepoForAuthenticatedUser", + "method": "PUT", + "url": "/user/starred/{owner}/{repo}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", + "documentationUrl": "https://docs.github.com/rest/reference/activity#star-a-repository-for-the-authenticated-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", "type": "string", - "required": false, - "enum": ["read", "write"], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -7604,25 +8515,53 @@ "deprecated": null }, { - "name": "permissions.issues", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. Can be one of: `read` or `write`.", - "in": "BODY", + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", "type": "string", - "required": false, - "enum": ["read", "write"], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null + } + ], + "responses": [ + { "code": 204, "description": "Response", "examples": null }, + { "code": 304, "description": "Not modified", "examples": null }, + { + "code": 401, + "description": "Requires authentication", + "examples": null }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "Unstar a repository for the authenticated user", + "scope": "activity", + "id": "unstarRepoForAuthenticatedUser", + "method": "DELETE", + "url": "/user/starred/{owner}/{repo}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "", + "documentationUrl": "https://docs.github.com/rest/reference/activity#unstar-a-repository-for-the-authenticated-user", + "previews": [], + "headers": [], + "parameters": [ { - "name": "permissions.metadata", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. Can be one of: `read` or `write`.", - "in": "BODY", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", "type": "string", - "required": false, - "enum": ["read", "write"], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -7630,25 +8569,53 @@ "deprecated": null }, { - "name": "permissions.packages", - "description": "The level of permission to grant the access token for packages published to GitHub Packages. Can be one of: `read` or `write`.", - "in": "BODY", + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", "type": "string", - "required": false, - "enum": ["read", "write"], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null + } + ], + "responses": [ + { "code": 204, "description": "Response", "examples": null }, + { "code": 304, "description": "Not modified", "examples": null }, + { + "code": 401, + "description": "Requires authentication", + "examples": null }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "Add a repository to an app installation", + "scope": "apps", + "id": "addRepoToInstallation", + "method": "PUT", + "url": "/user/installations/{installation_id}/repositories/{repository_id}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/apps#add-a-repository-to-an-app-installation", + "previews": [], + "headers": [], + "parameters": [ { - "name": "permissions.pages", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], + "name": "installation_id", + "description": "The unique identifier of the installation.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -7656,25 +8623,56 @@ "deprecated": null }, { - "name": "permissions.pull_requests", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null + } + ], + "responses": [ + { "code": 204, "description": "Response", "examples": null }, + { "code": 304, "description": "Not modified", "examples": null }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": { + "before": { "scope": "apps", "id": "addRepoToInstallation" }, + "after": { + "scope": "apps", + "id": "addRepoToInstallationForAuthenticatedUser" }, + "date": "2021-10-05", + "note": null + } + }, + { + "name": "Add a repository to an app installation", + "scope": "apps", + "id": "addRepoToInstallationForAuthenticatedUser", + "method": "PUT", + "url": "/user/installations/{installation_id}/repositories/{repository_id}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/apps#add-a-repository-to-an-app-installation", + "previews": [], + "headers": [], + "parameters": [ { - "name": "permissions.repository_hooks", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], + "name": "installation_id", + "description": "The unique identifier of the installation.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -7682,25 +8680,48 @@ "deprecated": null }, { - "name": "permissions.repository_projects", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards. Can be one of: `read`, `write`, or `admin`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "admin"], + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ + { "code": 204, "description": "Response", "examples": null }, + { "code": 304, "description": "Not modified", "examples": null }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "Check a token", + "scope": "apps", + "id": "checkToken", + "method": "POST", + "url": "/applications/{client_id}/token", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.", + "documentationUrl": "https://docs.github.com/rest/reference/apps#check-a-token", + "previews": [], + "headers": [], + "parameters": [ { - "name": "permissions.secret_scanning_alerts", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts. Can be one of: `read` or `write`.", - "in": "BODY", + "name": "client_id", + "description": "The client ID of the GitHub app.", + "in": "PATH", "type": "string", - "required": false, - "enum": ["read", "write"], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -7708,34 +8729,354 @@ "deprecated": null }, { - "name": "permissions.secrets", - "description": "The level of permission to grant the access token to manage repository secrets. Can be one of: `read` or `write`.", + "name": "access_token", + "description": "The access_token of the OAuth application.", "in": "BODY", "type": "string", - "required": false, - "enum": ["read", "write"], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\",\"user\"],\"token\":\"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\"token_last_eight\":\"Ae178B4a\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"Iv1.8a61f9b3a7aba766\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\",\"expires_at\":\"2011-09-08T17:26:27Z\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" + } + ] }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 422, "description": "Validation failed", "examples": null } + ], + "renamed": null + }, + { + "name": "Create a GitHub App from a manifest", + "scope": "apps", + "id": "createFromManifest", + "method": "POST", + "url": "/app-manifests/{code}/conversions", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.", + "documentationUrl": "https://docs.github.com/rest/reference/apps#create-a-github-app-from-a-manifest", + "previews": [], + "headers": [], + "parameters": [ { - "name": "permissions.security_events", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts. Can be one of: `read` or `write`.", - "in": "BODY", + "name": "code", + "description": "", + "in": "PATH", "type": "string", - "required": false, - "enum": ["read", "write"], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, - { - "name": "permissions.single_file", - "description": "The level of permission to grant the access token to manage just a single file. Can be one of: `read` or `write`.", + } + ], + "responses": [ + { + "code": 201, + "description": "Response", + "examples": [ + { + "data": "{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDxOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"],\"client_id\":\"Iv1.8a61f9b3a7aba766\",\"client_secret\":\"1726be1638095a19edd134c77bde3aa2ece1e5d8\",\"webhook_secret\":\"e340154128314309424b7c8e90325147d99fdafa\",\"pem\":\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEowIBAAKCAQEAuEPzOUE+kiEH1WLiMeBytTEF856j0hOVcSUSUkZxKvqczkWM\\n9vo1gDyC7ZXhdH9fKh32aapba3RSsp4ke+giSmYTk2mGR538ShSDxh0OgpJmjiKP\\nX0Bj4j5sFqfXuCtl9SkH4iueivv4R53ktqM+n6hk98l6hRwC39GVIblAh2lEM4L/\\n6WvYwuQXPMM5OG2Ryh2tDZ1WS5RKfgq+9ksNJ5Q9UtqtqHkO+E63N5OK9sbzpUUm\\noNaOl3udTlZD3A8iqwMPVxH4SxgATBPAc+bmjk6BMJ0qIzDcVGTrqrzUiywCTLma\\nszdk8GjzXtPDmuBgNn+o6s02qVGpyydgEuqmTQIDAQABAoIBACL6AvkjQVVLn8kJ\\ndBYznJJ4M8ECo+YEgaFwgAHODT0zRQCCgzd+Vxl4YwHmKV2Lr+y2s0drZt8GvYva\\nKOK8NYYZyi15IlwFyRXmvvykF1UBpSXluYFDH7KaVroWMgRreHcIys5LqVSIb6Bo\\ngDmK0yBLPp8qR29s2b7ScZRtLaqGJiX+j55rNzrZwxHkxFHyG9OG+u9IsBElcKCP\\nkYCVE8ZdYexfnKOZbgn2kZB9qu0T/Mdvki8yk3I2bI6xYO24oQmhnT36qnqWoCBX\\nNuCNsBQgpYZeZET8mEAUmo9d+ABmIHIvSs005agK8xRaP4+6jYgy6WwoejJRF5yd\\nNBuF7aECgYEA50nZ4FiZYV0vcJDxFYeY3kYOvVuKn8OyW+2rg7JIQTremIjv8FkE\\nZnwuF9ZRxgqLxUIfKKfzp/5l5LrycNoj2YKfHKnRejxRWXqG+ZETfxxlmlRns0QG\\nJ4+BYL0CoanDSeA4fuyn4Bv7cy/03TDhfg/Uq0Aeg+hhcPE/vx3ebPsCgYEAy/Pv\\neDLssOSdeyIxf0Brtocg6aPXIVaLdus+bXmLg77rJIFytAZmTTW8SkkSczWtucI3\\nFI1I6sei/8FdPzAl62/JDdlf7Wd9K7JIotY4TzT7Tm7QU7xpfLLYIP1bOFjN81rk\\n77oOD4LsXcosB/U6s1blPJMZ6AlO2EKs10UuR1cCgYBipzuJ2ADEaOz9RLWwi0AH\\nPza2Sj+c2epQD9ZivD7Zo/Sid3ZwvGeGF13JyR7kLEdmAkgsHUdu1rI7mAolXMaB\\n1pdrsHureeLxGbRM6za3tzMXWv1Il7FQWoPC8ZwXvMOR1VQDv4nzq7vbbA8z8c+c\\n57+8tALQHOTDOgQIzwK61QKBgERGVc0EJy4Uag+VY8J4m1ZQKBluqo7TfP6DQ7O8\\nM5MX73maB/7yAX8pVO39RjrhJlYACRZNMbK+v/ckEQYdJSSKmGCVe0JrGYDuPtic\\nI9+IGfSorf7KHPoMmMN6bPYQ7Gjh7a++tgRFTMEc8956Hnt4xGahy9NcglNtBpVN\\n6G8jAoGBAMCh028pdzJa/xeBHLLaVB2sc0Fe7993WlsPmnVE779dAz7qMscOtXJK\\nfgtriltLSSD6rTA9hUAsL/X62rY0wdXuNdijjBb/qvrx7CAV6i37NK1CjABNjsfG\\nZM372Ac6zc1EqSrid2IjET1YqyIW2KGLI1R2xbQc98UGlt48OdWu\\n-----END RSA PRIVATE KEY-----\\n\"}" + } + ] + }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 422, "description": "Validation failed", "examples": null } + ], + "renamed": null + }, + { + "name": "Create an installation access token for an app", + "scope": "apps", + "id": "createInstallationAccessToken", + "method": "POST", + "url": "/app/installations/{installation_id}/access_tokens", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/apps/#create-an-installation-access-token-for-an-app", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "installation_id", + "description": "The unique identifier of the installation.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repositories", + "description": "List of repository names that the token should have access to", + "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repository_ids", + "description": "List of repository IDs that the token should have access to", + "in": "BODY", + "type": "integer[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions", + "description": "The permissions granted to the user-to-server access token.", + "in": "BODY", + "type": "object", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.actions", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.administration", + "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.checks", + "description": "The level of permission to grant the access token for checks on code.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.contents", + "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.deployments", + "description": "The level of permission to grant the access token for deployments and deployment statuses.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.environments", + "description": "The level of permission to grant the access token for managing repository environments.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.issues", + "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.metadata", + "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.packages", + "description": "The level of permission to grant the access token for packages published to GitHub Packages.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.pages", + "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.pull_requests", + "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.repository_hooks", + "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.repository_projects", + "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write", "admin"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.secret_scanning_alerts", + "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.secrets", + "description": "The level of permission to grant the access token to manage repository secrets.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.security_events", + "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.single_file", + "description": "The level of permission to grant the access token to manage just a single file.", "in": "BODY", "type": "string", "required": false, @@ -7748,7 +9089,7 @@ }, { "name": "permissions.statuses", - "description": "The level of permission to grant the access token for commit statuses. Can be one of: `read` or `write`.", + "description": "The level of permission to grant the access token for commit statuses.", "in": "BODY", "type": "string", "required": false, @@ -7761,11 +9102,11 @@ }, { "name": "permissions.vulnerability_alerts", - "description": "The level of permission to grant the access token to retrieve Dependabot alerts. Can be one of: `read`.", + "description": "The level of permission to grant the access token to manage Dependabot alerts.", "in": "BODY", "type": "string", "required": false, - "enum": ["read"], + "enum": ["read", "write"], "allowNull": false, "mapToData": null, "validation": null, @@ -7774,7 +9115,7 @@ }, { "name": "permissions.workflows", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files. Can be one of: `write`.", + "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", "in": "BODY", "type": "string", "required": false, @@ -7787,7 +9128,7 @@ }, { "name": "permissions.members", - "description": "The level of permission to grant the access token for organization teams and members. Can be one of: `read` or `write`.", + "description": "The level of permission to grant the access token for organization teams and members.", "in": "BODY", "type": "string", "required": false, @@ -7800,7 +9141,7 @@ }, { "name": "permissions.organization_administration", - "description": "The level of permission to grant the access token to manage access to an organization. Can be one of: `read` or `write`.", + "description": "The level of permission to grant the access token to manage access to an organization.", "in": "BODY", "type": "string", "required": false, @@ -7813,7 +9154,7 @@ }, { "name": "permissions.organization_hooks", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization. Can be one of: `read` or `write`.", + "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", "in": "BODY", "type": "string", "required": false, @@ -7826,7 +9167,7 @@ }, { "name": "permissions.organization_plan", - "description": "The level of permission to grant the access token for viewing an organization's plan. Can be one of: `read`.", + "description": "The level of permission to grant the access token for viewing an organization's plan.", "in": "BODY", "type": "string", "required": false, @@ -7839,7 +9180,7 @@ }, { "name": "permissions.organization_projects", - "description": "The level of permission to grant the access token to manage organization projects, columns, and cards. Can be one of: `read`, `write`, or `admin`.", + "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", "in": "BODY", "type": "string", "required": false, @@ -7852,7 +9193,7 @@ }, { "name": "permissions.organization_packages", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages. Can be one of: `read` or `write`.", + "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", "in": "BODY", "type": "string", "required": false, @@ -7865,7 +9206,7 @@ }, { "name": "permissions.organization_secrets", - "description": "The level of permission to grant the access token to manage organization secrets. Can be one of: `read` or `write`.", + "description": "The level of permission to grant the access token to manage organization secrets.", "in": "BODY", "type": "string", "required": false, @@ -7878,7 +9219,7 @@ }, { "name": "permissions.organization_self_hosted_runners", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. Can be one of: `read` or `write`.", + "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", "in": "BODY", "type": "string", "required": false, @@ -7891,7 +9232,7 @@ }, { "name": "permissions.organization_user_blocking", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization. Can be one of: `read` or `write`.", + "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", "in": "BODY", "type": "string", "required": false, @@ -7904,7 +9245,7 @@ }, { "name": "permissions.team_discussions", - "description": "The level of permission to grant the access token to manage team discussions and related comments. Can be one of: `read` or `write`.", + "description": "The level of permission to grant the access token to manage team discussions and related comments.", "in": "BODY", "type": "string", "required": false, @@ -7933,11 +9274,6 @@ }, { "code": 403, "description": "Forbidden", "examples": null }, { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, { "code": 422, "description": "Validation failed", "examples": null } ], "renamed": null @@ -7958,7 +9294,7 @@ "parameters": [ { "name": "client_id", - "description": "The client ID of your GitHub app.", + "description": "The client ID of the GitHub app.", "in": "PATH", "type": "string", "required": true, @@ -8005,7 +9341,7 @@ "parameters": [ { "name": "installation_id", - "description": "installation_id parameter", + "description": "The unique identifier of the installation.", "in": "PATH", "type": "integer", "required": true, @@ -8039,7 +9375,7 @@ "parameters": [ { "name": "client_id", - "description": "The client ID of your GitHub app.", + "description": "The client ID of the GitHub app.", "in": "PATH", "type": "string", "required": true, @@ -8106,7 +9442,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).\n\nIf the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "description": "**Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).\n\nIf the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/apps/#get-an-app", "previews": [], "headers": [], @@ -8136,8 +9472,7 @@ ] }, { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } + { "code": 404, "description": "Resource not found", "examples": null } ], "renamed": null }, @@ -8150,14 +9485,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Enables an authenticated GitHub App to find an installation's information using the installation id. The installation's account type (`target_type`) will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Enables an authenticated GitHub App to find an installation's information using the installation id.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/apps#get-an-installation-for-the-authenticated-app", "previews": [], "headers": [], "parameters": [ { "name": "installation_id", - "description": "installation_id parameter", + "description": "The unique identifier of the installation.", "in": "PATH", "type": "integer", "required": true, @@ -8179,8 +9514,7 @@ } ] }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } + { "code": 404, "description": "Resource not found", "examples": null } ], "renamed": null }, @@ -8200,7 +9534,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -8241,7 +9575,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -8254,7 +9588,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -8399,7 +9733,7 @@ "parameters": [ { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -8511,7 +9845,7 @@ "parameters": [ { "name": "plan_id", - "description": "plan_id parameter", + "description": "The unique identifier of the plan.", "in": "PATH", "type": "integer", "required": true, @@ -8524,7 +9858,7 @@ }, { "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", + "description": "The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to.", "in": "QUERY", "type": "string", "required": false, @@ -8537,7 +9871,7 @@ }, { "name": "direction", - "description": "To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter.", + "description": "To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter.", "in": "QUERY", "type": "string", "required": false, @@ -8550,7 +9884,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -8611,7 +9945,7 @@ "parameters": [ { "name": "plan_id", - "description": "plan_id parameter", + "description": "The unique identifier of the plan.", "in": "PATH", "type": "integer", "required": true, @@ -8624,7 +9958,7 @@ }, { "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", + "description": "The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to.", "in": "QUERY", "type": "string", "required": false, @@ -8637,7 +9971,7 @@ }, { "name": "direction", - "description": "To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter.", + "description": "To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter.", "in": "QUERY", "type": "string", "required": false, @@ -8650,7 +9984,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -8708,10 +10042,3184 @@ "headers": [], "parameters": [ { - "name": "installation_id", - "description": "installation_id parameter", - "in": "PATH", - "type": "integer", + "name": "installation_id", + "description": "The unique identifier of the installation.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "The access the user has to each repository is included in the hash under the `permissions` key.", + "examples": [ + { + "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]}" + } + ] + }, + { "code": 304, "description": "Not modified", "examples": null }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "List installations for the authenticated app", + "scope": "apps", + "id": "listInstallations", + "method": "GET", + "url": "/app/installations", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.\n\nThe permissions the installation has are included under the `permissions` key.", + "documentationUrl": "https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "since", + "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "outdated", + "description": "", + "in": "QUERY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "The permissions the installation has are included under the `permissions` key.", + "examples": [ + { + "data": "[{\"id\":1,\"account\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"single_file_name\":\"config.yaml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"repository_selection\":\"selected\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}]" + } + ] + } + ], + "renamed": null + }, + { + "name": "List app installations accessible to the user access token", + "scope": "apps", + "id": "listInstallationsForAuthenticatedUser", + "method": "GET", + "url": "/user/installations", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.\n\nYou must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nYou can find the permissions for the installation under the `permissions` key.", + "documentationUrl": "https://docs.github.com/rest/reference/apps#list-app-installations-accessible-to-the-user-access-token", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "You can find the permissions for the installation under the `permissions` key.", + "examples": [ + { + "data": "{\"total_count\":2,\"installations\":[{\"id\":1,\"account\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"single_file_name\":\"config.yaml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"repository_selection\":\"all\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null},{\"id\":3,\"account\":{\"login\":\"octocat\",\"id\":2,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"single_file_name\":\"config.yaml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"repository_selection\":\"all\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}]}" + } + ] + }, + { "code": 304, "description": "Not modified", "examples": null }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null } + ], + "renamed": null + }, + { + "name": "List plans", + "scope": "apps", + "id": "listPlans", + "method": "GET", + "url": "/marketplace_listing/plans", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists all plans that are part of your GitHub Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/apps#list-plans", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}]" + } + ] + }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "List plans (stubbed)", + "scope": "apps", + "id": "listPlansStubbed", + "method": "GET", + "url": "/marketplace_listing/stubbed/plans", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists all plans that are part of your GitHub Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/apps#list-plans-stubbed", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}]" + } + ] + }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + } + ], + "renamed": null + }, + { + "name": "List repositories accessible to the app installation", + "scope": "apps", + "id": "listReposAccessibleToInstallation", + "method": "GET", + "url": "/installation/repositories", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "List repositories that an app installation can access.\n\nYou must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/apps#list-repositories-accessible-to-the-app-installation", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]}" + } + ] + }, + { "code": 304, "description": "Not modified", "examples": null }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null } + ], + "renamed": null + }, + { + "name": "List subscriptions for the authenticated user", + "scope": "apps", + "id": "listSubscriptionsForAuthenticatedUser", + "method": "GET", + "url": "/user/marketplace_purchases", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/).", + "documentationUrl": "https://docs.github.com/rest/reference/apps#list-subscriptions-for-the-authenticated-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"billing_cycle\":\"monthly\",\"next_billing_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"on_free_trial\":true,\"free_trial_ends_on\":\"2017-11-11T00:00:00Z\",\"updated_at\":\"2017-11-02T01:12:12Z\",\"account\":{\"login\":\"github\",\"id\":4,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"email\":null,\"organization_billing_email\":\"billing@github.com\",\"type\":\"Organization\"},\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}}]" + } + ] + }, + { "code": 304, "description": "Not modified", "examples": null }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "List subscriptions for the authenticated user (stubbed)", + "scope": "apps", + "id": "listSubscriptionsForAuthenticatedUserStubbed", + "method": "GET", + "url": "/user/marketplace_purchases/stubbed", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/).", + "documentationUrl": "https://docs.github.com/rest/reference/apps#list-subscriptions-for-the-authenticated-user-stubbed", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"billing_cycle\":\"monthly\",\"next_billing_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"on_free_trial\":true,\"free_trial_ends_on\":\"2017-11-11T00:00:00Z\",\"updated_at\":\"2017-11-02T01:12:12Z\",\"account\":{\"login\":\"github\",\"id\":4,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"email\":null,\"organization_billing_email\":\"billing@github.com\",\"type\":\"Organization\"},\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}}]" + } + ] + }, + { "code": 304, "description": "Not modified", "examples": null }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + } + ], + "renamed": null + }, + { + "name": "List deliveries for an app webhook", + "scope": "apps", + "id": "listWebhookDeliveries", + "method": "GET", + "url": "/app/hook/deliveries", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Returns a list of webhook deliveries for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/apps#list-deliveries-for-an-app-webhook", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "cursor", + "description": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"id\":12345678,\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"delivered_at\":\"2019-06-03T00:57:16Z\",\"redelivery\":false,\"duration\":0.27,\"status\":\"OK\",\"status_code\":200,\"event\":\"issues\",\"action\":\"opened\",\"installation_id\":123,\"repository_id\":456},{\"id\":123456789,\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"delivered_at\":\"2019-06-04T00:57:16Z\",\"redelivery\":true,\"duration\":0.28,\"status\":\"OK\",\"status_code\":200,\"event\":\"issues\",\"action\":\"opened\",\"installation_id\":123,\"repository_id\":456}]" + } + ] + }, + { "code": 400, "description": "Bad Request", "examples": null }, + { "code": 400, "description": "Bad Request", "examples": null }, + { "code": 422, "description": "Validation failed", "examples": null } + ], + "renamed": null + }, + { + "name": "Redeliver a delivery for an app webhook", + "scope": "apps", + "id": "redeliverWebhookDelivery", + "method": "POST", + "url": "/app/hook/deliveries/{delivery_id}/attempts", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Redeliver a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/apps#redeliver-a-delivery-for-an-app-webhook", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "delivery_id", + "description": "", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { "code": 202, "description": "Accepted", "examples": null }, + { "code": 400, "description": "Bad Request", "examples": null }, + { "code": 400, "description": "Bad Request", "examples": null }, + { "code": 422, "description": "Validation failed", "examples": null } + ], + "renamed": null + }, + { + "name": "Remove a repository from an app installation", + "scope": "apps", + "id": "removeRepoFromInstallation", + "method": "DELETE", + "url": "/user/installations/{installation_id}/repositories/{repository_id}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/apps#remove-a-repository-from-an-app-installation", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "installation_id", + "description": "The unique identifier of the installation.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { "code": 204, "description": "Response", "examples": null }, + { "code": 304, "description": "Not modified", "examples": null }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": { + "before": { "scope": "apps", "id": "removeRepoFromInstallation" }, + "after": { + "scope": "apps", + "id": "removeRepoFromInstallationForAuthenticatedUser" + }, + "date": "2021-10-05", + "note": null + } + }, + { + "name": "Remove a repository from an app installation", + "scope": "apps", + "id": "removeRepoFromInstallationForAuthenticatedUser", + "method": "DELETE", + "url": "/user/installations/{installation_id}/repositories/{repository_id}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/apps#remove-a-repository-from-an-app-installation", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "installation_id", + "description": "The unique identifier of the installation.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { "code": 204, "description": "Response", "examples": null }, + { "code": 304, "description": "Not modified", "examples": null }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "Reset a token", + "scope": "apps", + "id": "resetToken", + "method": "PATCH", + "url": "/applications/{client_id}/token", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", + "documentationUrl": "https://docs.github.com/rest/reference/apps#reset-a-token", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "client_id", + "description": "The client ID of the GitHub app.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "access_token", + "description": "The access_token of the OAuth application.", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\",\"user\"],\"token\":\"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\"token_last_eight\":\"Ae178B4a\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"Iv1.8a61f9b3a7aba766\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\",\"expires_at\":\"2011-09-08T17:26:27Z\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" + } + ] + }, + { "code": 422, "description": "Validation failed", "examples": null } + ], + "renamed": null + }, + { + "name": "Revoke an installation access token", + "scope": "apps", + "id": "revokeInstallationAccessToken", + "method": "DELETE", + "url": "/installation/token", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.\n\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"[Create an installation access token for an app](https://docs.github.com/rest/reference/apps#create-an-installation-access-token-for-an-app)\" endpoint.\n\nYou must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/apps#revoke-an-installation-access-token", + "previews": [], + "headers": [], + "parameters": [], + "responses": [{ "code": 204, "description": "Response", "examples": null }], + "renamed": null + }, + { + "name": "Create a scoped access token", + "scope": "apps", + "id": "scopeToken", + "method": "POST", + "url": "/applications/{client_id}/token/scoped", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Use a non-scoped user-to-server OAuth access token to create a repository scoped and/or permission scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", + "documentationUrl": "https://docs.github.com/rest/reference/apps#create-a-scoped-access-token", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "client_id", + "description": "The client ID of the GitHub app.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "access_token", + "description": "The OAuth access token used to authenticate to the GitHub API.", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "target", + "description": "The name of the user or organization to scope the user-to-server access token to. **Required** unless `target_id` is specified.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "target_id", + "description": "The ID of the user or organization to scope the user-to-server access token to. **Required** unless `target` is specified.", + "in": "BODY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repositories", + "description": "The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", + "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repository_ids", + "description": "The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", + "in": "BODY", + "type": "integer[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions", + "description": "The permissions granted to the user-to-server access token.", + "in": "BODY", + "type": "object", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.actions", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.administration", + "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.checks", + "description": "The level of permission to grant the access token for checks on code.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.contents", + "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.deployments", + "description": "The level of permission to grant the access token for deployments and deployment statuses.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.environments", + "description": "The level of permission to grant the access token for managing repository environments.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.issues", + "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.metadata", + "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.packages", + "description": "The level of permission to grant the access token for packages published to GitHub Packages.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.pages", + "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.pull_requests", + "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.repository_hooks", + "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.repository_projects", + "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write", "admin"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.secret_scanning_alerts", + "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.secrets", + "description": "The level of permission to grant the access token to manage repository secrets.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.security_events", + "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.single_file", + "description": "The level of permission to grant the access token to manage just a single file.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.statuses", + "description": "The level of permission to grant the access token for commit statuses.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.vulnerability_alerts", + "description": "The level of permission to grant the access token to manage Dependabot alerts.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.workflows", + "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.members", + "description": "The level of permission to grant the access token for organization teams and members.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.organization_administration", + "description": "The level of permission to grant the access token to manage access to an organization.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.organization_hooks", + "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.organization_plan", + "description": "The level of permission to grant the access token for viewing an organization's plan.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.organization_projects", + "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write", "admin"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.organization_packages", + "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.organization_secrets", + "description": "The level of permission to grant the access token to manage organization secrets.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.organization_self_hosted_runners", + "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.organization_user_blocking", + "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permissions.team_discussions", + "description": "The level of permission to grant the access token to manage team discussions and related comments.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["read", "write"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[],\"token\":\"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\"token_last_eight\":\"Ae178B4a\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"Iv1.8a61f9b3a7aba766\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\",\"expires_at\":\"2011-09-08T17:26:27Z\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"installation\":{\"permissions\":{\"metadata\":\"read\",\"issues\":\"write\",\"contents\":\"read\"},\"repository_selection\":\"selected\",\"single_file_name\":\".github/workflow.yml\",\"repositories_url\":\"https://api.github.com/user/repos\",\"account\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"has_multiple_single_files\":false,\"single_file_paths\":[]}}" + } + ] + }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 422, "description": "Validation failed", "examples": null } + ], + "renamed": null + }, + { + "name": "Suspend an app installation", + "scope": "apps", + "id": "suspendInstallation", + "method": "PUT", + "url": "/app/installations/{installation_id}/suspended", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/apps#suspend-an-app-installation", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "installation_id", + "description": "The unique identifier of the installation.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { "code": 204, "description": "Response", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "Unsuspend an app installation", + "scope": "apps", + "id": "unsuspendInstallation", + "method": "DELETE", + "url": "/app/installations/{installation_id}/suspended", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Removes a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/apps#unsuspend-an-app-installation", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "installation_id", + "description": "The unique identifier of the installation.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { "code": 204, "description": "Response", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "Update a webhook configuration for an app", + "scope": "apps", + "id": "updateWebhookConfigForApp", + "method": "PATCH", + "url": "/app/hook/config", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/apps#update-a-webhook-configuration-for-an-app", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "url", + "description": "The URL to which the payloads will be delivered.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "content_type", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "secret", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "insecure_ssl", + "description": "", + "in": "BODY", + "type": null, + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\",\"url\":\"https://example.com/webhook\"}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Get GitHub Actions billing for an organization", + "scope": "billing", + "id": "getGithubActionsBillingOrg", + "method": "GET", + "url": "/orgs/{org}/settings/billing/actions", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAccess tokens must have the `repo` or `admin:org` scope.", + "documentationUrl": "https://docs.github.com/rest/reference/billing#get-github-actions-billing-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_minutes_used\":305,\"total_paid_minutes_used\":0,\"included_minutes\":3000,\"minutes_used_breakdown\":{\"UBUNTU\":205,\"MACOS\":10,\"WINDOWS\":90}}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Get GitHub Actions billing for a user", + "scope": "billing", + "id": "getGithubActionsBillingUser", + "method": "GET", + "url": "/users/{username}/settings/billing/actions", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAccess tokens must have the `user` scope.", + "documentationUrl": "https://docs.github.com/rest/reference/billing#get-github-actions-billing-for-a-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_minutes_used\":305,\"total_paid_minutes_used\":0,\"included_minutes\":3000,\"minutes_used_breakdown\":{\"UBUNTU\":205,\"MACOS\":10,\"WINDOWS\":90}}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Get GitHub Advanced Security active committers for an enterprise", + "scope": "billing", + "id": "getGithubAdvancedSecurityBillingGhe", + "method": "GET", + "url": "/enterprises/{enterprise}/settings/billing/advanced-security", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Gets the GitHub Advanced Security active committers for an enterprise per repository.\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository.", + "documentationUrl": "https://docs.github.com/rest/reference/billing#export-advanced-security-active-committers-data-for-enterprise", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Success", + "examples": [ + { + "data": "{\"total_advanced_security_committers\":2,\"repositories\":[{\"name\":\"octocat-org/Hello-World\",\"advanced_security_committers\":2,\"advanced_security_committers_breakdown\":[{\"user_login\":\"octocat\",\"last_pushed_date\":\"2021-11-03\"},{\"user_login\":\"octokitten\",\"last_pushed_date\":\"2021-10-25\"}]},{\"name\":\"octocat-org/server\",\"advanced_security_committers\":1,\"advanced_security_committers_breakdown\":[{\"user_login\":\"octokitten\",\"last_pushed_date\":\"2021-10-26\"}]}]}" + } + ] + }, + { + "code": 403, + "description": "Response if GitHub Advanced Security is not enabled for this repository", + "examples": null + } + ], + "renamed": null + }, + { + "name": "Get GitHub Advanced Security active committers for an organization", + "scope": "billing", + "id": "getGithubAdvancedSecurityBillingOrg", + "method": "GET", + "url": "/orgs/{org}/settings/billing/advanced-security", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Gets the GitHub Advanced Security active committers for an organization per repository.\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of advanced_security_committers for each repository.\nIf this organization defers to an enterprise for billing, the total_advanced_security_committers returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.", + "documentationUrl": "https://docs.github.com/rest/reference/billing#get-github-advanced-security-active-committers-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Success", + "examples": [ + { + "data": "{\"total_advanced_security_committers\":2,\"repositories\":[{\"name\":\"octocat-org/Hello-World\",\"advanced_security_committers\":2,\"advanced_security_committers_breakdown\":[{\"user_login\":\"octocat\",\"last_pushed_date\":\"2021-11-03\"},{\"user_login\":\"octokitten\",\"last_pushed_date\":\"2021-10-25\"}]},{\"name\":\"octocat-org/server\",\"advanced_security_committers\":1,\"advanced_security_committers_breakdown\":[{\"user_login\":\"octokitten\",\"last_pushed_date\":\"2021-10-26\"}]}]}" + } + ] + }, + { + "code": 403, + "description": "Response if GitHub Advanced Security is not enabled for this repository", + "examples": null + } + ], + "renamed": null + }, + { + "name": "Get GitHub Packages billing for an organization", + "scope": "billing", + "id": "getGithubPackagesBillingOrg", + "method": "GET", + "url": "/orgs/{org}/settings/billing/packages", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Gets the free and paid storage used for GitHub Packages in gigabytes.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nAccess tokens must have the `repo` or `admin:org` scope.", + "documentationUrl": "https://docs.github.com/rest/reference/billing#get-github-packages-billing-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_gigabytes_bandwidth_used\":50,\"total_paid_gigabytes_bandwidth_used\":40,\"included_gigabytes_bandwidth\":10}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Get GitHub Packages billing for a user", + "scope": "billing", + "id": "getGithubPackagesBillingUser", + "method": "GET", + "url": "/users/{username}/settings/billing/packages", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Gets the free and paid storage used for GitHub Packages in gigabytes.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nAccess tokens must have the `user` scope.", + "documentationUrl": "https://docs.github.com/rest/reference/billing#get-github-packages-billing-for-a-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_gigabytes_bandwidth_used\":50,\"total_paid_gigabytes_bandwidth_used\":40,\"included_gigabytes_bandwidth\":10}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Get shared storage billing for an organization", + "scope": "billing", + "id": "getSharedStorageBillingOrg", + "method": "GET", + "url": "/orgs/{org}/settings/billing/shared-storage", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nAccess tokens must have the `repo` or `admin:org` scope.", + "documentationUrl": "https://docs.github.com/rest/reference/billing#get-shared-storage-billing-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"days_left_in_billing_cycle\":20,\"estimated_paid_storage_for_month\":15,\"estimated_storage_for_month\":40}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Get shared storage billing for a user", + "scope": "billing", + "id": "getSharedStorageBillingUser", + "method": "GET", + "url": "/users/{username}/settings/billing/shared-storage", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nAccess tokens must have the `user` scope.", + "documentationUrl": "https://docs.github.com/rest/reference/billing#get-shared-storage-billing-for-a-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"days_left_in_billing_cycle\":20,\"estimated_paid_storage_for_month\":15,\"estimated_storage_for_month\":40}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Create a check run", + "scope": "checks", + "id": "create", + "method": "POST", + "url": "/repos/{owner}/{repo}/check-runs", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.\n\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.", + "documentationUrl": "https://docs.github.com/rest/reference/checks#create-a-check-run", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "status", + "description": "", + "in": "BODY", + "type": null, + "required": false, + "enum": ["queued", "in_progress"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "*", + "description": "", + "in": "BODY", + "type": "object", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 201, + "description": "Response", + "examples": [ + { + "data": "{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"42\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"https://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}" + }, + { + "data": "{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"42\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"https://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"in_progress\",\"conclusion\":null,\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":null,\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Create a check suite", + "scope": "checks", + "id": "createSuite", + "method": "POST", + "url": "/repos/{owner}/{repo}/check-suites", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nBy default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites)\". Your GitHub App must have the `checks:write` permission to create check suites.", + "documentationUrl": "https://docs.github.com/rest/reference/checks#create-a-check-suite", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "head_sha", + "description": "The sha of the head commit.", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response when the suite already exists", + "examples": [ + { + "data": "{\"id\":5,\"node_id\":\"MDEwOkNoZWNrU3VpdGU1\",\"head_branch\":\"master\",\"head_sha\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"url\":\"https://api.github.com/repos/github/hello-world/check-suites/5\",\"before\":\"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\"after\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"pull_requests\":[],\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"delete_branch_on_merge\":true,\"subscribers_count\":42,\"network_count\":0},\"head_commit\":{\"id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"tree_id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"message\":\"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\"timestamp\":\"2016-10-10T00:00:00Z\",\"author\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"committer\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"}},\"latest_check_runs_count\":1,\"check_runs_url\":\"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"}" + } + ] + }, + { + "code": 201, + "description": "Response when the suite was created", + "examples": [ + { + "data": "{\"id\":5,\"node_id\":\"MDEwOkNoZWNrU3VpdGU1\",\"head_branch\":\"master\",\"head_sha\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"url\":\"https://api.github.com/repos/github/hello-world/check-suites/5\",\"before\":\"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\"after\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"pull_requests\":[],\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"delete_branch_on_merge\":true,\"subscribers_count\":42,\"network_count\":0},\"head_commit\":{\"id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"tree_id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"message\":\"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\"timestamp\":\"2016-10-10T00:00:00Z\",\"author\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"committer\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"}},\"latest_check_runs_count\":1,\"check_runs_url\":\"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Get a check run", + "scope": "checks", + "id": "get", + "method": "GET", + "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nGets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.", + "documentationUrl": "https://docs.github.com/rest/reference/checks#get-a-check-run", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "check_run_id", + "description": "The unique identifier of the check run.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"https://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Get a check suite", + "scope": "checks", + "id": "getSuite", + "method": "GET", + "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nGets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.", + "documentationUrl": "https://docs.github.com/rest/reference/checks#get-a-check-suite", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "check_suite_id", + "description": "The unique identifier of the check suite.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"id\":5,\"node_id\":\"MDEwOkNoZWNrU3VpdGU1\",\"head_branch\":\"master\",\"head_sha\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"url\":\"https://api.github.com/repos/github/hello-world/check-suites/5\",\"before\":\"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\"after\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"pull_requests\":[],\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"delete_branch_on_merge\":true,\"subscribers_count\":42,\"network_count\":0},\"head_commit\":{\"id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"tree_id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"message\":\"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\"timestamp\":\"2016-10-10T00:00:00Z\",\"author\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"committer\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"}},\"latest_check_runs_count\":1,\"check_runs_url\":\"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"}" + } + ] + } + ], + "renamed": null + }, + { + "name": "List check run annotations", + "scope": "checks", + "id": "listAnnotations", + "method": "GET", + "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository.", + "documentationUrl": "https://docs.github.com/rest/reference/checks#list-check-run-annotations", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "check_run_id", + "description": "The unique identifier of the check run.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"path\":\"README.md\",\"start_line\":2,\"end_line\":2,\"start_column\":5,\"end_column\":10,\"annotation_level\":\"warning\",\"title\":\"Spell Checker\",\"message\":\"Check your spelling for 'banaas'.\",\"raw_details\":\"Do you mean 'bananas' or 'banana'?\",\"blob_href\":\"https://api.github.com/repos/github/rest-api-description/git/blobs/abc\"}]" + } + ] + } + ], + "renamed": null + }, + { + "name": "List check runs for a Git reference", + "scope": "checks", + "id": "listForRef", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{ref}/check-runs", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.", + "documentationUrl": "https://docs.github.com/rest/reference/checks#list-check-runs-for-a-git-reference", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "ref", + "description": "ref parameter", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "check_name", + "description": "Returns check runs with the specified `name`.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "status", + "description": "Returns check runs with the specified `status`.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["queued", "in_progress", "completed"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "filter", + "description": "Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["latest", "all"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "app_id", + "description": "", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_count\":1,\"check_runs\":[{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"https://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}]}" + } + ] + } + ], + "renamed": null + }, + { + "name": "List check runs in a check suite", + "scope": "checks", + "id": "listForSuite", + "method": "GET", + "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.", + "documentationUrl": "https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "check_suite_id", + "description": "The unique identifier of the check suite.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "check_name", + "description": "Returns check runs with the specified `name`.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "status", + "description": "Returns check runs with the specified `status`.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["queued", "in_progress", "completed"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "filter", + "description": "Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["latest", "all"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_count\":1,\"check_runs\":[{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"https://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}]}" + } + ] + } + ], + "renamed": null + }, + { + "name": "List check suites for a Git reference", + "scope": "checks", + "id": "listSuitesForRef", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{ref}/check-suites", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nLists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.", + "documentationUrl": "https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "ref", + "description": "ref parameter", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "app_id", + "description": "Filters check suites by GitHub App `id`.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "check_name", + "description": "Returns check runs with the specified `name`.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_count\":1,\"check_suites\":[{\"id\":5,\"node_id\":\"MDEwOkNoZWNrU3VpdGU1\",\"head_branch\":\"master\",\"head_sha\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"url\":\"https://api.github.com/repos/github/hello-world/check-suites/5\",\"before\":\"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\"after\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"pull_requests\":[],\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"delete_branch_on_merge\":true,\"subscribers_count\":42,\"network_count\":0},\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"head_commit\":{\"id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"tree_id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"message\":\"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\"timestamp\":\"2016-10-10T00:00:00Z\",\"author\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"committer\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"}},\"latest_check_runs_count\":1,\"check_runs_url\":\"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"}]}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Rerequest a check run", + "scope": "checks", + "id": "rerequestRun", + "method": "POST", + "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "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.", + "documentationUrl": "https://docs.github.com/rest/reference/checks#rerequest-a-check-run", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "check_run_id", + "description": "The unique identifier of the check run.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { "code": 201, "description": "Response", "examples": null }, + { + "code": 403, + "description": "Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App", + "examples": null + }, + { "code": 404, "description": "Resource not found", "examples": null }, + { + "code": 422, + "description": "Validation error if the check run is not rerequestable", + "examples": null + } + ], + "renamed": null + }, + { + "name": "Rerequest a check suite", + "scope": "checks", + "id": "rerequestSuite", + "method": "POST", + "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.", + "documentationUrl": "https://docs.github.com/rest/reference/checks#rerequest-a-check-suite", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "check_suite_id", + "description": "The unique identifier of the check suite.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [{ "code": 201, "description": "Response", "examples": null }], + "renamed": null + }, + { + "name": "Update repository preferences for check suites", + "scope": "checks", + "id": "setSuitesPreferences", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/check-suites/preferences", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites.", + "documentationUrl": "https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "auto_trigger_checks", + "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/rest/reference/checks#auto_trigger_checks-object) description for details.", + "in": "BODY", + "type": "object[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "auto_trigger_checks[].app_id", + "description": "The `id` of the GitHub App.", + "in": "BODY", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "auto_trigger_checks[].setting", + "description": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", + "in": "BODY", + "type": "boolean", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"preferences\":{\"auto_trigger_checks\":[{\"app_id\":2,\"setting\":true},{\"app_id\":4,\"setting\":false}]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Update a check run", + "scope": "checks", + "id": "update", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nUpdates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.", + "documentationUrl": "https://docs.github.com/rest/reference/checks#update-a-check-run", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "check_run_id", + "description": "The unique identifier of the check run.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "name", + "description": "The name of the check. For example, \"code-coverage\".", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "details_url", + "description": "The URL of the integrator's site that has the full details of the check.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "external_id", + "description": "A reference for the run on the integrator's system.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "started_at", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "status", + "description": "The current status.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["queued", "in_progress", "completed"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "conclusion", + "description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.", + "in": "BODY", + "type": "string", + "required": false, + "enum": [ + "action_required", + "cancelled", + "failure", + "neutral", + "success", + "skipped", + "stale", + "timed_out" + ], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "completed_at", + "description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/rest/reference/checks#output-object-1) description.", + "in": "BODY", + "type": "object", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.title", + "description": "**Required**.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.summary", + "description": "Can contain Markdown.", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.text", + "description": "Can contain Markdown.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.annotations", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details.", + "in": "BODY", + "type": "object[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.annotations[].path", + "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.annotations[].start_line", + "description": "The start line of the annotation.", + "in": "BODY", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.annotations[].end_line", + "description": "The end line of the annotation.", + "in": "BODY", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.annotations[].start_column", + "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", + "in": "BODY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.annotations[].end_column", + "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", + "in": "BODY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.annotations[].annotation_level", + "description": "The level of the annotation.", + "in": "BODY", + "type": "string", + "required": true, + "enum": ["notice", "warning", "failure"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.annotations[].message", + "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.annotations[].title", + "description": "The title that represents the annotation. The maximum size is 255 characters.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.annotations[].raw_details", + "description": "Details about this annotation. The maximum size is 64 KB.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.images", + "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details.", + "in": "BODY", + "type": "object[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.images[].alt", + "description": "The alternative text for the image.", + "in": "BODY", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -8721,11 +13229,11 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "output.images[].image_url", + "description": "The full URL of the image.", + "in": "BODY", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -8734,10 +13242,10 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", + "name": "output.images[].caption", + "description": "A short image description.", + "in": "BODY", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -8745,43 +13253,12 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "The access the user has to each repository is included in the hash under the `permissions` key.", - "examples": [ - { - "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]}" - } - ] }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List installations for the authenticated app", - "scope": "apps", - "id": "listInstallations", - "method": "GET", - "url": "/app/installations", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.\n\nThe permissions the installation has are included under the `permissions` key.", - "documentationUrl": "https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app", - "previews": [], - "headers": [], - "parameters": [ { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", + "name": "actions", + "description": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions).\"", + "in": "BODY", + "type": "object[]", "required": false, "enum": null, "allowNull": false, @@ -8791,11 +13268,11 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "actions[].label", + "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", + "in": "BODY", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -8804,11 +13281,11 @@ "deprecated": null }, { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", + "name": "actions[].description", + "description": "A short explanation of what this action would do. The maximum size is 40 characters.", + "in": "BODY", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -8817,11 +13294,11 @@ "deprecated": null }, { - "name": "outdated", - "description": "", - "in": "QUERY", + "name": "actions[].identifier", + "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.", + "in": "BODY", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -8833,10 +13310,10 @@ "responses": [ { "code": 200, - "description": "The permissions the installation has are included under the `permissions` key.", + "description": "Response", "examples": [ { - "data": "[{\"id\":1,\"account\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"single_file_name\":\"config.yaml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"repository_selection\":\"selected\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}]" + "data": "{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"https://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}" } ] } @@ -8844,25 +13321,25 @@ "renamed": null }, { - "name": "List app installations accessible to the user access token", - "scope": "apps", - "id": "listInstallationsForAuthenticatedUser", - "method": "GET", - "url": "/user/installations", + "name": "Delete a code scanning analysis from a repository", + "scope": "codeScanning", + "id": "deleteAnalysis", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}{?confirm_delete}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.\n\nYou must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nYou can find the permissions for the installation under the `permissions` key.", - "documentationUrl": "https://docs.github.com/rest/reference/apps#list-app-installations-accessible-to-the-user-access-token", + "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` scope.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `analysis_key`\n* `environment`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\n`next_analysis_url` and `confirm_delete_url`.\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n **Inner loop**:\n * Delete the identified analysis.\n * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.", + "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#delete-a-code-scanning-analysis-from-a-repository", "previews": [], "headers": [], "parameters": [ { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -8871,60 +13348,24 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "You can find the permissions for the installation under the `permissions` key.", - "examples": [ - { - "data": "{\"total_count\":2,\"installations\":[{\"id\":1,\"account\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"single_file_name\":\"config.yaml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"repository_selection\":\"all\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null},{\"id\":3,\"account\":{\"login\":\"octocat\",\"id\":2,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"single_file_name\":\"config.yaml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"repository_selection\":\"all\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}]}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } - ], - "renamed": null - }, - { - "name": "List plans", - "scope": "apps", - "id": "listPlans", - "method": "GET", - "url": "/marketplace_listing/plans", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Lists all plans that are part of your GitHub Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/apps#list-plans", - "previews": [], - "headers": [], - "parameters": [ { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", + "name": "analysis_id", + "description": "The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation.", + "in": "PATH", "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -8933,10 +13374,10 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", + "name": "confirm_delete", + "description": "Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.`", "in": "QUERY", - "type": "integer", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -8952,39 +13393,42 @@ "description": "Response", "examples": [ { - "data": "[{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}]" + "data": "{\"next_analysis_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41\",\"confirm_delete_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete\"}" } ] }, + { "code": 400, "description": "Bad Request", "examples": null }, + { "code": 400, "description": "Bad Request", "examples": null }, { - "code": 401, - "description": "Requires authentication", + "code": 403, + "description": "Response if the repository is archived or if github advanced security is not enabled for this repository", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 503, "description": "Service unavailable", "examples": null } ], "renamed": null }, { - "name": "List plans (stubbed)", - "scope": "apps", - "id": "listPlansStubbed", + "name": "Get a code scanning alert", + "scope": "codeScanning", + "id": "getAlert", "method": "GET", - "url": "/marketplace_listing/stubbed/plans", + "url": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all plans that are part of your GitHub Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/apps#list-plans-stubbed", + "description": "Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint.\n\n**Deprecation notice**:\nThe instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by `instances_url`.", + "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#get-a-code-scanning-alert", "previews": [], "headers": [], "parameters": [ { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -8993,57 +13437,24 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}]" - } - ] }, { - "code": 401, - "description": "Requires authentication", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List repositories accessible to the app installation", - "scope": "apps", - "id": "listReposAccessibleToInstallation", - "method": "GET", - "url": "/installation/repositories", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "List repositories that an app installation can access.\n\nYou must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/apps#list-repositories-accessible-to-the-app-installation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", + "name": "alert_number", + "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", + "in": "PATH", "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -9052,17 +13463,17 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", + "name": "alert_id", + "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", + "in": "PATH", "type": "integer", "required": false, "enum": null, "allowNull": false, "mapToData": null, "validation": null, - "alias": null, - "deprecated": null + "alias": "alert_number", + "deprecated": true } ], "responses": [ @@ -9071,101 +13482,54 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]}" + "data": "{\"number\":42,\"created_at\":\"2020-06-19T11:21:34Z\",\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\"html_url\":\"https://github.com/octocat/hello-world/code-scanning/42\",\"state\":\"dismissed\",\"fixed_at\":null,\"dismissed_by\":{\"login\":\"octocat\",\"id\":54933897,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"dismissed_at\":\"2020-02-14T12:29:18Z\",\"dismissed_reason\":\"false positive\",\"dismissed_comment\":\"This alert is not actually correct, because there's a sanitizer included in the library.\",\"rule\":{\"id\":\"js/zipslip\",\"severity\":\"error\",\"security_severity_level\":\"high\",\"description\":\"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\"name\":\"js/zipslip\",\"full_description\":\"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\"tags\":[\"security\",\"external/cwe/cwe-022\"],\"help\":\"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"},\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"most_recent_instance\":{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"{}\",\"state\":\"dismissed\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"spec-main/api-session-spec.ts\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"test\"]},\"instances_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"}" } ] }, { "code": 304, "description": "Not modified", "examples": null }, { - "code": 401, - "description": "Requires authentication", + "code": 403, + "description": "Response if GitHub Advanced Security is not enabled for this repository", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null } + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 503, "description": "Service unavailable", "examples": null } ], "renamed": null }, { - "name": "List subscriptions for the authenticated user", - "scope": "apps", - "id": "listSubscriptionsForAuthenticatedUser", + "name": "Get a code scanning analysis for a repository", + "scope": "codeScanning", + "id": "getAnalysis", "method": "GET", - "url": "/user/marketplace_purchases", + "url": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/).", - "documentationUrl": "https://docs.github.com/rest/reference/apps#list-subscriptions-for-the-authenticated-user", + "description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint with private repos,\nthe `public_repo` scope also grants permission to read security events on public repos only.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).", + "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository", "previews": [], "headers": [], "parameters": [ { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"billing_cycle\":\"monthly\",\"next_billing_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"on_free_trial\":true,\"free_trial_ends_on\":\"2017-11-11T00:00:00Z\",\"updated_at\":\"2017-11-02T01:12:12Z\",\"account\":{\"login\":\"github\",\"id\":4,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"email\":null,\"organization_billing_email\":\"billing@github.com\",\"type\":\"Organization\"},\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List subscriptions for the authenticated user (stubbed)", - "scope": "apps", - "id": "listSubscriptionsForAuthenticatedUserStubbed", - "method": "GET", - "url": "/user/marketplace_purchases/stubbed", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/).", - "documentationUrl": "https://docs.github.com/rest/reference/apps#list-subscriptions-for-the-authenticated-user-stubbed", - "previews": [], - "headers": [], - "parameters": [ { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -9174,11 +13538,11 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", + "name": "analysis_id", + "description": "The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation.", + "in": "PATH", "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -9188,44 +13552,46 @@ } ], "responses": [ + { "code": 200, "description": "Response", "examples": null }, { "code": 200, "description": "Response", "examples": [ { - "data": "[{\"billing_cycle\":\"monthly\",\"next_billing_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"on_free_trial\":true,\"free_trial_ends_on\":\"2017-11-11T00:00:00Z\",\"updated_at\":\"2017-11-02T01:12:12Z\",\"account\":{\"login\":\"github\",\"id\":4,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"email\":null,\"organization_billing_email\":\"billing@github.com\",\"type\":\"Organization\"},\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}}]" + "data": "{\"ref\":\"refs/heads/main\",\"commit_sha\":\"c18c69115654ff0166991962832dc2bd7756e655\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:analyze\",\"environment\":\"{\\\"language\\\":\\\"javascript\\\"}\",\"error\":\"\",\"category\":\".github/workflows/codeql-analysis.yml:analyze/language:javascript\",\"created_at\":\"2021-01-13T11:55:49Z\",\"results_count\":3,\"rules_count\":67,\"id\":3602840,\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\"sarif_id\":\"47177e22-5596-11eb-80a1-c1e54ef945c6\",\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"deletable\":true,\"warning\":\"\"}" } ] }, - { "code": 304, "description": "Not modified", "examples": null }, { - "code": 401, - "description": "Requires authentication", + "code": 403, + "description": "Response if GitHub Advanced Security is not enabled for this repository", "examples": null - } + }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 503, "description": "Service unavailable", "examples": null } ], "renamed": null }, { - "name": "List deliveries for an app webhook", - "scope": "apps", - "id": "listWebhookDeliveries", + "name": "Get information about a SARIF upload", + "scope": "codeScanning", + "id": "getSarif", "method": "GET", - "url": "/app/hook/deliveries", + "url": "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Returns a list of webhook deliveries for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/apps#list-deliveries-for-an-app-webhook", + "description": "Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"[Get a code scanning analysis for a repository](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository).\" You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#list-recent-code-scanning-analyses-for-a-repository", "previews": [], "headers": [], "parameters": [ { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -9234,54 +13600,23 @@ "deprecated": null }, { - "name": "cursor", - "description": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.", - "in": "QUERY", + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":12345678,\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"delivered_at\":\"2019-06-03T00:57:16Z\",\"redelivery\":false,\"duration\":0.27,\"status\":\"OK\",\"status_code\":200,\"event\":\"issues\",\"action\":\"opened\",\"installation_id\":123,\"repository_id\":456},{\"id\":123456789,\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"delivered_at\":\"2019-06-04T00:57:16Z\",\"redelivery\":true,\"duration\":0.28,\"status\":\"OK\",\"status_code\":200,\"event\":\"issues\",\"action\":\"opened\",\"installation_id\":123,\"repository_id\":456}]" - } - ] }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Redeliver a delivery for an app webhook", - "scope": "apps", - "id": "redeliverWebhookDelivery", - "method": "POST", - "url": "/app/hook/deliveries/{delivery_id}/attempts", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Redeliver a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/apps#redeliver-a-delivery-for-an-app-webhook", - "previews": [], - "headers": [], - "parameters": [ { - "name": "delivery_id", - "description": "", + "name": "sarif_id", + "description": "The SARIF ID obtained after uploading.", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -9292,32 +13627,48 @@ } ], "responses": [ - { "code": 202, "description": "Accepted", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"processing_status\":\"complete\",\"analyses_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6\"}" + } + ] + }, + { + "code": 403, + "description": "Response if GitHub Advanced Security is not enabled for this repository", + "examples": null + }, + { + "code": 404, + "description": "Not Found if the sarif id does not match any upload", + "examples": null + }, + { "code": 503, "description": "Service unavailable", "examples": null } ], "renamed": null }, { - "name": "Remove a repository from an app installation", - "scope": "apps", - "id": "removeRepoFromInstallation", - "method": "DELETE", - "url": "/user/installations/{installation_id}/repositories/{repository_id}", + "name": "List instances of a code scanning alert", + "scope": "codeScanning", + "id": "listAlertInstances", + "method": "GET", + "url": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/apps#remove-a-repository-from-an-app-installation", + "description": "Lists all instances of the specified code scanning alert.\nYou must use an access token with the `security_events` scope to use this endpoint with private repos,\nthe `public_repo` scope also grants permission to read security events on public repos only.\nGitHub Apps must have the `security_events` read permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert", "previews": [], "headers": [], "parameters": [ { - "name": "installation_id", - "description": "installation_id parameter", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -9327,52 +13678,21 @@ "deprecated": null }, { - "name": "repository_id", - "description": "", + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": { - "before": { "scope": "apps", "id": "removeRepoFromInstallation" }, - "after": { - "scope": "apps", - "id": "removeRepoFromInstallationForAuthenticatedUser" - }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "Remove a repository from an app installation", - "scope": "apps", - "id": "removeRepoFromInstallationForAuthenticatedUser", - "method": "DELETE", - "url": "/user/installations/{installation_id}/repositories/{repository_id}", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/apps#remove-a-repository-from-an-app-installation", - "previews": [], - "headers": [], - "parameters": [ + "validation": null, + "alias": null, + "deprecated": null + }, { - "name": "installation_id", - "description": "installation_id parameter", + "name": "alert_number", + "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", "in": "PATH", "type": "integer", "required": true, @@ -9384,47 +13704,24 @@ "deprecated": null }, { - "name": "repository_id", - "description": "", - "in": "PATH", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", "type": "integer", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Reset a token", - "scope": "apps", - "id": "resetToken", - "method": "PATCH", - "url": "/applications/{client_id}/token", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", - "documentationUrl": "https://docs.github.com/rest/reference/apps#reset-a-token", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "client_id", - "description": "The client ID of your GitHub app.", - "in": "PATH", - "type": "string", - "required": true, + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -9433,11 +13730,11 @@ "deprecated": null }, { - "name": "access_token", - "description": "The access_token of the OAuth application.", - "in": "BODY", + "name": "ref", + "description": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", + "in": "QUERY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -9452,48 +13749,37 @@ "description": "Response", "examples": [ { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\",\"user\"],\"token\":\"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\"token_last_eight\":\"Ae178B4a\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\",\"expires_at\":\"2011-09-08T17:26:27Z\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" + "data": "[{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"\",\"state\":\"open\",\"fixed_at\":null,\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"lib/ab12-gen.js\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"library\"]},{\"ref\":\"refs/pull/3740/merge\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"\",\"category\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"state\":\"fixed\",\"fixed_at\":\"2020-02-14T12:29:18Z\",\"commit_sha\":\"b09da05606e27f463a2b49287684b4ae777092f2\",\"message\":{\"text\":\"This suffix check is missing a length comparison to correctly handle lastIndexOf returning -1.\"},\"location\":{\"path\":\"app/script.js\",\"start_line\":2,\"end_line\":2,\"start_column\":10,\"end_column\":50},\"classifications\":[\"source\"]}]" } ] }, - { "code": 422, "description": "Validation failed", "examples": null } + { + "code": 403, + "description": "Response if GitHub Advanced Security is not enabled for this repository", + "examples": null + }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 503, "description": "Service unavailable", "examples": null } ], "renamed": null }, { - "name": "Revoke an installation access token", - "scope": "apps", - "id": "revokeInstallationAccessToken", - "method": "DELETE", - "url": "/installation/token", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.\n\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"[Create an installation access token for an app](https://docs.github.com/rest/reference/apps#create-an-installation-access-token-for-an-app)\" endpoint.\n\nYou must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/apps#revoke-an-installation-access-token", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Create a scoped access token", - "scope": "apps", - "id": "scopeToken", - "method": "POST", - "url": "/applications/{client_id}/token/scoped", + "name": "List code scanning alerts for an organization", + "scope": "codeScanning", + "id": "listAlertsForOrg", + "method": "GET", + "url": "/orgs/{org}/code-scanning/alerts", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Use a non-scoped user-to-server OAuth access token to create a repository scoped and/or permission scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", - "documentationUrl": "https://docs.github.com/rest/reference/apps#create-a-scoped-access-token", + "description": "Lists all code scanning alerts for the default branch (usually `main`\nor `master`) for all eligible repositories in an organization.\nTo use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `security_events` read permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#list-code-scanning-alerts-by-organization", "previews": [], "headers": [], "parameters": [ { - "name": "client_id", - "description": "The client ID of your GitHub app.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -9505,11 +13791,11 @@ "deprecated": null }, { - "name": "access_token", - "description": "The OAuth access token used to authenticate to the GitHub API.", - "in": "BODY", + "name": "tool_name", + "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.", + "in": "QUERY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -9518,9 +13804,9 @@ "deprecated": null }, { - "name": "target", - "description": "The name of the user or organization to scope the user-to-server access token to. **Required** unless `target_id` is specified.", - "in": "BODY", + "name": "tool_guid", + "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.", + "in": "QUERY", "type": "string", "required": false, "enum": null, @@ -9531,10 +13817,10 @@ "deprecated": null }, { - "name": "target_id", - "description": "The ID of the user or organization to scope the user-to-server access token to. **Required** unless `target` is specified.", - "in": "BODY", - "type": "integer", + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor.", + "in": "QUERY", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -9544,10 +13830,10 @@ "deprecated": null }, { - "name": "repositories", - "description": "The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", - "in": "BODY", - "type": "string[]", + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor.", + "in": "QUERY", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -9557,10 +13843,10 @@ "deprecated": null }, { - "name": "repository_ids", - "description": "The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", - "in": "BODY", - "type": "integer[]", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -9570,10 +13856,10 @@ "deprecated": null }, { - "name": "permissions", - "description": "The permissions granted to the user-to-server access token.", - "in": "BODY", - "type": "object", + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -9583,12 +13869,12 @@ "deprecated": null }, { - "name": "permissions.actions", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Can be one of: `read` or `write`.", - "in": "BODY", + "name": "direction", + "description": "The direction to sort the results by.", + "in": "QUERY", "type": "string", "required": false, - "enum": ["read", "write"], + "enum": ["asc", "desc"], "allowNull": false, "mapToData": null, "validation": null, @@ -9596,12 +13882,12 @@ "deprecated": null }, { - "name": "permissions.administration", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. Can be one of: `read` or `write`.", - "in": "BODY", + "name": "state", + "description": "Set to `open`, `closed`, `fixed`, or `dismissed` to list code scanning alerts in a specific state.", + "in": "QUERY", "type": "string", "required": false, - "enum": ["read", "write"], + "enum": ["open", "closed", "dismissed", "fixed"], "allowNull": false, "mapToData": null, "validation": null, @@ -9609,25 +13895,60 @@ "deprecated": null }, { - "name": "permissions.checks", - "description": "The level of permission to grant the access token for checks on code. Can be one of: `read` or `write`.", - "in": "BODY", + "name": "sort", + "description": "The property by which to sort the results.", + "in": "QUERY", "type": "string", "required": false, - "enum": ["read", "write"], + "enum": ["created", "updated"], "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"number\":4,\"created_at\":\"2020-02-13T12:29:18Z\",\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4\",\"html_url\":\"https://github.com/octocat/hello-world/code-scanning/4\",\"state\":\"open\",\"dismissed_by\":null,\"dismissed_at\":null,\"dismissed_reason\":null,\"dismissed_comment\":null,\"rule\":{\"id\":\"js/zipslip\",\"severity\":\"error\",\"tags\":[\"security\",\"external/cwe/cwe-022\"],\"description\":\"Arbitrary file write during zip extraction\",\"name\":\"js/zipslip\"},\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"most_recent_instance\":{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"{}\",\"state\":\"open\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"spec-main/api-session-spec.ts\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"test\"]},\"instances_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}},{\"number\":3,\"created_at\":\"2020-02-13T12:29:18Z\",\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3\",\"html_url\":\"https://github.com/octocat/hello-world/code-scanning/3\",\"state\":\"dismissed\",\"dismissed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"dismissed_at\":\"2020-02-14T12:29:18Z\",\"dismissed_reason\":\"false positive\",\"dismissed_comment\":\"This alert is not actually correct, because there's a sanitizer included in the library.\",\"rule\":{\"id\":\"js/zipslip\",\"severity\":\"error\",\"tags\":[\"security\",\"external/cwe/cwe-022\"],\"description\":\"Arbitrary file write during zip extraction\",\"name\":\"js/zipslip\"},\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"most_recent_instance\":{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"{}\",\"state\":\"open\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"lib/ab12-gen.js\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[]},\"instances_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}}]" + } + ] }, { - "name": "permissions.content_references", - "description": "The level of permission to grant the access token for notification of content references and creation content attachments. Can be one of: `read` or `write`.", - "in": "BODY", + "code": 403, + "description": "Response if GitHub Advanced Security is not enabled for this repository", + "examples": null + }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 503, "description": "Service unavailable", "examples": null } + ], + "renamed": null + }, + { + "name": "List code scanning alerts for a repository", + "scope": "codeScanning", + "id": "listAlertsForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/code-scanning/alerts", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists all open code scanning alerts for the default branch (usually `main`\nor `master`). You must use an access token with the `security_events` scope to use\nthis endpoint with private repos, the `public_repo` scope also grants permission to read\nsecurity events on public repos only. GitHub Apps must have the `security_events` read\npermission to use this endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the default branch or for the specified Git reference\n(if you used `ref` in the request).", + "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", "type": "string", - "required": false, - "enum": ["read", "write"], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -9635,12 +13956,12 @@ "deprecated": null }, { - "name": "permissions.contents", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. Can be one of: `read` or `write`.", - "in": "BODY", + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", "type": "string", - "required": false, - "enum": ["read", "write"], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -9648,12 +13969,12 @@ "deprecated": null }, { - "name": "permissions.deployments", - "description": "The level of permission to grant the access token for deployments and deployment statuses. Can be one of: `read` or `write`.", - "in": "BODY", + "name": "tool_name", + "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.", + "in": "QUERY", "type": "string", "required": false, - "enum": ["read", "write"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -9661,12 +13982,12 @@ "deprecated": null }, { - "name": "permissions.environments", - "description": "The level of permission to grant the access token for managing repository environments. Can be one of: `read` or `write`.", - "in": "BODY", + "name": "tool_guid", + "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.", + "in": "QUERY", "type": "string", "required": false, - "enum": ["read", "write"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -9674,12 +13995,12 @@ "deprecated": null }, { - "name": "permissions.issues", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, - "enum": ["read", "write"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -9687,12 +14008,12 @@ "deprecated": null }, { - "name": "permissions.metadata", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", "required": false, - "enum": ["read", "write"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -9700,12 +14021,12 @@ "deprecated": null }, { - "name": "permissions.packages", - "description": "The level of permission to grant the access token for packages published to GitHub Packages. Can be one of: `read` or `write`.", - "in": "BODY", + "name": "ref", + "description": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", + "in": "QUERY", "type": "string", "required": false, - "enum": ["read", "write"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -9713,12 +14034,12 @@ "deprecated": null }, { - "name": "permissions.pages", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. Can be one of: `read` or `write`.", - "in": "BODY", + "name": "direction", + "description": "The direction to sort the results by.", + "in": "QUERY", "type": "string", "required": false, - "enum": ["read", "write"], + "enum": ["asc", "desc"], "allowNull": false, "mapToData": null, "validation": null, @@ -9726,12 +14047,12 @@ "deprecated": null }, { - "name": "permissions.pull_requests", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. Can be one of: `read` or `write`.", - "in": "BODY", + "name": "sort", + "description": "The property by which to sort the results.", + "in": "QUERY", "type": "string", "required": false, - "enum": ["read", "write"], + "enum": ["created", "updated", "number"], "allowNull": false, "mapToData": null, "validation": null, @@ -9739,25 +14060,61 @@ "deprecated": null }, { - "name": "permissions.repository_hooks", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository. Can be one of: `read` or `write`.", - "in": "BODY", + "name": "state", + "description": "Set to `open`, `closed, `fixed`, or `dismissed` to list code scanning alerts in a specific state.", + "in": "QUERY", "type": "string", "required": false, - "enum": ["read", "write"], + "enum": ["open", "closed", "dismissed", "fixed"], "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"number\":4,\"created_at\":\"2020-02-13T12:29:18Z\",\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4\",\"html_url\":\"https://github.com/octocat/hello-world/code-scanning/4\",\"state\":\"open\",\"fixed_at\":null,\"dismissed_by\":null,\"dismissed_at\":null,\"dismissed_reason\":null,\"dismissed_comment\":null,\"rule\":{\"id\":\"js/zipslip\",\"severity\":\"error\",\"tags\":[\"security\",\"external/cwe/cwe-022\"],\"description\":\"Arbitrary file write during zip extraction\",\"name\":\"js/zipslip\"},\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"most_recent_instance\":{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"{}\",\"state\":\"open\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"spec-main/api-session-spec.ts\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"test\"]},\"instances_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances\"},{\"number\":3,\"created_at\":\"2020-02-13T12:29:18Z\",\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3\",\"html_url\":\"https://github.com/octocat/hello-world/code-scanning/3\",\"state\":\"dismissed\",\"fixed_at\":null,\"dismissed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"dismissed_at\":\"2020-02-14T12:29:18Z\",\"dismissed_reason\":\"false positive\",\"dismissed_comment\":\"This alert is not actually correct, because there's a sanitizer included in the library.\",\"rule\":{\"id\":\"js/zipslip\",\"severity\":\"error\",\"tags\":[\"security\",\"external/cwe/cwe-022\"],\"description\":\"Arbitrary file write during zip extraction\",\"name\":\"js/zipslip\"},\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"most_recent_instance\":{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"{}\",\"state\":\"open\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"lib/ab12-gen.js\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[]},\"instances_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances\"}]" + } + ] }, + { "code": 304, "description": "Not modified", "examples": null }, { - "name": "permissions.repository_projects", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards. Can be one of: `read`, `write`, or `admin`.", - "in": "BODY", + "code": 403, + "description": "Response if GitHub Advanced Security is not enabled for this repository", + "examples": null + }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 503, "description": "Service unavailable", "examples": null } + ], + "renamed": null + }, + { + "name": "List instances of a code scanning alert", + "scope": "codeScanning", + "id": "listAlertsInstances", + "method": "GET", + "url": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists all instances of the specified code scanning alert.\nYou must use an access token with the `security_events` scope to use this endpoint with private repos,\nthe `public_repo` scope also grants permission to read security events on public repos only.\nGitHub Apps must have the `security_events` read permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", "type": "string", - "required": false, - "enum": ["read", "write", "admin"], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -9765,12 +14122,12 @@ "deprecated": null }, { - "name": "permissions.secret_scanning_alerts", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts. Can be one of: `read` or `write`.", - "in": "BODY", + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", "type": "string", - "required": false, - "enum": ["read", "write"], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -9778,12 +14135,25 @@ "deprecated": null }, { - "name": "permissions.secrets", - "description": "The level of permission to grant the access token to manage repository secrets. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", + "name": "alert_number", + "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, - "enum": ["read", "write"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -9791,12 +14161,12 @@ "deprecated": null }, { - "name": "permissions.security_events", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", "required": false, - "enum": ["read", "write"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -9804,25 +14174,65 @@ "deprecated": null }, { - "name": "permissions.single_file", - "description": "The level of permission to grant the access token to manage just a single file. Can be one of: `read` or `write`.", - "in": "BODY", + "name": "ref", + "description": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", + "in": "QUERY", "type": "string", "required": false, - "enum": ["read", "write"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"\",\"state\":\"open\",\"fixed_at\":null,\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"lib/ab12-gen.js\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"library\"]},{\"ref\":\"refs/pull/3740/merge\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"\",\"category\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"state\":\"fixed\",\"fixed_at\":\"2020-02-14T12:29:18Z\",\"commit_sha\":\"b09da05606e27f463a2b49287684b4ae777092f2\",\"message\":{\"text\":\"This suffix check is missing a length comparison to correctly handle lastIndexOf returning -1.\"},\"location\":{\"path\":\"app/script.js\",\"start_line\":2,\"end_line\":2,\"start_column\":10,\"end_column\":50},\"classifications\":[\"source\"]}]" + } + ] }, { - "name": "permissions.statuses", - "description": "The level of permission to grant the access token for commit statuses. Can be one of: `read` or `write`.", - "in": "BODY", + "code": 403, + "description": "Response if GitHub Advanced Security is not enabled for this repository", + "examples": null + }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 503, "description": "Service unavailable", "examples": null } + ], + "renamed": { + "before": { "scope": "codeScanning", "id": "listAlertsInstances" }, + "after": { "scope": "codeScanning", "id": "listAlertInstances" }, + "date": "2021-04-30", + "note": null + } + }, + { + "name": "List code scanning analyses for a repository", + "scope": "codeScanning", + "id": "listRecentAnalyses", + "method": "GET", + "url": "/repos/{owner}/{repo}/code-scanning/analyses", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nYou must use an access token with the `security_events` scope to use this endpoint with private repos,\nthe `public_repo` scope also grants permission to read security events on public repos only.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.", + "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#list-code-scanning-analyses-for-a-repository", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", "type": "string", - "required": false, - "enum": ["read", "write"], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -9830,12 +14240,12 @@ "deprecated": null }, { - "name": "permissions.vulnerability_alerts", - "description": "The level of permission to grant the access token to retrieve Dependabot alerts. Can be one of: `read`.", - "in": "BODY", + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", "type": "string", - "required": false, - "enum": ["read"], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -9843,12 +14253,12 @@ "deprecated": null }, { - "name": "permissions.workflows", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files. Can be one of: `write`.", - "in": "BODY", + "name": "tool_name", + "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.", + "in": "QUERY", "type": "string", "required": false, - "enum": ["write"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -9856,12 +14266,12 @@ "deprecated": null }, { - "name": "permissions.members", - "description": "The level of permission to grant the access token for organization teams and members. Can be one of: `read` or `write`.", - "in": "BODY", + "name": "tool_guid", + "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.", + "in": "QUERY", "type": "string", "required": false, - "enum": ["read", "write"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -9869,12 +14279,12 @@ "deprecated": null }, { - "name": "permissions.organization_administration", - "description": "The level of permission to grant the access token to manage access to an organization. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, - "enum": ["read", "write"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -9882,12 +14292,12 @@ "deprecated": null }, { - "name": "permissions.organization_hooks", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", "required": false, - "enum": ["read", "write"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -9895,12 +14305,12 @@ "deprecated": null }, { - "name": "permissions.organization_plan", - "description": "The level of permission to grant the access token for viewing an organization's plan. Can be one of: `read`.", - "in": "BODY", + "name": "ref", + "description": "The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", + "in": "QUERY", "type": "string", "required": false, - "enum": ["read"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -9908,25 +14318,60 @@ "deprecated": null }, { - "name": "permissions.organization_projects", - "description": "The level of permission to grant the access token to manage organization projects, columns, and cards. Can be one of: `read`, `write`, or `admin`.", - "in": "BODY", + "name": "sarif_id", + "description": "Filter analyses belonging to the same SARIF upload.", + "in": "QUERY", "type": "string", "required": false, - "enum": ["read", "write", "admin"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"ref\":\"refs/heads/main\",\"commit_sha\":\"d99612c3e1f2970085cfbaeadf8f010ef69bad83\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:analyze\",\"environment\":\"{\\\"language\\\":\\\"python\\\"}\",\"error\":\"\",\"category\":\".github/workflows/codeql-analysis.yml:analyze/language:python\",\"created_at\":\"2020-08-27T15:05:21Z\",\"results_count\":17,\"rules_count\":49,\"id\":201,\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\"sarif_id\":\"6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53\",\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"deletable\":true,\"warning\":\"\"},{\"ref\":\"refs/heads/my-branch\",\"commit_sha\":\"c8cff6510d4d084fb1b4aa13b64b97ca12b07321\",\"analysis_key\":\".github/workflows/shiftleft.yml:build\",\"environment\":\"{}\",\"error\":\"\",\"category\":\".github/workflows/shiftleft.yml:build/\",\"created_at\":\"2020-08-31T22:46:44Z\",\"results_count\":17,\"rules_count\":32,\"id\":200,\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200\",\"sarif_id\":\"8981cd8e-b078-4ac3-a3be-1dad7dbd0b582\",\"tool\":{\"name\":\"Python Security Analysis\",\"guid\":null,\"version\":\"1.2.0\"},\"deletable\":true,\"warning\":\"\"}]" + } + ] }, { - "name": "permissions.organization_packages", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages. Can be one of: `read` or `write`.", - "in": "BODY", + "code": 403, + "description": "Response if GitHub Advanced Security is not enabled for this repository", + "examples": null + }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 503, "description": "Service unavailable", "examples": null } + ], + "renamed": null + }, + { + "name": "Update a code scanning alert", + "scope": "codeScanning", + "id": "updateAlert", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#update-a-code-scanning-alert", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", "type": "string", - "required": false, - "enum": ["read", "write"], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -9934,12 +14379,12 @@ "deprecated": null }, { - "name": "permissions.organization_secrets", - "description": "The level of permission to grant the access token to manage organization secrets. Can be one of: `read` or `write`.", - "in": "BODY", + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", "type": "string", - "required": false, - "enum": ["read", "write"], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -9947,12 +14392,25 @@ "deprecated": null }, { - "name": "permissions.organization_self_hosted_runners", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. Can be one of: `read` or `write`.", + "name": "alert_number", + "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "state", + "description": "Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`.", "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], + "type": "string", + "required": true, + "enum": ["open", "dismissed"], "allowNull": false, "mapToData": null, "validation": null, @@ -9960,26 +14418,26 @@ "deprecated": null }, { - "name": "permissions.organization_user_blocking", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization. Can be one of: `read` or `write`.", + "name": "dismissed_reason", + "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "in": "BODY", "type": "string", "required": false, - "enum": ["read", "write"], - "allowNull": false, + "enum": [null, "false positive", "won't fix", "used in tests"], + "allowNull": true, "mapToData": null, "validation": null, "alias": null, "deprecated": null }, { - "name": "permissions.team_discussions", - "description": "The level of permission to grant the access token to manage team discussions and related comments. Can be one of: `read` or `write`.", + "name": "dismissed_comment", + "description": "The dismissal comment associated with the dismissal of the alert.", "in": "BODY", "type": "string", "required": false, - "enum": ["read", "write"], - "allowNull": false, + "enum": null, + "allowNull": true, "mapToData": null, "validation": null, "alias": null, @@ -9992,40 +14450,39 @@ "description": "Response", "examples": [ { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[],\"token\":\"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\"token_last_eight\":\"Ae178B4a\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\",\"expires_at\":\"2011-09-08T17:26:27Z\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"installation\":{\"permissions\":{\"metadata\":\"read\",\"issues\":\"write\",\"contents\":\"read\"},\"repository_selection\":\"selected\",\"single_file_name\":\".github/workflow.yml\",\"repositories_url\":\"https://api.github.com/user/repos\",\"account\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"has_multiple_single_files\":false,\"single_file_paths\":[]}}" + "data": "{\"number\":42,\"created_at\":\"2020-08-25T21:28:36Z\",\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\"html_url\":\"https://github.com/octocat/hello-world/code-scanning/42\",\"state\":\"dismissed\",\"fixed_at\":null,\"dismissed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"dismissed_at\":\"2020-09-02T22:34:56Z\",\"dismissed_reason\":\"false positive\",\"dismissed_comment\":\"This alert is not actually correct, because there's a sanitizer included in the library.\",\"rule\":{\"id\":\"js/zipslip\",\"severity\":\"error\",\"security_severity_level\":\"high\",\"description\":\"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\"name\":\"js/zipslip\",\"full_description\":\"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\"tags\":[\"security\",\"external/cwe/cwe-022\"],\"help\":\"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"},\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"most_recent_instance\":{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"{}\",\"state\":\"dismissed\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"spec-main/api-session-spec.ts\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"test\"]},\"instances_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"}" } ] }, { - "code": 401, - "description": "Requires authentication", + "code": 403, + "description": "Response if the repository is archived or if github advanced security is not enabled for this repository", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } + { "code": 503, "description": "Service unavailable", "examples": null } ], "renamed": null }, { - "name": "Suspend an app installation", - "scope": "apps", - "id": "suspendInstallation", - "method": "PUT", - "url": "/app/installations/{installation_id}/suspended", + "name": "Upload an analysis as SARIF data", + "scope": "codeScanning", + "id": "uploadSarif", + "method": "POST", + "url": "/repos/{owner}/{repo}/code-scanning/sarifs", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/apps#suspend-an-app-installation", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum of 5000 results per analysis run. Any results over this limit are ignored and any SARIF uploads with more than 25,000 results are rejected. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", + "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#upload-a-sarif-file", "previews": [], "headers": [], "parameters": [ { - "name": "installation_id", - "description": "installation_id parameter", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -10033,33 +14490,12 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Unsuspend an app installation", - "scope": "apps", - "id": "unsuspendInstallation", - "method": "DELETE", - "url": "/app/installations/{installation_id}/suspended", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Removes a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/apps#unsuspend-an-app-installation", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "installation_id", - "description": "installation_id parameter", + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -10067,34 +14503,26 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Update a webhook configuration for an app", - "scope": "apps", - "id": "updateWebhookConfigForApp", - "method": "PATCH", - "url": "/app/hook/config", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/apps#update-a-webhook-configuration-for-an-app", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "url", - "description": "The URL to which the payloads will be delivered.", + "name": "commit_sha", + "description": "The SHA of the commit to which the analysis you are uploading relates.", "in": "BODY", "type": "string", - "required": false, + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": "^[0-9a-fA-F]+$", + "alias": null, + "deprecated": null + }, + { + "name": "ref", + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`.", + "in": "BODY", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -10103,8 +14531,21 @@ "deprecated": null }, { - "name": "content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "name": "sarif", + "description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/code-security/secure-coding/sarif-support-for-code-scanning).\"", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "checkout_uri", + "description": "The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.", "in": "BODY", "type": "string", "required": false, @@ -10116,8 +14557,8 @@ "deprecated": null }, { - "name": "secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", + "name": "started_at", + "description": "The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "BODY", "type": "string", "required": false, @@ -10129,10 +14570,10 @@ "deprecated": null }, { - "name": "insecure_ssl", - "description": "", + "name": "tool_name", + "description": "The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.", "in": "BODY", - "type": null, + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -10144,74 +14585,78 @@ ], "responses": [ { - "code": 200, + "code": 202, "description": "Response", "examples": [ { - "data": "{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\",\"url\":\"https://example.com/webhook\"}" + "data": "{\"id\":\"47177e22-5596-11eb-80a1-c1e54ef945c6\",\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6\"}" } ] - } + }, + { + "code": 400, + "description": "Bad Request if the sarif field is invalid", + "examples": null + }, + { + "code": 403, + "description": "Response if the repository is archived or if github advanced security is not enabled for this repository", + "examples": null + }, + { "code": 404, "description": "Resource not found", "examples": null }, + { + "code": 413, + "description": "Payload Too Large if the sarif field is too large", + "examples": null + }, + { "code": 503, "description": "Service unavailable", "examples": null } ], "renamed": null }, { - "name": "Get GitHub Actions billing for an organization", - "scope": "billing", - "id": "getGithubActionsBillingOrg", + "name": "Get all codes of conduct", + "scope": "codesOfConduct", + "id": "getAllCodesOfConduct", "method": "GET", - "url": "/orgs/{org}/settings/billing/actions", + "url": "/codes_of_conduct", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAccess tokens must have the `repo` or `admin:org` scope.", - "documentationUrl": "https://docs.github.com/rest/reference/billing#get-github-actions-billing-for-an-organization", + "description": "", + "documentationUrl": "https://docs.github.com/rest/reference/codes-of-conduct#get-all-codes-of-conduct", "previews": [], "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], + "parameters": [], "responses": [ { "code": 200, "description": "Response", "examples": [ { - "data": "{\"total_minutes_used\":305,\"total_paid_minutes_used\":0,\"included_minutes\":3000,\"minutes_used_breakdown\":{\"UBUNTU\":205,\"MACOS\":10,\"WINDOWS\":90}}" + "data": "[{\"key\":\"citizen_code_of_conduct\",\"name\":\"Citizen Code of Conduct\",\"url\":\"https://api.github.com/codes_of_conduct/citizen_code_of_conduct\",\"html_url\":\"http://citizencodeofconduct.org/\"},{\"key\":\"contributor_covenant\",\"name\":\"Contributor Covenant\",\"url\":\"https://api.github.com/codes_of_conduct/contributor_covenant\",\"html_url\":\"https://www.contributor-covenant.org/version/2/0/code_of_conduct/\"}]" } ] - } + }, + { "code": 304, "description": "Not modified", "examples": null } ], "renamed": null }, { - "name": "Get GitHub Actions billing for a user", - "scope": "billing", - "id": "getGithubActionsBillingUser", + "name": "Get a code of conduct", + "scope": "codesOfConduct", + "id": "getConductCode", "method": "GET", - "url": "/users/{username}/settings/billing/actions", + "url": "/codes_of_conduct/{key}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAccess tokens must have the `user` scope.", - "documentationUrl": "https://docs.github.com/rest/reference/billing#get-github-actions-billing-for-a-user", + "description": "", + "documentationUrl": "https://docs.github.com/rest/reference/codes-of-conduct#get-a-code-of-conduct", "previews": [], "headers": [], "parameters": [ { - "name": "username", + "name": "key", "description": "", "in": "PATH", "type": "string", @@ -10230,29 +14675,31 @@ "description": "Response", "examples": [ { - "data": "{\"total_minutes_used\":305,\"total_paid_minutes_used\":0,\"included_minutes\":3000,\"minutes_used_breakdown\":{\"UBUNTU\":205,\"MACOS\":10,\"WINDOWS\":90}}" + "data": "{\"key\":\"contributor_covenant\",\"name\":\"Contributor Covenant\",\"url\":\"https://api.github.com/codes_of_conduct/contributor_covenant\",\"body\":\"# Contributor Covenant Code of Conduct\\n\\n## Our Pledge\\n\\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\\n\\n## Our Standards\\n\\nExamples of behavior that contributes to creating a positive environment include:\\n\\n* Using welcoming and inclusive language\\n* Being respectful of differing viewpoints and experiences\\n* Gracefully accepting constructive criticism\\n* Focusing on what is best for the community\\n* Showing empathy towards other community members\\n\\nExamples of unacceptable behavior by participants include:\\n\\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\\n* Trolling, insulting/derogatory comments, and personal or political attacks\\n* Public or private harassment\\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\\n* Other conduct which could reasonably be considered inappropriate in a professional setting\\n\\n## Our Responsibilities\\n\\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\\n to any instances of unacceptable behavior.\\n\\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\\n\\n## Scope\\n\\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\\n\\n## Enforcement\\n\\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\\n\\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\\n\\n## Attribution\\n\\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\\n\\n[homepage]: http://contributor-covenant.org\\n[version]: http://contributor-covenant.org/version/1/4/\\n\",\"html_url\":\"http://contributor-covenant.org/version/1/4/\"}" } ] - } + }, + { "code": 304, "description": "Not modified", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } ], "renamed": null }, { - "name": "Get GitHub Packages billing for an organization", - "scope": "billing", - "id": "getGithubPackagesBillingOrg", + "name": "Get the code of conduct for a repository", + "scope": "codesOfConduct", + "id": "getForRepo", "method": "GET", - "url": "/orgs/{org}/settings/billing/packages", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Gets the free and paid storage used for GitHub Packages in gigabytes.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nAccess tokens must have the `repo` or `admin:org` scope.", - "documentationUrl": "https://docs.github.com/rest/reference/billing#get-github-packages-billing-for-an-organization", - "previews": [], + "url": "/repos/{owner}/{repo}/community/code_of_conduct", + "isDeprecated": true, + "deprecationDate": "2021-09-29", + "removalDate": "2021-09-29", + "description": "Returns the contents of the repository's code of conduct file, if one is detected.\n\nA code of conduct is detected if there is a file named `CODE_OF_CONDUCT` in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching.", + "documentationUrl": "https://docs.github.com/rest/reference/codes-of-conduct#get-the-code-of-conduct-for-a-repository", + "previews": [{ "name": "scarlet-witch" }], "headers": [], "parameters": [ { - "name": "org", + "name": "owner", "description": "", "in": "PATH", "type": "string", @@ -10263,37 +14710,9 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_gigabytes_bandwidth_used\":50,\"total_paid_gigabytes_bandwidth_used\":40,\"included_gigabytes_bandwidth\":10}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get GitHub Packages billing for a user", - "scope": "billing", - "id": "getGithubPackagesBillingUser", - "method": "GET", - "url": "/users/{username}/settings/billing/packages", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Gets the free and paid storage used for GitHub Packages in gigabytes.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nAccess tokens must have the `user` scope.", - "documentationUrl": "https://docs.github.com/rest/reference/billing#get-github-packages-billing-for-a-user", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "username", + "name": "repo", "description": "", "in": "PATH", "type": "string", @@ -10312,7 +14731,7 @@ "description": "Response", "examples": [ { - "data": "{\"total_gigabytes_bandwidth_used\":50,\"total_paid_gigabytes_bandwidth_used\":40,\"included_gigabytes_bandwidth\":10}" + "data": "{\"key\":\"contributor_covenant\",\"name\":\"Contributor Covenant\",\"url\":\"https://github.com/LindseyB/cosee/blob/master/CODE_OF_CONDUCT.md\",\"body\":\"# Contributor Covenant Code of Conduct\\n\\n## Our Pledge\\n\\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\\n\\n## Our Standards\\n\\nExamples of behavior that contributes to creating a positive environment include:\\n\\n* Using welcoming and inclusive language\\n* Being respectful of differing viewpoints and experiences\\n* Gracefully accepting constructive criticism\\n* Focusing on what is best for the community\\n* Showing empathy towards other community members\\n\\nExamples of unacceptable behavior by participants include:\\n\\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\\n* Trolling, insulting/derogatory comments, and personal or political attacks\\n* Public or private harassment\\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\\n* Other conduct which could reasonably be considered inappropriate in a professional setting\\n\\n## Our Responsibilities\\n\\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\\nto any instances of unacceptable behavior.\\n\\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\\n\\n## Scope\\n\\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\\nposting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\\n\\n## Enforcement\\n\\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at lindseyb@github.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\\n\\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\\n\\n## Attribution\\n\\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\\n\\n[homepage]: http://contributor-covenant.org\\n[version]: http://contributor-covenant.org/version/1/4/\\n\",\"html_url\":\"https://github.com/LindseyB/cosee/blob/master/CODE_OF_CONDUCT.md\"}" } ] } @@ -10320,22 +14739,22 @@ "renamed": null }, { - "name": "Get shared storage billing for an organization", - "scope": "billing", - "id": "getSharedStorageBillingOrg", - "method": "GET", - "url": "/orgs/{org}/settings/billing/shared-storage", + "name": "Add a selected repository to a user secret", + "scope": "codespaces", + "id": "addRepositoryForSecretForAuthenticatedUser", + "method": "PUT", + "url": "/user/codespaces/secrets/{secret_name}/repositories/{repository_id}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nAccess tokens must have the `repo` or `admin:org` scope.", - "documentationUrl": "https://docs.github.com/rest/reference/billing#get-shared-storage-billing-for-an-organization", + "description": "Adds a repository to the selected repositories for a user's codespace secret.\nYou must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.\nGitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on the referenced repository to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#add-a-selected-repository-to-a-user-secret", "previews": [], "headers": [], "parameters": [ { - "name": "org", - "description": "", + "name": "secret_name", + "description": "The name of the secret.", "in": "PATH", "type": "string", "required": true, @@ -10345,38 +14764,55 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "repository_id", + "description": "", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"days_left_in_billing_cycle\":20,\"estimated_paid_storage_for_month\":15,\"estimated_storage_for_month\":40}" - } - ] - } + "code": 204, + "description": "No Content when repository was added to the selected list", + "examples": null + }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 500, "description": "Internal Error", "examples": null } ], "renamed": null }, { - "name": "Get shared storage billing for a user", - "scope": "billing", - "id": "getSharedStorageBillingUser", + "name": "List machine types for a codespace", + "scope": "codespaces", + "id": "codespaceMachinesForAuthenticatedUser", "method": "GET", - "url": "/users/{username}/settings/billing/shared-storage", + "url": "/user/codespaces/{codespace_name}/machines", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nAccess tokens must have the `user` scope.", - "documentationUrl": "https://docs.github.com/rest/reference/billing#get-shared-storage-billing-for-a-user", + "description": "List the machine types a codespace can transition to use.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#list-machine-types-for-a-codespace", "previews": [], "headers": [], "parameters": [ { - "name": "username", - "description": "", + "name": "codespace_name", + "description": "The name of the codespace.", "in": "PATH", "type": "string", "required": true, @@ -10394,32 +14830,41 @@ "description": "Response", "examples": [ { - "data": "{\"days_left_in_billing_cycle\":20,\"estimated_paid_storage_for_month\":15,\"estimated_storage_for_month\":40}" + "data": "{\"total_count\":2,\"machines\":[{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},{\"name\":\"premiumLinux\",\"display_name\":\"8 cores, 16 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":17179869184,\"cpus\":8}]}" } ] - } + }, + { "code": 304, "description": "Not modified", "examples": null }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 500, "description": "Internal Error", "examples": null } ], "renamed": null }, { - "name": "Create a check run", - "scope": "checks", - "id": "create", + "name": "Create a codespace for the authenticated user", + "scope": "codespaces", + "id": "createForAuthenticatedUser", "method": "POST", - "url": "/repos/{owner}/{repo}/check-runs", + "url": "/user/codespaces", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.\n\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.", - "documentationUrl": "https://docs.github.com/rest/reference/checks#create-a-check-run", + "description": "Creates a new codespace, owned by the authenticated user.\n\nThis endpoint requires either a `repository_id` OR a `pull_request` but not both.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#create-a-codespace-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", + "name": "repository_id", + "description": "Repository id for this codespace", + "in": "BODY", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -10429,11 +14874,11 @@ "deprecated": null }, { - "name": "repo", - "description": "", - "in": "PATH", + "name": "ref", + "description": "Git ref (typically a branch name) for this codespace", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -10442,12 +14887,12 @@ "deprecated": null }, { - "name": "status", - "description": "", + "name": "location", + "description": "Location for this codespace. Assigned by IP if not provided", "in": "BODY", - "type": null, + "type": "string", "required": false, - "enum": ["queued", "in_progress"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -10455,10 +14900,10 @@ "deprecated": null }, { - "name": "*", - "description": "", + "name": "client_ip", + "description": "IP for location auto-detection when proxying a request", "in": "BODY", - "type": "object", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -10466,41 +14911,13 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"https://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a check suite", - "scope": "checks", - "id": "createSuite", - "method": "POST", - "url": "/repos/{owner}/{repo}/check-suites", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nBy default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites)\". Your GitHub App must have the `checks:write` permission to create check suites.", - "documentationUrl": "https://docs.github.com/rest/reference/checks#create-a-check-suite", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "owner", - "description": "", - "in": "PATH", + "name": "machine", + "description": "Machine type to use for this codespace", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -10509,11 +14926,11 @@ "deprecated": null }, { - "name": "repo", - "description": "", - "in": "PATH", + "name": "devcontainer_path", + "description": "Path to devcontainer.json config to use for this codespace", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -10522,60 +14939,62 @@ "deprecated": null }, { - "name": "head_sha", - "description": "The sha of the head commit.", + "name": "multi_repo_permissions_opt_out", + "description": "Whether to authorize requested permissions from devcontainer.json", "in": "BODY", - "type": "string", - "required": true, + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ + }, { - "code": 200, - "description": "when the suite already existed", - "examples": [ - { - "data": "{\"id\":5,\"node_id\":\"MDEwOkNoZWNrU3VpdGU1\",\"head_branch\":\"master\",\"head_sha\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"url\":\"https://api.github.com/repos/github/hello-world/check-suites/5\",\"before\":\"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\"after\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"pull_requests\":[],\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"delete_branch_on_merge\":true,\"subscribers_count\":42,\"network_count\":0},\"head_commit\":{\"id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"tree_id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"message\":\"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\"timestamp\":\"2016-10-10T00:00:00Z\",\"author\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"committer\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"}},\"latest_check_runs_count\":1,\"check_runs_url\":\"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"}" - } - ] + "name": "working_directory", + "description": "Working directory for this codespace", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null }, { - "code": 201, - "description": "Response when the suite was created", - "examples": [ - { - "data": "{\"id\":5,\"node_id\":\"MDEwOkNoZWNrU3VpdGU1\",\"head_branch\":\"master\",\"head_sha\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"url\":\"https://api.github.com/repos/github/hello-world/check-suites/5\",\"before\":\"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\"after\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"pull_requests\":[],\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"delete_branch_on_merge\":true,\"subscribers_count\":42,\"network_count\":0},\"head_commit\":{\"id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"tree_id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"message\":\"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\"timestamp\":\"2016-10-10T00:00:00Z\",\"author\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"committer\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"}},\"latest_check_runs_count\":1,\"check_runs_url\":\"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a check run", - "scope": "checks", - "id": "get", - "method": "GET", - "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nGets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.", - "documentationUrl": "https://docs.github.com/rest/reference/checks#get-a-check-run", - "previews": [], - "headers": [], - "parameters": [ + "name": "idle_timeout_minutes", + "description": "Time in minutes before codespace stops from inactivity", + "in": "BODY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { - "name": "owner", - "description": "", - "in": "PATH", + "name": "display_name", + "description": "Display name for this codespace", + "in": "BODY", "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "pull_request", + "description": "Pull request number for this codespace", + "in": "BODY", + "type": "object", "required": true, "enum": null, "allowNull": false, @@ -10585,10 +15004,10 @@ "deprecated": null }, { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", + "name": "pull_request.pull_request_number", + "description": "Pull request number", + "in": "BODY", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -10598,9 +15017,9 @@ "deprecated": null }, { - "name": "check_run_id", - "description": "check_run_id parameter", - "in": "PATH", + "name": "pull_request.repository_id", + "description": "Repository id for this codespace", + "in": "BODY", "type": "integer", "required": true, "enum": null, @@ -10613,34 +15032,50 @@ ], "responses": [ { - "code": 200, - "description": "Response", + "code": 201, + "description": "Response when the codespace was successfully created", "examples": [ { - "data": "{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"https://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}" + "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"billable_owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[]}" } ] - } + }, + { + "code": 202, + "description": "Response when the codespace creation partially failed but is being retried in the background", + "examples": [ + { + "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"billable_owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[]}" + } + ] + }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } ], "renamed": null }, { - "name": "Get a check suite", - "scope": "checks", - "id": "getSuite", - "method": "GET", - "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}", + "name": "Create or update a repository secret", + "scope": "codespaces", + "id": "createOrUpdateRepoSecret", + "method": "PUT", + "url": "/repos/{owner}/{repo}/codespaces/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nGets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.", - "documentationUrl": "https://docs.github.com/rest/reference/checks#get-a-check-suite", + "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets` repository\npermission to use this endpoint.\n\n#### Example of encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example of encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example of encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example of encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#create-or-update-a-repository-secret", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -10653,7 +15088,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -10665,10 +15100,10 @@ "deprecated": null }, { - "name": "check_suite_id", - "description": "check_suite_id parameter", + "name": "secret_name", + "description": "The name of the secret.", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -10676,38 +15111,65 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "encrypted_value", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/codespaces#get-a-repository-public-key) endpoint.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", + "alias": null, + "deprecated": null + }, + { + "name": "key_id", + "description": "ID of the key you used to encrypt the secret.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":5,\"node_id\":\"MDEwOkNoZWNrU3VpdGU1\",\"head_branch\":\"master\",\"head_sha\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"url\":\"https://api.github.com/repos/github/hello-world/check-suites/5\",\"before\":\"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\"after\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"pull_requests\":[],\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"delete_branch_on_merge\":true,\"subscribers_count\":42,\"network_count\":0},\"head_commit\":{\"id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"tree_id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"message\":\"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\"timestamp\":\"2016-10-10T00:00:00Z\",\"author\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"committer\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"}},\"latest_check_runs_count\":1,\"check_runs_url\":\"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"}" - } - ] + "code": 201, + "description": "Response when creating a secret", + "examples": null + }, + { + "code": 204, + "description": "Response when updating a secret", + "examples": null } ], "renamed": null }, { - "name": "List check run annotations", - "scope": "checks", - "id": "listAnnotations", - "method": "GET", - "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", + "name": "Create or update a secret for the authenticated user", + "scope": "codespaces", + "id": "createOrUpdateSecretForAuthenticatedUser", + "method": "PUT", + "url": "/user/codespaces/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository.", - "documentationUrl": "https://docs.github.com/rest/reference/checks#list-check-run-annotations", + "description": "Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages).\n\nYou must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces_user_secrets` user permission and `codespaces_secrets` repository permission on all referenced repositories to use this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#create-or-update-a-secret-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "", + "name": "secret_name", + "description": "The name of the secret.", "in": "PATH", "type": "string", "required": true, @@ -10719,23 +15181,23 @@ "deprecated": null }, { - "name": "repo", - "description": "", - "in": "PATH", + "name": "encrypted_value", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/reference/codespaces#get-the-public-key-for-the-authenticated-user) endpoint.", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, - "validation": null, + "validation": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "alias": null, "deprecated": null }, { - "name": "check_run_id", - "description": "check_run_id parameter", - "in": "PATH", - "type": "integer", + "name": "key_id", + "description": "ID of the key you used to encrypt the secret.", + "in": "BODY", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -10745,23 +15207,10 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", + "name": "selected_repository_ids", + "description": "An array of repository ids that can access the user secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret), [Set selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#set-selected-repositories-for-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret) endpoints.", + "in": "BODY", + "type": "string[]", "required": false, "enum": null, "allowNull": false, @@ -10773,34 +15222,37 @@ ], "responses": [ { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"path\":\"README.md\",\"start_line\":2,\"end_line\":2,\"start_column\":5,\"end_column\":10,\"annotation_level\":\"warning\",\"title\":\"Spell Checker\",\"message\":\"Check your spelling for 'banaas'.\",\"raw_details\":\"Do you mean 'bananas' or 'banana'?\",\"blob_href\":\"https://api.github.com/repos/github/rest-api-description/git/blobs/abc\"}]" - } - ] - } + "code": 201, + "description": "Response after successfully creaing a secret", + "examples": null + }, + { + "code": 204, + "description": "Response after successfully updating a secret", + "examples": null + }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 422, "description": "Validation failed", "examples": null } ], "renamed": null }, { - "name": "List check runs for a Git reference", - "scope": "checks", - "id": "listForRef", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}/check-runs", + "name": "Create a codespace from a pull request", + "scope": "codespaces", + "id": "createWithPrForAuthenticatedUser", + "method": "POST", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.", - "documentationUrl": "https://docs.github.com/rest/reference/checks#list-check-runs-for-a-git-reference", + "description": "Creates a codespace owned by the authenticated user for the specified pull request.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#create-a-codespace-from-a-pull-request", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -10813,7 +15265,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -10825,10 +15277,10 @@ "deprecated": null }, { - "name": "ref", - "description": "ref parameter", + "name": "pull_number", + "description": "The number that identifies the pull request.", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -10838,9 +15290,9 @@ "deprecated": null }, { - "name": "check_name", - "description": "Returns check runs with the specified `name`.", - "in": "QUERY", + "name": "location", + "description": "Location for this codespace. Assigned by IP if not provided", + "in": "BODY", "type": "string", "required": false, "enum": null, @@ -10851,12 +15303,12 @@ "deprecated": null }, { - "name": "status", - "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.", - "in": "QUERY", + "name": "client_ip", + "description": "IP for location auto-detection when proxying a request", + "in": "BODY", "type": "string", "required": false, - "enum": ["queued", "in_progress", "completed"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -10864,12 +15316,12 @@ "deprecated": null }, { - "name": "filter", - "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.", - "in": "QUERY", + "name": "machine", + "description": "Machine type to use for this codespace", + "in": "BODY", "type": "string", "required": false, - "enum": ["latest", "all"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -10877,10 +15329,10 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", + "name": "devcontainer_path", + "description": "Path to devcontainer.json config to use for this codespace", + "in": "BODY", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -10890,10 +15342,10 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", + "name": "multi_repo_permissions_opt_out", + "description": "Whether to authorize requested permissions from devcontainer.json", + "in": "BODY", + "type": "boolean", "required": false, "enum": null, "allowNull": false, @@ -10903,9 +15355,22 @@ "deprecated": null }, { - "name": "app_id", - "description": "", - "in": "QUERY", + "name": "working_directory", + "description": "Working directory for this codespace", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "idle_timeout_minutes", + "description": "Time in minutes before codespace stops from inactivity", + "in": "BODY", "type": "integer", "required": false, "enum": null, @@ -10914,38 +15379,67 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "display_name", + "description": "Display name for this codespace", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ { - "code": 200, - "description": "Response", + "code": 201, + "description": "Response when the codespace was successfully created", "examples": [ { - "data": "{\"total_count\":1,\"check_runs\":[{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"https://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}]}" + "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"billable_owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[]}" } ] - } + }, + { + "code": 202, + "description": "Response when the codespace creation partially failed but is being retried in the background", + "examples": [ + { + "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"billable_owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[]}" + } + ] + }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } ], "renamed": null }, { - "name": "List check runs in a check suite", - "scope": "checks", - "id": "listForSuite", - "method": "GET", - "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", + "name": "Create a codespace in a repository", + "scope": "codespaces", + "id": "createWithRepoForAuthenticatedUser", + "method": "POST", + "url": "/repos/{owner}/{repo}/codespaces", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.", - "documentationUrl": "https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite", + "description": "Creates a codespace owned by the authenticated user in the specified repository.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#create-a-codespace-in-a-repository", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -10958,7 +15452,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -10970,11 +15464,11 @@ "deprecated": null }, { - "name": "check_suite_id", - "description": "check_suite_id parameter", - "in": "PATH", - "type": "integer", - "required": true, + "name": "ref", + "description": "Git ref (typically a branch name) for this codespace", + "in": "BODY", + "type": "string", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -10983,9 +15477,9 @@ "deprecated": null }, { - "name": "check_name", - "description": "Returns check runs with the specified `name`.", - "in": "QUERY", + "name": "location", + "description": "Location for this codespace. Assigned by IP if not provided", + "in": "BODY", "type": "string", "required": false, "enum": null, @@ -10996,12 +15490,12 @@ "deprecated": null }, { - "name": "status", - "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.", - "in": "QUERY", + "name": "client_ip", + "description": "IP for location auto-detection when proxying a request", + "in": "BODY", "type": "string", "required": false, - "enum": ["queued", "in_progress", "completed"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -11009,12 +15503,12 @@ "deprecated": null }, { - "name": "filter", - "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.", - "in": "QUERY", + "name": "machine", + "description": "Machine type to use for this codespace", + "in": "BODY", "type": "string", "required": false, - "enum": ["latest", "all"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -11022,10 +15516,10 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", + "name": "devcontainer_path", + "description": "Path to devcontainer.json config to use for this codespace", + "in": "BODY", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -11035,9 +15529,35 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", + "name": "multi_repo_permissions_opt_out", + "description": "Whether to authorize requested permissions from devcontainer.json", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "working_directory", + "description": "Working directory for this codespace", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "idle_timeout_minutes", + "description": "Time in minutes before codespace stops from inactivity", + "in": "BODY", "type": "integer", "required": false, "enum": null, @@ -11046,38 +15566,67 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "display_name", + "description": "Display name for this codespace", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ { - "code": 200, - "description": "Response", + "code": 201, + "description": "Response when the codespace was successfully created", "examples": [ { - "data": "{\"total_count\":1,\"check_runs\":[{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"https://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}]}" + "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"billable_owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[]}" } ] - } + }, + { + "code": 202, + "description": "Response when the codespace creation partially failed but is being retried in the background", + "examples": [ + { + "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"billable_owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[]}" + } + ] + }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } ], "renamed": null }, { - "name": "List check suites for a Git reference", - "scope": "checks", - "id": "listSuitesForRef", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}/check-suites", + "name": "Delete a codespace for the authenticated user", + "scope": "codespaces", + "id": "deleteForAuthenticatedUser", + "method": "DELETE", + "url": "/user/codespaces/{codespace_name}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nLists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.", - "documentationUrl": "https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference", + "description": "Deletes a user's codespace.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#delete-a-codespace-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "", + "name": "codespace_name", + "description": "The name of the codespace.", "in": "PATH", "type": "string", "required": true, @@ -11087,10 +15636,39 @@ "validation": null, "alias": null, "deprecated": null + } + ], + "responses": [ + { "code": 202, "description": "Accepted", "examples": null }, + { "code": 304, "description": "Not modified", "examples": null }, + { + "code": 401, + "description": "Requires authentication", + "examples": null }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 500, "description": "Internal Error", "examples": null } + ], + "renamed": null + }, + { + "name": "Delete a repository secret", + "scope": "codespaces", + "id": "deleteRepoSecret", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/codespaces/secrets/{secret_name}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#delete-a-repository-secret", + "previews": [], + "headers": [], + "parameters": [ { - "name": "repo", - "description": "", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -11102,8 +15680,8 @@ "deprecated": null }, { - "name": "ref", - "description": "ref parameter", + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -11115,50 +15693,73 @@ "deprecated": null }, { - "name": "app_id", - "description": "Filters check suites by GitHub App `id`.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "check_name", - "description": "Returns check runs with the specified `name`.", - "in": "QUERY", + "name": "secret_name", + "description": "The name of the secret.", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [{ "code": 204, "description": "Response", "examples": null }], + "renamed": null + }, + { + "name": "Delete a secret for the authenticated user", + "scope": "codespaces", + "id": "deleteSecretForAuthenticatedUser", + "method": "DELETE", + "url": "/user/codespaces/secrets/{secret_name}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Deletes a secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret.\n\nYou must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#delete-a-secret-for-the-authenticated-user", + "previews": [], + "headers": [], + "parameters": [ { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "secret_name", + "description": "The name of the secret.", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [{ "code": 204, "description": "Response", "examples": null }], + "renamed": null + }, + { + "name": "Export a codespace for the authenticated user", + "scope": "codespaces", + "id": "exportForAuthenticatedUser", + "method": "POST", + "url": "/user/codespaces/{codespace_name}/exports", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored.\n\nYou must authenticate using a personal access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.", + "documentationUrl": "", + "previews": [], + "headers": [], + "parameters": [ { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "codespace_name", + "description": "The name of the codespace.", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -11169,34 +15770,43 @@ ], "responses": [ { - "code": 200, + "code": 202, "description": "Response", "examples": [ { - "data": "{\"total_count\":1,\"check_suites\":[{\"id\":5,\"node_id\":\"MDEwOkNoZWNrU3VpdGU1\",\"head_branch\":\"master\",\"head_sha\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"url\":\"https://api.github.com/repos/github/hello-world/check-suites/5\",\"before\":\"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\"after\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"pull_requests\":[],\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"delete_branch_on_merge\":true,\"subscribers_count\":42,\"network_count\":0},\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"head_commit\":{\"id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"tree_id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"message\":\"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\"timestamp\":\"2016-10-10T00:00:00Z\",\"author\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"committer\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"}},\"latest_check_runs_count\":1,\"check_runs_url\":\"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"}]}" + "data": "{\"state\":\"succeeded\",\"completed_at\":\"2022-01-01T14:59:22Z\",\"branch\":\"codespace-monalisa-octocat-hello-world-g4wpq6h95q\",\"sha\":\"fd95a81ca01e48ede9f39c799ecbcef817b8a3b2\",\"id\":\"latest\",\"export_url\":\"https://api.github.com/user/codespaces/:name/exports/latest\"}" } ] - } + }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 422, "description": "Validation failed", "examples": null }, + { "code": 500, "description": "Internal Error", "examples": null } ], "renamed": null }, { - "name": "Rerequest a check run", - "scope": "checks", - "id": "rerequestRun", - "method": "POST", - "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest", + "name": "Get details about a codespace export", + "scope": "codespaces", + "id": "getExportDetailsForAuthenticatedUser", + "method": "GET", + "url": "/user/codespaces/{codespace_name}/exports/{export_id}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "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.", - "documentationUrl": "https://docs.github.com/rest/reference/checks#rerequest-a-check-run", + "description": "Gets information about an export of a codespace.\n\nYou must authenticate using a personal access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.", + "documentationUrl": "", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "", + "name": "codespace_name", + "description": "The name of the codespace.", "in": "PATH", "type": "string", "required": true, @@ -11208,8 +15818,8 @@ "deprecated": null }, { - "name": "repo", - "description": "", + "name": "export_id", + "description": "The ID of the export operation, or `latest`. Currently only `latest` is currently supported.", "in": "PATH", "type": "string", "required": true, @@ -11219,12 +15829,41 @@ "validation": null, "alias": null, "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"state\":\"succeeded\",\"completed_at\":\"2022-01-01T14:59:22Z\",\"branch\":\"codespace-monalisa-octocat-hello-world-g4wpq6h95q\",\"sha\":\"fd95a81ca01e48ede9f39c799ecbcef817b8a3b2\",\"id\":\"latest\",\"export_url\":\"https://api.github.com/user/codespaces/:name/exports/latest\"}" + } + ] }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "Get a codespace for the authenticated user", + "scope": "codespaces", + "id": "getForAuthenticatedUser", + "method": "GET", + "url": "/user/codespaces/{codespace_name}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Gets information about a user's codespace.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces` repository permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#get-a-codespace-for-the-authenticated-user", + "previews": [], + "headers": [], + "parameters": [ { - "name": "check_run_id", - "description": "check_run_id parameter", + "name": "codespace_name", + "description": "The name of the codespace.", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -11235,51 +15874,71 @@ } ], "responses": [ - { "code": 201, "description": "Response", "examples": null }, { - "code": 403, - "description": "Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App", + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"billable_owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[]}" + } + ] + }, + { "code": 304, "description": "Not modified", "examples": null }, + { + "code": 401, + "description": "Requires authentication", "examples": null }, + { "code": 403, "description": "Forbidden", "examples": null }, { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 500, "description": "Internal Error", "examples": null } + ], + "renamed": null + }, + { + "name": "Get public key for the authenticated user", + "scope": "codespaces", + "id": "getPublicKeyForAuthenticatedUser", + "method": "GET", + "url": "/user/codespaces/secrets/public-key", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.\n\nYou must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#get-public-key-for-the-authenticated-user", + "previews": [], + "headers": [], + "parameters": [], + "responses": [ { - "code": 422, - "description": "Validation error if the check run is not rerequestable", - "examples": null + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"key_id\":\"012345678912345678\",\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\"}" + } + ] } ], "renamed": null }, { - "name": "Rerequest a check suite", - "scope": "checks", - "id": "rerequestSuite", - "method": "POST", - "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", + "name": "Get a repository public key", + "scope": "codespaces", + "id": "getRepoPublicKey", + "method": "GET", + "url": "/repos/{owner}/{repo}/codespaces/secrets/public-key", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.", - "documentationUrl": "https://docs.github.com/rest/reference/checks#rerequest-a-check-suite", + "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#get-a-repository-public-key", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -11291,10 +15950,10 @@ "deprecated": null }, { - "name": "check_suite_id", - "description": "check_suite_id parameter", + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -11304,26 +15963,36 @@ "deprecated": null } ], - "responses": [{ "code": 201, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"key_id\":\"012345678912345678\",\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\"}" + } + ] + } + ], "renamed": null }, { - "name": "Update repository preferences for check suites", - "scope": "checks", - "id": "setSuitesPreferences", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/check-suites/preferences", + "name": "Get a repository secret", + "scope": "codespaces", + "id": "getRepoSecret", + "method": "GET", + "url": "/repos/{owner}/{repo}/codespaces/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites.", - "documentationUrl": "https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites", + "description": "Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#get-a-repository-secret", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -11336,7 +16005,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -11348,36 +16017,10 @@ "deprecated": null }, { - "name": "auto_trigger_checks", - "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/rest/reference/checks#auto_trigger_checks-object) description for details.", - "in": "BODY", - "type": "object[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "auto_trigger_checks[].app_id", - "description": "The `id` of the GitHub App.", - "in": "BODY", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "auto_trigger_checks[].setting", - "description": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", - "in": "BODY", - "type": "boolean", + "name": "secret_name", + "description": "The name of the secret.", + "in": "PATH", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -11393,7 +16036,7 @@ "description": "Response", "examples": [ { - "data": "{\"preferences\":{\"auto_trigger_checks\":[{\"app_id\":2,\"setting\":true},{\"app_id\":4,\"setting\":false}]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}}" + "data": "{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"}" } ] } @@ -11401,22 +16044,22 @@ "renamed": null }, { - "name": "Update a check run", - "scope": "checks", - "id": "update", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}", + "name": "Get a secret for the authenticated user", + "scope": "codespaces", + "id": "getSecretForAuthenticatedUser", + "method": "GET", + "url": "/user/codespaces/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nUpdates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.", - "documentationUrl": "https://docs.github.com/rest/reference/checks#update-a-check-run", + "description": "Gets a secret available to a user's codespaces without revealing its encrypted value.\n\nYou must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#get-a-secret-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "", + "name": "secret_name", + "description": "The name of the secret.", "in": "PATH", "type": "string", "required": true, @@ -11426,26 +16069,41 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"name\":\"CODESPACE_GH_SECRET\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"selected\",\"selected_repositories_url\":\"https://api.github.com/user/codespaces/secrets/CODESPACE_GH_SECRET/repositories\"}" + } + ] + } + ], + "renamed": null + }, + { + "name": "List devcontainer configurations in a repository for the authenticated user", + "scope": "codespaces", + "id": "listDevcontainersInRepositoryForAuthenticatedUser", + "method": "GET", + "url": "/repos/{owner}/{repo}/codespaces/devcontainers", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files\nspecify launchpoint configurations for codespaces created within the repository.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#list-devcontainers-in-a-repository-for-the-authenticated-user", + "previews": [], + "headers": [], + "parameters": [ { - "name": "check_run_id", - "description": "check_run_id parameter", - "in": "PATH", + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", "type": "integer", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -11454,10 +16112,10 @@ "deprecated": null }, { - "name": "name", - "description": "The name of the check. For example, \"code-coverage\".", - "in": "BODY", - "type": "string", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -11467,11 +16125,11 @@ "deprecated": null }, { - "name": "details_url", - "description": "The URL of the integrator's site that has the full details of the check.", - "in": "BODY", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -11480,38 +16138,63 @@ "deprecated": null }, { - "name": "external_id", - "description": "A reference for the run on the integrator's system.", - "in": "BODY", + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"devcontainers\":[{\"path\":\".devcontainer/foobar/devcontainer.json\",\"name\":\"foobar\"},{\"path\":\".devcontainer/devcontainer.json\",\"name\":\"kitchensink\"},{\"path\":\".devcontainer.json\"}],\"total_count\":3}" + } + ] }, + { "code": 400, "description": "Bad Request", "examples": null }, + { "code": 400, "description": "Bad Request", "examples": null }, { - "name": "started_at", - "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null + "code": 401, + "description": "Requires authentication", + "examples": null }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 500, "description": "Internal Error", "examples": null } + ], + "renamed": null + }, + { + "name": "List codespaces for the authenticated user", + "scope": "codespaces", + "id": "listForAuthenticatedUser", + "method": "GET", + "url": "/user/codespaces", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists the authenticated user's codespaces.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces` repository permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#list-codespaces-for-the-authenticated-user", + "previews": [], + "headers": [], + "parameters": [ { - "name": "status", - "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", - "in": "BODY", - "type": "string", + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", "required": false, - "enum": ["queued", "in_progress", "completed"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -11519,21 +16202,12 @@ "deprecated": null }, { - "name": "conclusion", - "description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.", - "in": "BODY", - "type": "string", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, - "enum": [ - "action_required", - "cancelled", - "failure", - "neutral", - "success", - "skipped", - "stale", - "timed_out" - ], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -11541,10 +16215,10 @@ "deprecated": null }, { - "name": "completed_at", - "description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", - "type": "string", + "name": "repository_id", + "description": "ID of the Repository to filter on", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -11552,12 +16226,49 @@ "validation": null, "alias": null, "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_count\":3,\"codespaces\":[{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"billable_owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"recent_folders\":[]},{\"id\":1,\"name\":\"monalisa-octocat-hello-world-3f89ada1j3\",\"environment_id\":\"526ce4d7-46da-494f-a4f9-cfd25b818719\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"billable_owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/foobar/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-3f89ada1j3.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop\",\"recent_folders\":[]},{\"id\":1,\"name\":\"monalisa-octocat-hello-world-f8adfad99a\",\"environment_id\":\"6ac8cd6d-a2d0-4ae3-8cea-e135059264df\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"billable_owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-f8adfad99a.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop\",\"recent_folders\":[]}]}" + } + ] }, + { "code": 304, "description": "Not modified", "examples": null }, { - "name": "output", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/rest/reference/checks#output-object-1) description.", - "in": "BODY", - "type": "object", + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 500, "description": "Internal Error", "examples": null } + ], + "renamed": null + }, + { + "name": "List codespaces in a repository for the authenticated user", + "scope": "codespaces", + "id": "listInRepositoryForAuthenticatedUser", + "method": "GET", + "url": "/repos/{owner}/{repo}/codespaces", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists the codespaces associated to a specified repository and the authenticated user.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces` repository permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#list-codespaces-in-a-repository-for-the-authenticated-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -11567,10 +16278,10 @@ "deprecated": null }, { - "name": "output.title", - "description": "**Required**.", - "in": "BODY", - "type": "string", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -11580,9 +16291,9 @@ "deprecated": null }, { - "name": "output.summary", - "description": "Can contain Markdown.", - "in": "BODY", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -11593,49 +16304,59 @@ "deprecated": null }, { - "name": "output.text", - "description": "Can contain Markdown.", - "in": "BODY", + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "output.annotations", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details.", - "in": "BODY", - "type": "object[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_count\":2,\"codespaces\":[{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"billable_owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"recent_folders\":[]},{\"id\":2,\"name\":\"monalisa-octocat-hello-world-3f89ada1j3\",\"environment_id\":\"526ce4d7-46da-494f-a4f9-cfd25b818719\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"billable_owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-3f89ada1j3.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop\",\"recent_folders\":[]}]}" + } + ] }, { - "name": "output.annotations[].path", - "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null + "code": 401, + "description": "Requires authentication", + "examples": null }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 500, "description": "Internal Error", "examples": null } + ], + "renamed": null + }, + { + "name": "List repository secrets", + "scope": "codespaces", + "id": "listRepoSecrets", + "method": "GET", + "url": "/repos/{owner}/{repo}/codespaces/secrets", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#list-repository-secrets", + "previews": [], + "headers": [], + "parameters": [ { - "name": "output.annotations[].start_line", - "description": "The start line of the annotation.", - "in": "BODY", - "type": "integer", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -11645,10 +16366,10 @@ "deprecated": null }, { - "name": "output.annotations[].end_line", - "description": "The end line of the annotation.", - "in": "BODY", - "type": "integer", + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -11658,9 +16379,9 @@ "deprecated": null }, { - "name": "output.annotations[].start_column", - "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "in": "BODY", + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", "type": "integer", "required": false, "enum": null, @@ -11671,9 +16392,9 @@ "deprecated": null }, { - "name": "output.annotations[].end_column", - "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "in": "BODY", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", "type": "integer", "required": false, "enum": null, @@ -11682,24 +16403,39 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "output.annotations[].annotation_level", - "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["notice", "warning", "failure"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_count\":2,\"secrets\":[{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"GIST_ID\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}" + } + ] + } + ], + "renamed": null + }, + { + "name": "List selected repositories for a user secret", + "scope": "codespaces", + "id": "listRepositoriesForSecretForAuthenticatedUser", + "method": "GET", + "url": "/user/codespaces/secrets/{secret_name}/repositories", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "List the repositories that have been granted the ability to use a user's codespace secret.\n\nYou must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret", + "previews": [], + "headers": [], + "parameters": [ { - "name": "output.annotations[].message", - "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "in": "BODY", + "name": "secret_name", + "description": "The name of the secret.", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -11708,25 +16444,48 @@ "validation": null, "alias": null, "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"organization\":null,\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"delete_branch_on_merge\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]}" + } + ] }, { - "name": "output.annotations[].title", - "description": "The title that represents the annotation. The maximum size is 255 characters.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null + "code": 401, + "description": "Requires authentication", + "examples": null }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 500, "description": "Internal Error", "examples": null } + ], + "renamed": null + }, + { + "name": "List secrets for the authenticated user", + "scope": "codespaces", + "id": "listSecretsForAuthenticatedUser", + "method": "GET", + "url": "/user/codespaces/secrets", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists all secrets available for a user's Codespaces without revealing their\nencrypted values.\n\nYou must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#list-secrets-for-the-authenticated-user", + "previews": [], + "headers": [], + "parameters": [ { - "name": "output.annotations[].raw_details", - "description": "Details about this annotation. The maximum size is 64 KB.", - "in": "BODY", - "type": "string", + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -11736,10 +16495,10 @@ "deprecated": null }, { - "name": "output.images", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details.", - "in": "BODY", - "type": "object[]", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -11747,11 +16506,39 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "output.images[].alt", - "description": "The alternative text for the image.", - "in": "BODY", + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_count\":2,\"secrets\":[{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"GIST_ID\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Remove a selected repository from a user secret", + "scope": "codespaces", + "id": "removeRepositoryForSecretForAuthenticatedUser", + "method": "DELETE", + "url": "/user/codespaces/secrets/{secret_name}/repositories/{repository_id}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Removes a repository from the selected repositories for a user's codespace secret.\nYou must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.\nGitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -11762,10 +16549,10 @@ "deprecated": null }, { - "name": "output.images[].image_url", - "description": "The full URL of the image.", - "in": "BODY", - "type": "string", + "name": "repository_id", + "description": "", + "in": "PATH", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -11773,26 +16560,45 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "output.images[].caption", - "description": "A short image description.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null + "code": 204, + "description": "No Content when repository was removed from the selected list", + "examples": null }, { - "name": "actions", - "description": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions).\"", - "in": "BODY", - "type": "object[]", - "required": false, + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 500, "description": "Internal Error", "examples": null } + ], + "renamed": null + }, + { + "name": "List available machine types for a repository", + "scope": "codespaces", + "id": "repoMachinesForAuthenticatedUser", + "method": "GET", + "url": "/repos/{owner}/{repo}/codespaces/machines", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "List the machine types available for a given repository based on its configuration.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces_metadata` repository permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#list-available-machine-types-for-a-repository", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -11801,9 +16607,9 @@ "deprecated": null }, { - "name": "actions[].label", - "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "in": "BODY", + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -11814,11 +16620,11 @@ "deprecated": null }, { - "name": "actions[].description", - "description": "A short explanation of what this action would do. The maximum size is 40 characters.", - "in": "BODY", + "name": "location", + "description": "The location to check for available machines. Assigned by IP if not provided.", + "in": "QUERY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -11827,11 +16633,11 @@ "deprecated": null }, { - "name": "actions[].identifier", - "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "in": "BODY", + "name": "client_ip", + "description": "IP for location auto-detection when proxying a request", + "in": "QUERY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -11846,30 +16652,39 @@ "description": "Response", "examples": [ { - "data": "{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"https://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}" + "data": "{\"total_count\":2,\"machines\":[{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},{\"name\":\"premiumLinux\",\"display_name\":\"8 cores, 16 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":17179869184,\"cpus\":8}]}" } ] - } + }, + { "code": 304, "description": "Not modified", "examples": null }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 500, "description": "Internal Error", "examples": null } ], "renamed": null }, { - "name": "Delete a code scanning analysis from a repository", - "scope": "codeScanning", - "id": "deleteAnalysis", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}{?confirm_delete}", + "name": "Set selected repositories for a user secret", + "scope": "codespaces", + "id": "setRepositoriesForSecretForAuthenticatedUser", + "method": "PUT", + "url": "/user/codespaces/secrets/{secret_name}/repositories", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` and `repo:security_events` scopes.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `analysis_key`\n* `environment`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set\n(see the example default response below).\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin the set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find the deletable analysis for one of the sets,\nstep through deleting the analyses in that set,\nand then repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n **Inner loop**:\n * Delete the identified analysis.\n * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.", - "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#delete-a-code-scanning-analysis-from-a-repository", + "description": "Select the repositories that will use a user's codespace secret.\n\nYou must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#set-selected-repositories-for-a-user-secret", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "", + "name": "secret_name", + "description": "The name of the secret.", "in": "PATH", "type": "string", "required": true, @@ -11881,10 +16696,10 @@ "deprecated": null }, { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", + "name": "selected_repository_ids", + "description": "An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret), [Add a selected repository to a user secret](https://docs.github.com/rest/reference/codespaces#add-a-selected-repository-to-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret) endpoints.", + "in": "BODY", + "type": "integer[]", "required": true, "enum": null, "allowNull": false, @@ -11892,12 +16707,44 @@ "validation": null, "alias": null, "deprecated": null + } + ], + "responses": [ + { + "code": 204, + "description": "No Content when repositories were added to the selected list", + "examples": null }, { - "name": "analysis_id", - "description": "The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation.", + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 500, "description": "Internal Error", "examples": null } + ], + "renamed": null + }, + { + "name": "Start a codespace for the authenticated user", + "scope": "codespaces", + "id": "startForAuthenticatedUser", + "method": "POST", + "url": "/user/codespaces/{codespace_name}/start", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Starts a user's codespace.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#start-a-codespace-for-the-authenticated-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "codespace_name", + "description": "The name of the codespace.", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -11905,13 +16752,54 @@ "validation": null, "alias": null, "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"billable_owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[]}" + } + ] }, + { "code": 304, "description": "Not modified", "examples": null }, + { "code": 400, "description": "Bad Request", "examples": null }, + { "code": 400, "description": "Bad Request", "examples": null }, { - "name": "confirm_delete", - "description": "Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.`", - "in": "QUERY", + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 402, "description": "Payment required", "examples": null }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 409, "description": "Conflict", "examples": null }, + { "code": 500, "description": "Internal Error", "examples": null } + ], + "renamed": null + }, + { + "name": "Stop a codespace for the authenticated user", + "scope": "codespaces", + "id": "stopForAuthenticatedUser", + "method": "POST", + "url": "/user/codespaces/{codespace_name}/stop", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Stops a user's codespace.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#stop-a-codespace-for-the-authenticated-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "codespace_name", + "description": "The name of the codespace.", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -11926,39 +16814,38 @@ "description": "Response", "examples": [ { - "data": "{\"next_analysis_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41\",\"confirm_delete_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete\"}" + "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"billable_owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[]}" } ] }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, { - "code": 403, - "description": "Response if the repository is archived or if github advanced security is not enabled for this repository", + "code": 401, + "description": "Requires authentication", "examples": null }, + { "code": 403, "description": "Forbidden", "examples": null }, { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } + { "code": 500, "description": "Internal Error", "examples": null } ], "renamed": null }, { - "name": "Get a code scanning alert", - "scope": "codeScanning", - "id": "getAlert", - "method": "GET", - "url": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", + "name": "Update a codespace for the authenticated user", + "scope": "codespaces", + "id": "updateForAuthenticatedUser", + "method": "PATCH", + "url": "/user/codespaces/{codespace_name}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.\n\n**Deprecation notice**:\nThe instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by `instances_url`.", - "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#get-a-code-scanning-alert", + "description": "Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint.\n\nIf you specify a new machine type it will be applied the next time your codespace is started.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#update-a-codespace-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "", + "name": "codespace_name", + "description": "The name of the codespace.", "in": "PATH", "type": "string", "required": true, @@ -11970,11 +16857,11 @@ "deprecated": null }, { - "name": "repo", - "description": "", - "in": "PATH", + "name": "machine", + "description": "A valid machine to transition this codespace to.", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -11983,11 +16870,11 @@ "deprecated": null }, { - "name": "alert_number", - "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", - "in": "PATH", - "type": "integer", - "required": true, + "name": "display_name", + "description": "Display name for this codespace", + "in": "BODY", + "type": "string", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -11996,17 +16883,17 @@ "deprecated": null }, { - "name": "alert_id", - "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", - "in": "PATH", - "type": "integer", + "name": "recent_folders", + "description": "Recently opened folders inside the codespace. It is currently used by the clients to determine the folder path to load the codespace in.", + "in": "BODY", + "type": "string[]", "required": false, "enum": null, "allowNull": false, "mapToData": null, "validation": null, - "alias": "alert_number", - "deprecated": true + "alias": null, + "deprecated": null } ], "responses": [ @@ -12015,37 +16902,37 @@ "description": "Response", "examples": [ { - "data": "{\"number\":42,\"created_at\":\"2020-06-19T11:21:34Z\",\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\"html_url\":\"https://github.com/octocat/hello-world/code-scanning/42\",\"state\":\"dismissed\",\"dismissed_by\":{\"login\":\"octocat\",\"id\":54933897,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"dismissed_at\":\"2020-02-14T12:29:18Z\",\"dismissed_reason\":\"false positive\",\"rule\":{\"id\":\"js/zipslip\",\"severity\":\"error\",\"security_severity_level\":\"high\",\"description\":\"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\"name\":\"js/zipslip\",\"full_description\":\"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\"tags\":[\"security\",\"external/cwe/cwe-022\"],\"help\":\"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"},\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"most_recent_instance\":{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"{}\",\"state\":\"dismissed\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"spec-main/api-session-spec.ts\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"test\"]},\"instances_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"}" + "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"billable_owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[]}" } ] }, { - "code": 403, - "description": "Response if GitHub Advanced Security is not enabled for this repository", + "code": 401, + "description": "Requires authentication", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } ], "renamed": null }, { - "name": "Get a code scanning analysis for a repository", - "scope": "codeScanning", - "id": "getAnalysis", - "method": "GET", - "url": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}", + "name": "Add selected repository to an organization secret", + "scope": "dependabot", + "id": "addSelectedRepoToOrgSecret", + "method": "PUT", + "url": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).", - "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository", + "description": "Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/dependabot#add-selected-repository-to-an-organization-secret", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -12057,8 +16944,8 @@ "deprecated": null }, { - "name": "repo", - "description": "", + "name": "secret_name", + "description": "The name of the secret.", "in": "PATH", "type": "string", "required": true, @@ -12070,8 +16957,8 @@ "deprecated": null }, { - "name": "analysis_id", - "description": "The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation.", + "name": "repository_id", + "description": "", "in": "PATH", "type": "integer", "required": true, @@ -12084,43 +16971,36 @@ } ], "responses": [ - { "code": 200, "description": "Response", "examples": null }, { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"ref\":\"refs/heads/main\",\"commit_sha\":\"c18c69115654ff0166991962832dc2bd7756e655\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:analyze\",\"environment\":\"{\\\"language\\\":\\\"javascript\\\"}\",\"error\":\"\",\"category\":\".github/workflows/codeql-analysis.yml:analyze/language:javascript\",\"created_at\":\"2021-01-13T11:55:49Z\",\"results_count\":3,\"rules_count\":67,\"id\":3602840,\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\"sarif_id\":\"47177e22-5596-11eb-80a1-c1e54ef945c6\",\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"deletable\":true,\"warning\":\"\"}" - } - ] + "code": 204, + "description": "No Content when repository was added to the selected list", + "examples": null }, { - "code": 403, - "description": "Response if GitHub Advanced Security is not enabled for this repository", + "code": 409, + "description": "Conflict when visibility type is not set to selected", "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } + } ], "renamed": null }, { - "name": "Get information about a SARIF upload", - "scope": "codeScanning", - "id": "getSarif", - "method": "GET", - "url": "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}", + "name": "Create or update an organization secret", + "scope": "dependabot", + "id": "createOrUpdateOrgSecret", + "method": "PUT", + "url": "/orgs/{org}/dependabot/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"[Get a code scanning analysis for a repository](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository).\" You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#list-recent-code-scanning-analyses-for-a-repository", + "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization\npermission to use this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", + "documentationUrl": "https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -12132,8 +17012,8 @@ "deprecated": null }, { - "name": "repo", - "description": "", + "name": "secret_name", + "description": "The name of the secret.", "in": "PATH", "type": "string", "required": true, @@ -12145,11 +17025,50 @@ "deprecated": null }, { - "name": "sarif_id", - "description": "The SARIF ID obtained after uploading.", - "in": "PATH", + "name": "encrypted_value", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/dependabot#get-an-organization-public-key) endpoint.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", + "alias": null, + "deprecated": null + }, + { + "name": "key_id", + "description": "ID of the key you used to encrypt the secret.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "visibility", + "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", + "in": "BODY", "type": "string", "required": true, + "enum": ["all", "private", "selected"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "selected_repository_ids", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints.", + "in": "BODY", + "type": "string[]", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -12160,45 +17079,35 @@ ], "responses": [ { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"processing_status\":\"complete\",\"analyses_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6\"}" - } - ] - }, - { - "code": 403, - "description": "Response if GitHub Advanced Security is not enabled for this repository", + "code": 201, + "description": "Response when creating a secret", "examples": null }, { - "code": 404, - "description": "Not Found if the sarif id does not match any upload", + "code": 204, + "description": "Response when updating a secret", "examples": null - }, - { "code": 503, "description": "Service unavailable", "examples": null } + } ], "renamed": null }, { - "name": "List instances of a code scanning alert", - "scope": "codeScanning", - "id": "listAlertInstances", - "method": "GET", - "url": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", + "name": "Create or update a repository secret", + "scope": "dependabot", + "id": "createOrUpdateRepoSecret", + "method": "PUT", + "url": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all instances of the specified code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert", + "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository\npermission to use this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", + "documentationUrl": "https://docs.github.com/rest/reference/dependabot#create-or-update-a-repository-secret", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -12211,7 +17120,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -12223,10 +17132,10 @@ "deprecated": null }, { - "name": "alert_number", - "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", + "name": "secret_name", + "description": "The name of the secret.", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -12236,35 +17145,22 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", + "name": "encrypted_value", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/dependabot#get-a-repository-public-key) endpoint.", + "in": "BODY", + "type": "string", "required": false, "enum": null, "allowNull": false, "mapToData": null, - "validation": null, + "validation": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "alias": null, "deprecated": null }, { - "name": "ref", - "description": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", - "in": "QUERY", + "name": "key_id", + "description": "ID of the key you used to encrypt the secret.", + "in": "BODY", "type": "string", "required": false, "enum": null, @@ -12277,41 +17173,35 @@ ], "responses": [ { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"\",\"state\":\"open\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"lib/ab12-gen.js\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"library\"]},{\"ref\":\"refs/pull/3740/merge\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"\",\"category\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"state\":\"fixed\",\"commit_sha\":\"b09da05606e27f463a2b49287684b4ae777092f2\",\"message\":{\"text\":\"This suffix check is missing a length comparison to correctly handle lastIndexOf returning -1.\"},\"location\":{\"path\":\"app/script.js\",\"start_line\":2,\"end_line\":2,\"start_column\":10,\"end_column\":50},\"classifications\":[\"source\"]}]" - } - ] + "code": 201, + "description": "Response when creating a secret", + "examples": null }, { - "code": 403, - "description": "Response if GitHub Advanced Security is not enabled for this repository", + "code": 204, + "description": "Response when updating a secret", "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } + } ], "renamed": null }, { - "name": "List code scanning alerts for a repository", - "scope": "codeScanning", - "id": "listAlertsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/code-scanning/alerts", + "name": "Delete an organization secret", + "scope": "dependabot", + "id": "deleteOrgSecret", + "method": "DELETE", + "url": "/orgs/{org}/dependabot/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all open code scanning alerts for the default branch (usually `main`\nor `master`). You must use an access token with the `security_events` scope to use\nthis endpoint. GitHub Apps must have the `security_events` read permission to use\nthis endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the default branch or for the specified Git reference\n(if you used `ref` in the request).", - "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository", + "description": "Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/dependabot#delete-an-organization-secret", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -12323,8 +17213,8 @@ "deprecated": null }, { - "name": "repo", - "description": "", + "name": "secret_name", + "description": "The name of the secret.", "in": "PATH", "type": "string", "required": true, @@ -12334,13 +17224,31 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [{ "code": 204, "description": "Response", "examples": null }], + "renamed": null + }, + { + "name": "Delete a repository secret", + "scope": "dependabot", + "id": "deleteRepoSecret", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/dependabot#delete-a-repository-secret", + "previews": [], + "headers": [], + "parameters": [ { - "name": "tool_name", - "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.", - "in": "QUERY", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -12349,11 +17257,11 @@ "deprecated": null }, { - "name": "tool_guid", - "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.", - "in": "QUERY", + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -12362,37 +17270,83 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "secret_name", + "description": "The name of the secret.", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [{ "code": 204, "description": "Response", "examples": null }], + "renamed": null + }, + { + "name": "Get an organization public key", + "scope": "dependabot", + "id": "getOrgPublicKey", + "method": "GET", + "url": "/orgs/{org}/dependabot/secrets/public-key", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/dependabot#get-an-organization-public-key", + "previews": [], + "headers": [], + "parameters": [ { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "ref", - "description": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", - "in": "QUERY", + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"key_id\":\"012345678912345678\",\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\"}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Get an organization secret", + "scope": "dependabot", + "id": "getOrgSecret", + "method": "GET", + "url": "/orgs/{org}/dependabot/secrets/{secret_name}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/dependabot#get-an-organization-secret", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -12401,12 +17355,12 @@ "deprecated": null }, { - "name": "state", - "description": "Set to `open`, `fixed`, or `dismissed` to list code scanning alerts in a specific state.", - "in": "QUERY", + "name": "secret_name", + "description": "The name of the secret.", + "in": "PATH", "type": "string", - "required": false, - "enum": ["open", "closed", "dismissed", "fixed"], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -12420,37 +17374,84 @@ "description": "Response", "examples": [ { - "data": "[{\"number\":4,\"created_at\":\"2020-02-13T12:29:18Z\",\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4\",\"html_url\":\"https://github.com/octocat/hello-world/code-scanning/4\",\"state\":\"open\",\"dismissed_by\":null,\"dismissed_at\":null,\"dismissed_reason\":null,\"rule\":{\"id\":\"js/zipslip\",\"severity\":\"error\",\"description\":\"Arbitrary file write during zip extraction\",\"name\":\"js/zipslip\"},\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"most_recent_instance\":{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"{}\",\"state\":\"open\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"spec-main/api-session-spec.ts\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"test\"]},\"instances_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances\"},{\"number\":3,\"created_at\":\"2020-02-13T12:29:18Z\",\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3\",\"html_url\":\"https://github.com/octocat/hello-world/code-scanning/3\",\"state\":\"dismissed\",\"dismissed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"dismissed_at\":\"2020-02-14T12:29:18Z\",\"dismissed_reason\":\"false positive\",\"rule\":{\"id\":\"js/zipslip\",\"severity\":\"error\",\"description\":\"Arbitrary file write during zip extraction\",\"name\":\"js/zipslip\"},\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"most_recent_instance\":{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"{}\",\"state\":\"open\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"lib/ab12-gen.js\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[]},\"instances_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances\"}]" + "data": "{\"name\":\"NPM_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"selected\",\"selected_repositories_url\":\"https://api.github.com/orgs/octo-org/dependabot/secrets/NPM_TOKEN/repositories\"}" } ] - }, + } + ], + "renamed": null + }, + { + "name": "Get a repository public key", + "scope": "dependabot", + "id": "getRepoPublicKey", + "method": "GET", + "url": "/repos/{owner}/{repo}/dependabot/secrets/public-key", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/dependabot#get-a-repository-public-key", + "previews": [], + "headers": [], + "parameters": [ { - "code": 403, - "description": "Response if GitHub Advanced Security is not enabled for this repository", - "examples": null + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"key_id\":\"012345678912345678\",\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\"}" + } + ] + } ], "renamed": null }, { - "name": "List instances of a code scanning alert", - "scope": "codeScanning", - "id": "listAlertsInstances", + "name": "Get a repository secret", + "scope": "dependabot", + "id": "getRepoSecret", "method": "GET", - "url": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", + "url": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all instances of the specified code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert", + "description": "Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/dependabot#get-a-repository-secret", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -12463,7 +17464,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -12475,10 +17476,10 @@ "deprecated": null }, { - "name": "alert_number", - "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", + "name": "secret_name", + "description": "The name of the secret.", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -12486,13 +17487,41 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"name\":\"MY_ARTIFACTORY_PASSWORD\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"}" + } + ] + } + ], + "renamed": null + }, + { + "name": "List organization secrets", + "scope": "dependabot", + "id": "listOrgSecrets", + "method": "GET", + "url": "/orgs/{org}/dependabot/secrets", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/dependabot#list-organization-secrets", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -12502,7 +17531,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -12514,10 +17543,10 @@ "deprecated": null }, { - "name": "ref", - "description": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", + "name": "page", + "description": "Page number of the results to fetch.", "in": "QUERY", - "type": "string", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -12533,42 +17562,30 @@ "description": "Response", "examples": [ { - "data": "[{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"\",\"state\":\"open\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"lib/ab12-gen.js\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"library\"]},{\"ref\":\"refs/pull/3740/merge\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"\",\"category\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"state\":\"fixed\",\"commit_sha\":\"b09da05606e27f463a2b49287684b4ae777092f2\",\"message\":{\"text\":\"This suffix check is missing a length comparison to correctly handle lastIndexOf returning -1.\"},\"location\":{\"path\":\"app/script.js\",\"start_line\":2,\"end_line\":2,\"start_column\":10,\"end_column\":50},\"classifications\":[\"source\"]}]" + "data": "{\"total_count\":3,\"secrets\":[{\"name\":\"MY_ARTIFACTORY_PASSWORD\",\"created_at\":\"2021-08-10T14:59:22Z\",\"updated_at\":\"2021-12-10T14:59:22Z\",\"visibility\":\"private\"},{\"name\":\"NPM_TOKEN\",\"created_at\":\"2021-08-10T14:59:22Z\",\"updated_at\":\"2021-12-10T14:59:22Z\",\"visibility\":\"all\"},{\"name\":\"GH_TOKEN\",\"created_at\":\"2021-08-10T14:59:22Z\",\"updated_at\":\"2021-12-10T14:59:22Z\",\"visibility\":\"selected\",\"selected_repositories_url\":\"https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories\"}]}" } ] - }, - { - "code": 403, - "description": "Response if GitHub Advanced Security is not enabled for this repository", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } + } ], - "renamed": { - "before": { "scope": "codeScanning", "id": "listAlertsInstances" }, - "after": { "scope": "codeScanning", "id": "listAlertInstances" }, - "date": "2021-04-30", - "note": null - } + "renamed": null }, { - "name": "List code scanning analyses for a repository", - "scope": "codeScanning", - "id": "listRecentAnalyses", + "name": "List repository secrets", + "scope": "dependabot", + "id": "listRepoSecrets", "method": "GET", - "url": "/repos/{owner}/{repo}/code-scanning/analyses", + "url": "/repos/{owner}/{repo}/dependabot/secrets", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.", - "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#list-code-scanning-analyses-for-a-repository", + "description": "Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/dependabot#list-repository-secrets", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -12581,7 +17598,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -12593,10 +17610,10 @@ "deprecated": null }, { - "name": "tool_name", - "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.", + "name": "per_page", + "description": "The number of results per page (max 100).", "in": "QUERY", - "type": "string", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -12606,10 +17623,10 @@ "deprecated": null }, { - "name": "tool_guid", - "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.", + "name": "page", + "description": "Page number of the results to fetch.", "in": "QUERY", - "type": "string", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -12617,13 +17634,41 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_count\":2,\"secrets\":[{\"name\":\"AZURE_DEVOPS_PAT\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"MY_ARTIFACTORY_PASSWORD\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}" + } + ] + } + ], + "renamed": null + }, + { + "name": "List selected repositories for an organization secret", + "scope": "dependabot", + "id": "listSelectedReposForOrgSecret", + "method": "GET", + "url": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/dependabot#list-selected-repositories-for-an-organization-secret", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -12632,11 +17677,11 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "secret_name", + "description": "The name of the secret.", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -12645,10 +17690,10 @@ "deprecated": null }, { - "name": "ref", - "description": "The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", + "name": "page", + "description": "Page number of the results to fetch.", "in": "QUERY", - "type": "string", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -12658,10 +17703,10 @@ "deprecated": null }, { - "name": "sarif_id", - "description": "Filter analyses belonging to the same SARIF upload.", + "name": "per_page", + "description": "The number of results per page (max 100).", "in": "QUERY", - "type": "string", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -12677,37 +17722,30 @@ "description": "Response", "examples": [ { - "data": "[{\"ref\":\"refs/heads/main\",\"commit_sha\":\"d99612c3e1f2970085cfbaeadf8f010ef69bad83\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:analyze\",\"environment\":\"{\\\"language\\\":\\\"python\\\"}\",\"error\":\"\",\"category\":\".github/workflows/codeql-analysis.yml:analyze/language:python\",\"created_at\":\"2020-08-27T15:05:21Z\",\"results_count\":17,\"rules_count\":49,\"id\":201,\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\"sarif_id\":\"6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53\",\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"deletable\":true,\"warning\":\"\"},{\"ref\":\"refs/heads/my-branch\",\"commit_sha\":\"c8cff6510d4d084fb1b4aa13b64b97ca12b07321\",\"analysis_key\":\".github/workflows/shiftleft.yml:build\",\"environment\":\"{}\",\"error\":\"\",\"category\":\".github/workflows/shiftleft.yml:build/\",\"created_at\":\"2020-08-31T22:46:44Z\",\"results_count\":17,\"rules_count\":32,\"id\":200,\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200\",\"sarif_id\":\"8981cd8e-b078-4ac3-a3be-1dad7dbd0b582\",\"tool\":{\"name\":\"Python Security Analysis\",\"guid\":null,\"version\":\"1.2.0\"},\"deletable\":true,\"warning\":\"\"}]" + "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"}]}" } ] - }, - { - "code": 403, - "description": "Response if GitHub Advanced Security is not enabled for this repository", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } + } ], "renamed": null }, { - "name": "Update a code scanning alert", - "scope": "codeScanning", - "id": "updateAlert", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", + "name": "Remove selected repository from an organization secret", + "scope": "dependabot", + "id": "removeSelectedRepoFromOrgSecret", + "method": "DELETE", + "url": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#update-a-code-scanning-alert", + "description": "Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -12719,8 +17757,8 @@ "deprecated": null }, { - "name": "repo", - "description": "", + "name": "secret_name", + "description": "The name of the secret.", "in": "PATH", "type": "string", "required": true, @@ -12732,8 +17770,8 @@ "deprecated": null }, { - "name": "alert_number", - "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", + "name": "repository_id", + "description": "", "in": "PATH", "type": "integer", "required": true, @@ -12743,71 +17781,39 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "state", - "description": "Sets the state of the code scanning alert. Can be one of `open` or `dismissed`. You must provide `dismissed_reason` when you set the state to `dismissed`.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["open", "dismissed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "dismissed_reason", - "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": [null, "false positive", "won't fix", "used in tests"], - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null } ], "responses": [ { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"number\":42,\"created_at\":\"2020-08-25T21:28:36Z\",\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\"html_url\":\"https://github.com/octocat/hello-world/code-scanning/42\",\"state\":\"dismissed\",\"dismissed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"dismissed_at\":\"2020-09-02T22:34:56Z\",\"dismissed_reason\":\"false positive\",\"rule\":{\"id\":\"js/zipslip\",\"severity\":\"error\",\"security_severity_level\":\"high\",\"description\":\"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\"name\":\"js/zipslip\",\"full_description\":\"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\"tags\":[\"security\",\"external/cwe/cwe-022\"],\"help\":\"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"},\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"most_recent_instance\":{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"{}\",\"state\":\"dismissed\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"spec-main/api-session-spec.ts\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"test\"]},\"instances_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"}" - } - ] + "code": 204, + "description": "Response when repository was removed from the selected list", + "examples": null }, { - "code": 403, - "description": "Response if the repository is archived or if github advanced security is not enabled for this repository", + "code": 409, + "description": "Conflict when visibility type not set to selected", "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } + } ], "renamed": null }, { - "name": "Upload an analysis as SARIF data", - "scope": "codeScanning", - "id": "uploadSarif", - "method": "POST", - "url": "/repos/{owner}/{repo}/code-scanning/sarifs", + "name": "Set selected repositories for an organization secret", + "scope": "dependabot", + "id": "setSelectedReposForOrgSecret", + "method": "PUT", + "url": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum of 5000 results per analysis run. Any results over this limit are ignored and any SARIF uploads with more than 25,000 results are rejected. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", - "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#upload-a-sarif-file", + "description": "Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -12819,8 +17825,8 @@ "deprecated": null }, { - "name": "repo", - "description": "", + "name": "secret_name", + "description": "The name of the secret.", "in": "PATH", "type": "string", "required": true, @@ -12832,23 +17838,10 @@ "deprecated": null }, { - "name": "commit_sha", - "description": "The SHA of the commit to which the analysis you are uploading relates.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": "^[0-9a-fA-F]+$", - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`.", + "name": "selected_repository_ids", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints.", "in": "BODY", - "type": "string", + "type": "integer[]", "required": true, "enum": null, "allowNull": false, @@ -12856,11 +17849,29 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [{ "code": 204, "description": "Response", "examples": null }], + "renamed": null + }, + { + "name": "Get a diff of the dependencies between commits", + "scope": "dependencyGraph", + "id": "diffRange", + "method": "GET", + "url": "/repos/{owner}/{repo}/dependency-graph/compare/{basehead}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits.", + "documentationUrl": "https://docs.github.com/rest/reference/dependency-graph#get-a-diff-of-the-dependencies-between-commits", + "previews": [], + "headers": [], + "parameters": [ { - "name": "sarif", - "description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/code-security/secure-coding/sarif-support-for-code-scanning).\"", - "in": "BODY", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -12871,11 +17882,11 @@ "deprecated": null }, { - "name": "checkout_uri", - "description": "The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.", - "in": "BODY", + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -12884,11 +17895,11 @@ "deprecated": null }, { - "name": "started_at", - "description": "The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", + "name": "basehead", + "description": "The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their corresponding HEAD commits, and an appropriate merge base will be determined. This parameter expects the format `{base}...{head}`.", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -12897,9 +17908,9 @@ "deprecated": null }, { - "name": "tool_name", - "description": "The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.", - "in": "BODY", + "name": "name", + "description": "The full path, relative to the repository root, of the dependency manifest file.", + "in": "QUERY", "type": "string", "required": false, "enum": null, @@ -12912,45 +17923,30 @@ ], "responses": [ { - "code": 202, + "code": 200, "description": "Response", "examples": [ { - "data": "{\"id\":\"47177e22-5596-11eb-80a1-c1e54ef945c6\",\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6\"}" + "data": "[{\"change_type\":\"removed\",\"manifest\":\"package.json\",\"ecosystem\":\"npm\",\"name\":\"helmet\",\"version\":\"4.6.0\",\"package_url\":\"pkg:npm/helmet@4.6.0\",\"license\":\"MIT\",\"source_repository_url\":\"https://github.com/helmetjs/helmet\",\"vulnerabilities\":[]},{\"change_type\":\"added\",\"manifest\":\"package.json\",\"ecosystem\":\"npm\",\"name\":\"helmet\",\"version\":\"5.0.0\",\"package_url\":\"pkg:npm/helmet@5.0.0\",\"license\":\"MIT\",\"source_repository_url\":\"https://github.com/helmetjs/helmet\",\"vulnerabilities\":[]},{\"change_type\":\"added\",\"manifest\":\"Gemfile\",\"ecosystem\":\"rubygems\",\"name\":\"ruby-openid\",\"version\":\"2.7.0\",\"package_url\":\"pkg:gem/ruby-openid@2.7.0\",\"license\":null,\"source_repository_url\":\"https://github.com/openid/ruby-openid\",\"vulnerabilities\":[{\"severity\":\"critical\",\"advisory_ghsa_id\":\"GHSA-fqfj-cmh6-hj49\",\"advisory_summary\":\"Ruby OpenID\",\"advisory_url\":\"https://github.com/advisories/GHSA-fqfj-cmh6-hj49\"}]}]" } ] }, - { - "code": 400, - "description": "Bad Request if the sarif field is invalid", - "examples": null - }, - { - "code": 403, - "description": "Response if the repository is archived or if github advanced security is not enabled for this repository", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 413, - "description": "Payload Too Large if the sarif field is too large", - "examples": null - }, - { "code": 503, "description": "Service unavailable", "examples": null } + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } ], "renamed": null }, { - "name": "Get all codes of conduct", - "scope": "codesOfConduct", - "id": "getAllCodesOfConduct", + "name": "Get emojis", + "scope": "emojis", + "id": "get", "method": "GET", - "url": "/codes_of_conduct", + "url": "/emojis", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/codes-of-conduct#get-all-codes-of-conduct", + "description": "Lists all the emojis available to use on GitHub.", + "documentationUrl": "https://docs.github.com/rest/reference/emojis#get-emojis", "previews": [], "headers": [], "parameters": [], @@ -12960,7 +17956,7 @@ "description": "Response", "examples": [ { - "data": "[{\"key\":\"citizen_code_of_conduct\",\"name\":\"Citizen Code of Conduct\",\"url\":\"https://api.github.com/codes_of_conduct/citizen_code_of_conduct\",\"html_url\":\"http://citizencodeofconduct.org/\"},{\"key\":\"contributor_covenant\",\"name\":\"Contributor Covenant\",\"url\":\"https://api.github.com/codes_of_conduct/contributor_covenant\",\"html_url\":\"https://www.contributor-covenant.org/version/2/0/code_of_conduct/\"}]" + "data": "{\"100\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4af.png?v8\",\"1234\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f522.png?v8\",\"+1\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png?v8\",\"-1\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png?v8\",\"1st_place_medal\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f947.png?v8\",\"2nd_place_medal\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f948.png?v8\",\"3rd_place_medal\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f949.png?v8\",\"8ball\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3b1.png?v8\",\"a\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f170.png?v8\",\"ab\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f18e.png?v8\",\"abacus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ee.png?v8\",\"abc\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f524.png?v8\",\"abcd\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f521.png?v8\",\"accept\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f251.png?v8\",\"accordion\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa97.png?v8\",\"adhesive_bandage\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa79.png?v8\",\"adult\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1.png?v8\",\"aerial_tramway\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a1.png?v8\",\"afghanistan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1eb.png?v8\",\"airplane\":\"https://github.githubassets.com/images/icons/emoji/unicode/2708.png?v8\",\"aland_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fd.png?v8\",\"alarm_clock\":\"https://github.githubassets.com/images/icons/emoji/unicode/23f0.png?v8\",\"albania\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f1.png?v8\",\"alembic\":\"https://github.githubassets.com/images/icons/emoji/unicode/2697.png?v8\",\"algeria\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ff.png?v8\",\"alien\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f47d.png?v8\",\"ambulance\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f691.png?v8\",\"american_samoa\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f8.png?v8\",\"amphora\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3fa.png?v8\",\"anatomical_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fac0.png?v8\",\"anchor\":\"https://github.githubassets.com/images/icons/emoji/unicode/2693.png?v8\",\"andorra\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1e9.png?v8\",\"angel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f47c.png?v8\",\"anger\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a2.png?v8\",\"angola\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f4.png?v8\",\"angry\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f620.png?v8\",\"anguilla\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ee.png?v8\",\"anguished\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f627.png?v8\",\"ant\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f41c.png?v8\",\"antarctica\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f6.png?v8\",\"antigua_barbuda\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ec.png?v8\",\"apple\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f34e.png?v8\",\"aquarius\":\"https://github.githubassets.com/images/icons/emoji/unicode/2652.png?v8\",\"argentina\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f7.png?v8\",\"aries\":\"https://github.githubassets.com/images/icons/emoji/unicode/2648.png?v8\",\"armenia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f2.png?v8\",\"arrow_backward\":\"https://github.githubassets.com/images/icons/emoji/unicode/25c0.png?v8\",\"arrow_double_down\":\"https://github.githubassets.com/images/icons/emoji/unicode/23ec.png?v8\",\"arrow_double_up\":\"https://github.githubassets.com/images/icons/emoji/unicode/23eb.png?v8\",\"arrow_down\":\"https://github.githubassets.com/images/icons/emoji/unicode/2b07.png?v8\",\"arrow_down_small\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f53d.png?v8\",\"arrow_forward\":\"https://github.githubassets.com/images/icons/emoji/unicode/25b6.png?v8\",\"arrow_heading_down\":\"https://github.githubassets.com/images/icons/emoji/unicode/2935.png?v8\",\"arrow_heading_up\":\"https://github.githubassets.com/images/icons/emoji/unicode/2934.png?v8\",\"arrow_left\":\"https://github.githubassets.com/images/icons/emoji/unicode/2b05.png?v8\",\"arrow_lower_left\":\"https://github.githubassets.com/images/icons/emoji/unicode/2199.png?v8\",\"arrow_lower_right\":\"https://github.githubassets.com/images/icons/emoji/unicode/2198.png?v8\",\"arrow_right\":\"https://github.githubassets.com/images/icons/emoji/unicode/27a1.png?v8\",\"arrow_right_hook\":\"https://github.githubassets.com/images/icons/emoji/unicode/21aa.png?v8\",\"arrow_up\":\"https://github.githubassets.com/images/icons/emoji/unicode/2b06.png?v8\",\"arrow_up_down\":\"https://github.githubassets.com/images/icons/emoji/unicode/2195.png?v8\",\"arrow_up_small\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f53c.png?v8\",\"arrow_upper_left\":\"https://github.githubassets.com/images/icons/emoji/unicode/2196.png?v8\",\"arrow_upper_right\":\"https://github.githubassets.com/images/icons/emoji/unicode/2197.png?v8\",\"arrows_clockwise\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f503.png?v8\",\"arrows_counterclockwise\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f504.png?v8\",\"art\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3a8.png?v8\",\"articulated_lorry\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f69b.png?v8\",\"artificial_satellite\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6f0.png?v8\",\"artist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3a8.png?v8\",\"aruba\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fc.png?v8\",\"ascension_island\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1e8.png?v8\",\"asterisk\":\"https://github.githubassets.com/images/icons/emoji/unicode/002a-20e3.png?v8\",\"astonished\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f632.png?v8\",\"astronaut\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f680.png?v8\",\"athletic_shoe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f45f.png?v8\",\"atm\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3e7.png?v8\",\"atom\":\"https://github.githubassets.com/images/icons/emoji/atom.png?v8\",\"atom_symbol\":\"https://github.githubassets.com/images/icons/emoji/unicode/269b.png?v8\",\"australia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fa.png?v8\",\"austria\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f9.png?v8\",\"auto_rickshaw\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6fa.png?v8\",\"avocado\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f951.png?v8\",\"axe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa93.png?v8\",\"azerbaijan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ff.png?v8\",\"b\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f171.png?v8\",\"baby\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f476.png?v8\",\"baby_bottle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f37c.png?v8\",\"baby_chick\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f424.png?v8\",\"baby_symbol\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6bc.png?v8\",\"back\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f519.png?v8\",\"bacon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f953.png?v8\",\"badger\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9a1.png?v8\",\"badminton\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f8.png?v8\",\"bagel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f96f.png?v8\",\"baggage_claim\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6c4.png?v8\",\"baguette_bread\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f956.png?v8\",\"bahamas\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f8.png?v8\",\"bahrain\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ed.png?v8\",\"balance_scale\":\"https://github.githubassets.com/images/icons/emoji/unicode/2696.png?v8\",\"bald_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b2.png?v8\",\"bald_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b2.png?v8\",\"ballet_shoes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa70.png?v8\",\"balloon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f388.png?v8\",\"ballot_box\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5f3.png?v8\",\"ballot_box_with_check\":\"https://github.githubassets.com/images/icons/emoji/unicode/2611.png?v8\",\"bamboo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f38d.png?v8\",\"banana\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f34c.png?v8\",\"bangbang\":\"https://github.githubassets.com/images/icons/emoji/unicode/203c.png?v8\",\"bangladesh\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e9.png?v8\",\"banjo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa95.png?v8\",\"bank\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3e6.png?v8\",\"bar_chart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ca.png?v8\",\"barbados\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e7.png?v8\",\"barber\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f488.png?v8\",\"baseball\":\"https://github.githubassets.com/images/icons/emoji/unicode/26be.png?v8\",\"basecamp\":\"https://github.githubassets.com/images/icons/emoji/basecamp.png?v8\",\"basecampy\":\"https://github.githubassets.com/images/icons/emoji/basecampy.png?v8\",\"basket\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9fa.png?v8\",\"basketball\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c0.png?v8\",\"basketball_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f9-2642.png?v8\",\"basketball_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f9-2640.png?v8\",\"bat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f987.png?v8\",\"bath\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6c0.png?v8\",\"bathtub\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6c1.png?v8\",\"battery\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f50b.png?v8\",\"beach_umbrella\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3d6.png?v8\",\"bear\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f43b.png?v8\",\"bearded_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d4.png?v8\",\"beaver\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ab.png?v8\",\"bed\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6cf.png?v8\",\"bee\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f41d.png?v8\",\"beer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f37a.png?v8\",\"beers\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f37b.png?v8\",\"beetle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fab2.png?v8\",\"beginner\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f530.png?v8\",\"belarus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fe.png?v8\",\"belgium\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ea.png?v8\",\"belize\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ff.png?v8\",\"bell\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f514.png?v8\",\"bell_pepper\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fad1.png?v8\",\"bellhop_bell\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6ce.png?v8\",\"benin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ef.png?v8\",\"bento\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f371.png?v8\",\"bermuda\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f2.png?v8\",\"beverage_box\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9c3.png?v8\",\"bhutan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f9.png?v8\",\"bicyclist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b4.png?v8\",\"bike\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b2.png?v8\",\"biking_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b4-2642.png?v8\",\"biking_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b4-2640.png?v8\",\"bikini\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f459.png?v8\",\"billed_cap\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9e2.png?v8\",\"biohazard\":\"https://github.githubassets.com/images/icons/emoji/unicode/2623.png?v8\",\"bird\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f426.png?v8\",\"birthday\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f382.png?v8\",\"bison\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ac.png?v8\",\"black_cat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f408-2b1b.png?v8\",\"black_circle\":\"https://github.githubassets.com/images/icons/emoji/unicode/26ab.png?v8\",\"black_flag\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f4.png?v8\",\"black_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5a4.png?v8\",\"black_joker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f0cf.png?v8\",\"black_large_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/2b1b.png?v8\",\"black_medium_small_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/25fe.png?v8\",\"black_medium_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/25fc.png?v8\",\"black_nib\":\"https://github.githubassets.com/images/icons/emoji/unicode/2712.png?v8\",\"black_small_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/25aa.png?v8\",\"black_square_button\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f532.png?v8\",\"blond_haired_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f471-2642.png?v8\",\"blond_haired_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f471.png?v8\",\"blond_haired_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f471-2640.png?v8\",\"blonde_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f471-2640.png?v8\",\"blossom\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f33c.png?v8\",\"blowfish\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f421.png?v8\",\"blue_book\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d8.png?v8\",\"blue_car\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f699.png?v8\",\"blue_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f499.png?v8\",\"blue_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7e6.png?v8\",\"blueberries\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fad0.png?v8\",\"blush\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f60a.png?v8\",\"boar\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f417.png?v8\",\"boat\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f5.png?v8\",\"bolivia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f4.png?v8\",\"bomb\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a3.png?v8\",\"bone\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9b4.png?v8\",\"book\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d6.png?v8\",\"bookmark\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f516.png?v8\",\"bookmark_tabs\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d1.png?v8\",\"books\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4da.png?v8\",\"boom\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a5.png?v8\",\"boomerang\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa83.png?v8\",\"boot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f462.png?v8\",\"bosnia_herzegovina\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e6.png?v8\",\"botswana\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fc.png?v8\",\"bouncing_ball_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f9-2642.png?v8\",\"bouncing_ball_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f9.png?v8\",\"bouncing_ball_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f9-2640.png?v8\",\"bouquet\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f490.png?v8\",\"bouvet_island\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fb.png?v8\",\"bow\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f647.png?v8\",\"bow_and_arrow\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f9.png?v8\",\"bowing_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f647-2642.png?v8\",\"bowing_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f647-2640.png?v8\",\"bowl_with_spoon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f963.png?v8\",\"bowling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3b3.png?v8\",\"bowtie\":\"https://github.githubassets.com/images/icons/emoji/bowtie.png?v8\",\"boxing_glove\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f94a.png?v8\",\"boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f466.png?v8\",\"brain\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9e0.png?v8\",\"brazil\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f7.png?v8\",\"bread\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f35e.png?v8\",\"breast_feeding\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f931.png?v8\",\"bricks\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9f1.png?v8\",\"bride_with_veil\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f470-2640.png?v8\",\"bridge_at_night\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f309.png?v8\",\"briefcase\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4bc.png?v8\",\"british_indian_ocean_territory\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f4.png?v8\",\"british_virgin_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ec.png?v8\",\"broccoli\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f966.png?v8\",\"broken_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f494.png?v8\",\"broom\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9f9.png?v8\",\"brown_circle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7e4.png?v8\",\"brown_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f90e.png?v8\",\"brown_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7eb.png?v8\",\"brunei\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f3.png?v8\",\"bubble_tea\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9cb.png?v8\",\"bucket\":\"https://github.githubassets.com/images/icons/emoji/unicode/1faa3.png?v8\",\"bug\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f41b.png?v8\",\"building_construction\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3d7.png?v8\",\"bulb\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a1.png?v8\",\"bulgaria\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ec.png?v8\",\"bullettrain_front\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f685.png?v8\",\"bullettrain_side\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f684.png?v8\",\"burkina_faso\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1eb.png?v8\",\"burrito\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f32f.png?v8\",\"burundi\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ee.png?v8\",\"bus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f68c.png?v8\",\"business_suit_levitating\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f574.png?v8\",\"busstop\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f68f.png?v8\",\"bust_in_silhouette\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f464.png?v8\",\"busts_in_silhouette\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f465.png?v8\",\"butter\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9c8.png?v8\",\"butterfly\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f98b.png?v8\",\"cactus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f335.png?v8\",\"cake\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f370.png?v8\",\"calendar\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4c6.png?v8\",\"call_me_hand\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f919.png?v8\",\"calling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4f2.png?v8\",\"cambodia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ed.png?v8\",\"camel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f42b.png?v8\",\"camera\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4f7.png?v8\",\"camera_flash\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4f8.png?v8\",\"cameroon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f2.png?v8\",\"camping\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3d5.png?v8\",\"canada\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e6.png?v8\",\"canary_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1e8.png?v8\",\"cancer\":\"https://github.githubassets.com/images/icons/emoji/unicode/264b.png?v8\",\"candle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f56f.png?v8\",\"candy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f36c.png?v8\",\"canned_food\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f96b.png?v8\",\"canoe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6f6.png?v8\",\"cape_verde\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fb.png?v8\",\"capital_abcd\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f520.png?v8\",\"capricorn\":\"https://github.githubassets.com/images/icons/emoji/unicode/2651.png?v8\",\"car\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f697.png?v8\",\"card_file_box\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5c3.png?v8\",\"card_index\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4c7.png?v8\",\"card_index_dividers\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5c2.png?v8\",\"caribbean_netherlands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f6.png?v8\",\"carousel_horse\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3a0.png?v8\",\"carpentry_saw\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa9a.png?v8\",\"carrot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f955.png?v8\",\"cartwheeling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f938.png?v8\",\"cat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f431.png?v8\",\"cat2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f408.png?v8\",\"cayman_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1fe.png?v8\",\"cd\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4bf.png?v8\",\"central_african_republic\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1eb.png?v8\",\"ceuta_melilla\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1e6.png?v8\",\"chad\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e9.png?v8\",\"chains\":\"https://github.githubassets.com/images/icons/emoji/unicode/26d3.png?v8\",\"chair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa91.png?v8\",\"champagne\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f37e.png?v8\",\"chart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4b9.png?v8\",\"chart_with_downwards_trend\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4c9.png?v8\",\"chart_with_upwards_trend\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4c8.png?v8\",\"checkered_flag\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c1.png?v8\",\"cheese\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9c0.png?v8\",\"cherries\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f352.png?v8\",\"cherry_blossom\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f338.png?v8\",\"chess_pawn\":\"https://github.githubassets.com/images/icons/emoji/unicode/265f.png?v8\",\"chestnut\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f330.png?v8\",\"chicken\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f414.png?v8\",\"child\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d2.png?v8\",\"children_crossing\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b8.png?v8\",\"chile\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f1.png?v8\",\"chipmunk\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f43f.png?v8\",\"chocolate_bar\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f36b.png?v8\",\"chopsticks\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f962.png?v8\",\"christmas_island\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fd.png?v8\",\"christmas_tree\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f384.png?v8\",\"church\":\"https://github.githubassets.com/images/icons/emoji/unicode/26ea.png?v8\",\"cinema\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3a6.png?v8\",\"circus_tent\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3aa.png?v8\",\"city_sunrise\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f307.png?v8\",\"city_sunset\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f306.png?v8\",\"cityscape\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3d9.png?v8\",\"cl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f191.png?v8\",\"clamp\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5dc.png?v8\",\"clap\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f44f.png?v8\",\"clapper\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ac.png?v8\",\"classical_building\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3db.png?v8\",\"climbing\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d7.png?v8\",\"climbing_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d7-2642.png?v8\",\"climbing_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d7-2640.png?v8\",\"clinking_glasses\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f942.png?v8\",\"clipboard\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4cb.png?v8\",\"clipperton_island\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f5.png?v8\",\"clock1\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f550.png?v8\",\"clock10\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f559.png?v8\",\"clock1030\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f565.png?v8\",\"clock11\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f55a.png?v8\",\"clock1130\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f566.png?v8\",\"clock12\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f55b.png?v8\",\"clock1230\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f567.png?v8\",\"clock130\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f55c.png?v8\",\"clock2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f551.png?v8\",\"clock230\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f55d.png?v8\",\"clock3\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f552.png?v8\",\"clock330\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f55e.png?v8\",\"clock4\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f553.png?v8\",\"clock430\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f55f.png?v8\",\"clock5\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f554.png?v8\",\"clock530\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f560.png?v8\",\"clock6\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f555.png?v8\",\"clock630\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f561.png?v8\",\"clock7\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f556.png?v8\",\"clock730\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f562.png?v8\",\"clock8\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f557.png?v8\",\"clock830\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f563.png?v8\",\"clock9\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f558.png?v8\",\"clock930\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f564.png?v8\",\"closed_book\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d5.png?v8\",\"closed_lock_with_key\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f510.png?v8\",\"closed_umbrella\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f302.png?v8\",\"cloud\":\"https://github.githubassets.com/images/icons/emoji/unicode/2601.png?v8\",\"cloud_with_lightning\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f329.png?v8\",\"cloud_with_lightning_and_rain\":\"https://github.githubassets.com/images/icons/emoji/unicode/26c8.png?v8\",\"cloud_with_rain\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f327.png?v8\",\"cloud_with_snow\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f328.png?v8\",\"clown_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f921.png?v8\",\"clubs\":\"https://github.githubassets.com/images/icons/emoji/unicode/2663.png?v8\",\"cn\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f3.png?v8\",\"coat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9e5.png?v8\",\"cockroach\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fab3.png?v8\",\"cocktail\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f378.png?v8\",\"coconut\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f965.png?v8\",\"cocos_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e8.png?v8\",\"coffee\":\"https://github.githubassets.com/images/icons/emoji/unicode/2615.png?v8\",\"coffin\":\"https://github.githubassets.com/images/icons/emoji/unicode/26b0.png?v8\",\"coin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa99.png?v8\",\"cold_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f976.png?v8\",\"cold_sweat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f630.png?v8\",\"collision\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a5.png?v8\",\"colombia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f4.png?v8\",\"comet\":\"https://github.githubassets.com/images/icons/emoji/unicode/2604.png?v8\",\"comoros\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f2.png?v8\",\"compass\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ed.png?v8\",\"computer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4bb.png?v8\",\"computer_mouse\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5b1.png?v8\",\"confetti_ball\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f38a.png?v8\",\"confounded\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f616.png?v8\",\"confused\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f615.png?v8\",\"congo_brazzaville\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ec.png?v8\",\"congo_kinshasa\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e9.png?v8\",\"congratulations\":\"https://github.githubassets.com/images/icons/emoji/unicode/3297.png?v8\",\"construction\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a7.png?v8\",\"construction_worker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f477.png?v8\",\"construction_worker_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f477-2642.png?v8\",\"construction_worker_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f477-2640.png?v8\",\"control_knobs\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f39b.png?v8\",\"convenience_store\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ea.png?v8\",\"cook\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f373.png?v8\",\"cook_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f0.png?v8\",\"cookie\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f36a.png?v8\",\"cool\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f192.png?v8\",\"cop\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8\",\"copyright\":\"https://github.githubassets.com/images/icons/emoji/unicode/00a9.png?v8\",\"corn\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f33d.png?v8\",\"costa_rica\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f7.png?v8\",\"cote_divoire\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ee.png?v8\",\"couch_and_lamp\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6cb.png?v8\",\"couple\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46b.png?v8\",\"couple_with_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f491.png?v8\",\"couple_with_heart_man_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-2764-1f468.png?v8\",\"couple_with_heart_woman_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f468.png?v8\",\"couple_with_heart_woman_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f469.png?v8\",\"couplekiss\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f48f.png?v8\",\"couplekiss_man_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-2764-1f48b-1f468.png?v8\",\"couplekiss_man_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f48b-1f468.png?v8\",\"couplekiss_woman_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f48b-1f469.png?v8\",\"cow\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f42e.png?v8\",\"cow2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f404.png?v8\",\"cowboy_hat_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f920.png?v8\",\"crab\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f980.png?v8\",\"crayon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f58d.png?v8\",\"credit_card\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4b3.png?v8\",\"crescent_moon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f319.png?v8\",\"cricket\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f997.png?v8\",\"cricket_game\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3cf.png?v8\",\"croatia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f7.png?v8\",\"crocodile\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f40a.png?v8\",\"croissant\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f950.png?v8\",\"crossed_fingers\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f91e.png?v8\",\"crossed_flags\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f38c.png?v8\",\"crossed_swords\":\"https://github.githubassets.com/images/icons/emoji/unicode/2694.png?v8\",\"crown\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f451.png?v8\",\"cry\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f622.png?v8\",\"crying_cat_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f63f.png?v8\",\"crystal_ball\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f52e.png?v8\",\"cuba\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fa.png?v8\",\"cucumber\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f952.png?v8\",\"cup_with_straw\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f964.png?v8\",\"cupcake\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9c1.png?v8\",\"cupid\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f498.png?v8\",\"curacao\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fc.png?v8\",\"curling_stone\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f94c.png?v8\",\"curly_haired_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b1.png?v8\",\"curly_haired_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b1.png?v8\",\"curly_loop\":\"https://github.githubassets.com/images/icons/emoji/unicode/27b0.png?v8\",\"currency_exchange\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4b1.png?v8\",\"curry\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f35b.png?v8\",\"cursing_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f92c.png?v8\",\"custard\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f36e.png?v8\",\"customs\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6c3.png?v8\",\"cut_of_meat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f969.png?v8\",\"cyclone\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f300.png?v8\",\"cyprus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fe.png?v8\",\"czech_republic\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ff.png?v8\",\"dagger\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5e1.png?v8\",\"dancer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f483.png?v8\",\"dancers\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46f.png?v8\",\"dancing_men\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46f-2642.png?v8\",\"dancing_women\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46f-2640.png?v8\",\"dango\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f361.png?v8\",\"dark_sunglasses\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f576.png?v8\",\"dart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3af.png?v8\",\"dash\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a8.png?v8\",\"date\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4c5.png?v8\",\"de\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ea.png?v8\",\"deaf_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9cf-2642.png?v8\",\"deaf_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9cf.png?v8\",\"deaf_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9cf-2640.png?v8\",\"deciduous_tree\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f333.png?v8\",\"deer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f98c.png?v8\",\"denmark\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f0.png?v8\",\"department_store\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ec.png?v8\",\"derelict_house\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3da.png?v8\",\"desert\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3dc.png?v8\",\"desert_island\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3dd.png?v8\",\"desktop_computer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5a5.png?v8\",\"detective\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f575.png?v8\",\"diamond_shape_with_a_dot_inside\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a0.png?v8\",\"diamonds\":\"https://github.githubassets.com/images/icons/emoji/unicode/2666.png?v8\",\"diego_garcia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ec.png?v8\",\"disappointed\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f61e.png?v8\",\"disappointed_relieved\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f625.png?v8\",\"disguised_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f978.png?v8\",\"diving_mask\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93f.png?v8\",\"diya_lamp\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa94.png?v8\",\"dizzy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ab.png?v8\",\"dizzy_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f635.png?v8\",\"djibouti\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ef.png?v8\",\"dna\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ec.png?v8\",\"do_not_litter\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6af.png?v8\",\"dodo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9a4.png?v8\",\"dog\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f436.png?v8\",\"dog2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f415.png?v8\",\"dollar\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4b5.png?v8\",\"dolls\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f38e.png?v8\",\"dolphin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f42c.png?v8\",\"dominica\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f2.png?v8\",\"dominican_republic\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f4.png?v8\",\"door\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6aa.png?v8\",\"doughnut\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f369.png?v8\",\"dove\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f54a.png?v8\",\"dragon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f409.png?v8\",\"dragon_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f432.png?v8\",\"dress\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f457.png?v8\",\"dromedary_camel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f42a.png?v8\",\"drooling_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f924.png?v8\",\"drop_of_blood\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa78.png?v8\",\"droplet\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a7.png?v8\",\"drum\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f941.png?v8\",\"duck\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f986.png?v8\",\"dumpling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f95f.png?v8\",\"dvd\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4c0.png?v8\",\"e-mail\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e7.png?v8\",\"eagle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f985.png?v8\",\"ear\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f442.png?v8\",\"ear_of_rice\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f33e.png?v8\",\"ear_with_hearing_aid\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9bb.png?v8\",\"earth_africa\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f30d.png?v8\",\"earth_americas\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f30e.png?v8\",\"earth_asia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f30f.png?v8\",\"ecuador\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1e8.png?v8\",\"egg\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f95a.png?v8\",\"eggplant\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f346.png?v8\",\"egypt\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ec.png?v8\",\"eight\":\"https://github.githubassets.com/images/icons/emoji/unicode/0038-20e3.png?v8\",\"eight_pointed_black_star\":\"https://github.githubassets.com/images/icons/emoji/unicode/2734.png?v8\",\"eight_spoked_asterisk\":\"https://github.githubassets.com/images/icons/emoji/unicode/2733.png?v8\",\"eject_button\":\"https://github.githubassets.com/images/icons/emoji/unicode/23cf.png?v8\",\"el_salvador\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fb.png?v8\",\"electric_plug\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f50c.png?v8\",\"electron\":\"https://github.githubassets.com/images/icons/emoji/electron.png?v8\",\"elephant\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f418.png?v8\",\"elevator\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6d7.png?v8\",\"elf\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9dd.png?v8\",\"elf_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9dd-2642.png?v8\",\"elf_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9dd-2640.png?v8\",\"email\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e7.png?v8\",\"end\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f51a.png?v8\",\"england\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0065-e006e-e0067-e007f.png?v8\",\"envelope\":\"https://github.githubassets.com/images/icons/emoji/unicode/2709.png?v8\",\"envelope_with_arrow\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e9.png?v8\",\"equatorial_guinea\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f6.png?v8\",\"eritrea\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f7.png?v8\",\"es\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f8.png?v8\",\"estonia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ea.png?v8\",\"ethiopia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f9.png?v8\",\"eu\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1fa.png?v8\",\"euro\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4b6.png?v8\",\"european_castle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f0.png?v8\",\"european_post_office\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3e4.png?v8\",\"european_union\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1fa.png?v8\",\"evergreen_tree\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f332.png?v8\",\"exclamation\":\"https://github.githubassets.com/images/icons/emoji/unicode/2757.png?v8\",\"exploding_head\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f92f.png?v8\",\"expressionless\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f611.png?v8\",\"eye\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f441.png?v8\",\"eye_speech_bubble\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f441-1f5e8.png?v8\",\"eyeglasses\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f453.png?v8\",\"eyes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f440.png?v8\",\"face_exhaling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f62e-1f4a8.png?v8\",\"face_in_clouds\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f636-1f32b.png?v8\",\"face_with_head_bandage\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f915.png?v8\",\"face_with_spiral_eyes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f635-1f4ab.png?v8\",\"face_with_thermometer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f912.png?v8\",\"facepalm\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f926.png?v8\",\"facepunch\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8\",\"factory\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ed.png?v8\",\"factory_worker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3ed.png?v8\",\"fairy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9da.png?v8\",\"fairy_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9da-2642.png?v8\",\"fairy_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9da-2640.png?v8\",\"falafel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9c6.png?v8\",\"falkland_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f0.png?v8\",\"fallen_leaf\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f342.png?v8\",\"family\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46a.png?v8\",\"family_man_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f466.png?v8\",\"family_man_boy_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f466-1f466.png?v8\",\"family_man_girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467.png?v8\",\"family_man_girl_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467-1f466.png?v8\",\"family_man_girl_girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467-1f467.png?v8\",\"family_man_man_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f466.png?v8\",\"family_man_man_boy_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f466-1f466.png?v8\",\"family_man_man_girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467.png?v8\",\"family_man_man_girl_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467-1f466.png?v8\",\"family_man_man_girl_girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467-1f467.png?v8\",\"family_man_woman_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f466.png?v8\",\"family_man_woman_boy_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f466-1f466.png?v8\",\"family_man_woman_girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467.png?v8\",\"family_man_woman_girl_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467-1f466.png?v8\",\"family_man_woman_girl_girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467-1f467.png?v8\",\"family_woman_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f466.png?v8\",\"family_woman_boy_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f466-1f466.png?v8\",\"family_woman_girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467.png?v8\",\"family_woman_girl_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467-1f466.png?v8\",\"family_woman_girl_girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467-1f467.png?v8\",\"family_woman_woman_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f466.png?v8\",\"family_woman_woman_boy_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f466-1f466.png?v8\",\"family_woman_woman_girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467.png?v8\",\"family_woman_woman_girl_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467-1f466.png?v8\",\"family_woman_woman_girl_girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467-1f467.png?v8\",\"farmer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f33e.png?v8\",\"faroe_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f4.png?v8\",\"fast_forward\":\"https://github.githubassets.com/images/icons/emoji/unicode/23e9.png?v8\",\"fax\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e0.png?v8\",\"fearful\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f628.png?v8\",\"feather\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fab6.png?v8\",\"feelsgood\":\"https://github.githubassets.com/images/icons/emoji/feelsgood.png?v8\",\"feet\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f43e.png?v8\",\"female_detective\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f575-2640.png?v8\",\"female_sign\":\"https://github.githubassets.com/images/icons/emoji/unicode/2640.png?v8\",\"ferris_wheel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3a1.png?v8\",\"ferry\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f4.png?v8\",\"field_hockey\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3d1.png?v8\",\"fiji\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1ef.png?v8\",\"file_cabinet\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5c4.png?v8\",\"file_folder\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4c1.png?v8\",\"film_projector\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4fd.png?v8\",\"film_strip\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f39e.png?v8\",\"finland\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1ee.png?v8\",\"finnadie\":\"https://github.githubassets.com/images/icons/emoji/finnadie.png?v8\",\"fire\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f525.png?v8\",\"fire_engine\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f692.png?v8\",\"fire_extinguisher\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ef.png?v8\",\"firecracker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9e8.png?v8\",\"firefighter\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f692.png?v8\",\"fireworks\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f386.png?v8\",\"first_quarter_moon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f313.png?v8\",\"first_quarter_moon_with_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f31b.png?v8\",\"fish\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f41f.png?v8\",\"fish_cake\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f365.png?v8\",\"fishing_pole_and_fish\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3a3.png?v8\",\"fist\":\"https://github.githubassets.com/images/icons/emoji/unicode/270a.png?v8\",\"fist_left\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f91b.png?v8\",\"fist_oncoming\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8\",\"fist_raised\":\"https://github.githubassets.com/images/icons/emoji/unicode/270a.png?v8\",\"fist_right\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f91c.png?v8\",\"five\":\"https://github.githubassets.com/images/icons/emoji/unicode/0035-20e3.png?v8\",\"flags\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f38f.png?v8\",\"flamingo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9a9.png?v8\",\"flashlight\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f526.png?v8\",\"flat_shoe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f97f.png?v8\",\"flatbread\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fad3.png?v8\",\"fleur_de_lis\":\"https://github.githubassets.com/images/icons/emoji/unicode/269c.png?v8\",\"flight_arrival\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6ec.png?v8\",\"flight_departure\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6eb.png?v8\",\"flipper\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f42c.png?v8\",\"floppy_disk\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4be.png?v8\",\"flower_playing_cards\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3b4.png?v8\",\"flushed\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f633.png?v8\",\"fly\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fab0.png?v8\",\"flying_disc\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f94f.png?v8\",\"flying_saucer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6f8.png?v8\",\"fog\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f32b.png?v8\",\"foggy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f301.png?v8\",\"fondue\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fad5.png?v8\",\"foot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9b6.png?v8\",\"football\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c8.png?v8\",\"footprints\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f463.png?v8\",\"fork_and_knife\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f374.png?v8\",\"fortune_cookie\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f960.png?v8\",\"fountain\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f2.png?v8\",\"fountain_pen\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f58b.png?v8\",\"four\":\"https://github.githubassets.com/images/icons/emoji/unicode/0034-20e3.png?v8\",\"four_leaf_clover\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f340.png?v8\",\"fox_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f98a.png?v8\",\"fr\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f7.png?v8\",\"framed_picture\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5bc.png?v8\",\"free\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f193.png?v8\",\"french_guiana\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1eb.png?v8\",\"french_polynesia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1eb.png?v8\",\"french_southern_territories\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1eb.png?v8\",\"fried_egg\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f373.png?v8\",\"fried_shrimp\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f364.png?v8\",\"fries\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f35f.png?v8\",\"frog\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f438.png?v8\",\"frowning\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f626.png?v8\",\"frowning_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/2639.png?v8\",\"frowning_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64d-2642.png?v8\",\"frowning_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64d.png?v8\",\"frowning_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64d-2640.png?v8\",\"fu\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f595.png?v8\",\"fuelpump\":\"https://github.githubassets.com/images/icons/emoji/unicode/26fd.png?v8\",\"full_moon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f315.png?v8\",\"full_moon_with_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f31d.png?v8\",\"funeral_urn\":\"https://github.githubassets.com/images/icons/emoji/unicode/26b1.png?v8\",\"gabon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e6.png?v8\",\"gambia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f2.png?v8\",\"game_die\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3b2.png?v8\",\"garlic\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9c4.png?v8\",\"gb\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e7.png?v8\",\"gear\":\"https://github.githubassets.com/images/icons/emoji/unicode/2699.png?v8\",\"gem\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f48e.png?v8\",\"gemini\":\"https://github.githubassets.com/images/icons/emoji/unicode/264a.png?v8\",\"genie\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9de.png?v8\",\"genie_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9de-2642.png?v8\",\"genie_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9de-2640.png?v8\",\"georgia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ea.png?v8\",\"ghana\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ed.png?v8\",\"ghost\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f47b.png?v8\",\"gibraltar\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ee.png?v8\",\"gift\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f381.png?v8\",\"gift_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f49d.png?v8\",\"giraffe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f992.png?v8\",\"girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f467.png?v8\",\"globe_with_meridians\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f310.png?v8\",\"gloves\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9e4.png?v8\",\"goal_net\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f945.png?v8\",\"goat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f410.png?v8\",\"goberserk\":\"https://github.githubassets.com/images/icons/emoji/goberserk.png?v8\",\"godmode\":\"https://github.githubassets.com/images/icons/emoji/godmode.png?v8\",\"goggles\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f97d.png?v8\",\"golf\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f3.png?v8\",\"golfing\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3cc.png?v8\",\"golfing_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3cc-2642.png?v8\",\"golfing_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3cc-2640.png?v8\",\"gorilla\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f98d.png?v8\",\"grapes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f347.png?v8\",\"greece\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f7.png?v8\",\"green_apple\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f34f.png?v8\",\"green_book\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d7.png?v8\",\"green_circle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7e2.png?v8\",\"green_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f49a.png?v8\",\"green_salad\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f957.png?v8\",\"green_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7e9.png?v8\",\"greenland\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f1.png?v8\",\"grenada\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e9.png?v8\",\"grey_exclamation\":\"https://github.githubassets.com/images/icons/emoji/unicode/2755.png?v8\",\"grey_question\":\"https://github.githubassets.com/images/icons/emoji/unicode/2754.png?v8\",\"grimacing\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f62c.png?v8\",\"grin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f601.png?v8\",\"grinning\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f600.png?v8\",\"guadeloupe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f5.png?v8\",\"guam\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fa.png?v8\",\"guard\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f482.png?v8\",\"guardsman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f482-2642.png?v8\",\"guardswoman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f482-2640.png?v8\",\"guatemala\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f9.png?v8\",\"guernsey\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ec.png?v8\",\"guide_dog\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ae.png?v8\",\"guinea\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f3.png?v8\",\"guinea_bissau\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fc.png?v8\",\"guitar\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3b8.png?v8\",\"gun\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f52b.png?v8\",\"guyana\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fe.png?v8\",\"haircut\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f487.png?v8\",\"haircut_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f487-2642.png?v8\",\"haircut_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f487-2640.png?v8\",\"haiti\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f9.png?v8\",\"hamburger\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f354.png?v8\",\"hammer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f528.png?v8\",\"hammer_and_pick\":\"https://github.githubassets.com/images/icons/emoji/unicode/2692.png?v8\",\"hammer_and_wrench\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6e0.png?v8\",\"hamster\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f439.png?v8\",\"hand\":\"https://github.githubassets.com/images/icons/emoji/unicode/270b.png?v8\",\"hand_over_mouth\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f92d.png?v8\",\"handbag\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f45c.png?v8\",\"handball_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93e.png?v8\",\"handshake\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f91d.png?v8\",\"hankey\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a9.png?v8\",\"hash\":\"https://github.githubassets.com/images/icons/emoji/unicode/0023-20e3.png?v8\",\"hatched_chick\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f425.png?v8\",\"hatching_chick\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f423.png?v8\",\"headphones\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3a7.png?v8\",\"headstone\":\"https://github.githubassets.com/images/icons/emoji/unicode/1faa6.png?v8\",\"health_worker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2695.png?v8\",\"hear_no_evil\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f649.png?v8\",\"heard_mcdonald_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f2.png?v8\",\"heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/2764.png?v8\",\"heart_decoration\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f49f.png?v8\",\"heart_eyes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f60d.png?v8\",\"heart_eyes_cat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f63b.png?v8\",\"heart_on_fire\":\"https://github.githubassets.com/images/icons/emoji/unicode/2764-1f525.png?v8\",\"heartbeat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f493.png?v8\",\"heartpulse\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f497.png?v8\",\"hearts\":\"https://github.githubassets.com/images/icons/emoji/unicode/2665.png?v8\",\"heavy_check_mark\":\"https://github.githubassets.com/images/icons/emoji/unicode/2714.png?v8\",\"heavy_division_sign\":\"https://github.githubassets.com/images/icons/emoji/unicode/2797.png?v8\",\"heavy_dollar_sign\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4b2.png?v8\",\"heavy_exclamation_mark\":\"https://github.githubassets.com/images/icons/emoji/unicode/2757.png?v8\",\"heavy_heart_exclamation\":\"https://github.githubassets.com/images/icons/emoji/unicode/2763.png?v8\",\"heavy_minus_sign\":\"https://github.githubassets.com/images/icons/emoji/unicode/2796.png?v8\",\"heavy_multiplication_x\":\"https://github.githubassets.com/images/icons/emoji/unicode/2716.png?v8\",\"heavy_plus_sign\":\"https://github.githubassets.com/images/icons/emoji/unicode/2795.png?v8\",\"hedgehog\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f994.png?v8\",\"helicopter\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f681.png?v8\",\"herb\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f33f.png?v8\",\"hibiscus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f33a.png?v8\",\"high_brightness\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f506.png?v8\",\"high_heel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f460.png?v8\",\"hiking_boot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f97e.png?v8\",\"hindu_temple\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6d5.png?v8\",\"hippopotamus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f99b.png?v8\",\"hocho\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f52a.png?v8\",\"hole\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f573.png?v8\",\"honduras\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f3.png?v8\",\"honey_pot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f36f.png?v8\",\"honeybee\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f41d.png?v8\",\"hong_kong\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f0.png?v8\",\"hook\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa9d.png?v8\",\"horse\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f434.png?v8\",\"horse_racing\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c7.png?v8\",\"hospital\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3e5.png?v8\",\"hot_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f975.png?v8\",\"hot_pepper\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f336.png?v8\",\"hotdog\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f32d.png?v8\",\"hotel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3e8.png?v8\",\"hotsprings\":\"https://github.githubassets.com/images/icons/emoji/unicode/2668.png?v8\",\"hourglass\":\"https://github.githubassets.com/images/icons/emoji/unicode/231b.png?v8\",\"hourglass_flowing_sand\":\"https://github.githubassets.com/images/icons/emoji/unicode/23f3.png?v8\",\"house\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3e0.png?v8\",\"house_with_garden\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3e1.png?v8\",\"houses\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3d8.png?v8\",\"hugs\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f917.png?v8\",\"hungary\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1fa.png?v8\",\"hurtrealbad\":\"https://github.githubassets.com/images/icons/emoji/hurtrealbad.png?v8\",\"hushed\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f62f.png?v8\",\"hut\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6d6.png?v8\",\"ice_cream\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f368.png?v8\",\"ice_cube\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ca.png?v8\",\"ice_hockey\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3d2.png?v8\",\"ice_skate\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f8.png?v8\",\"icecream\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f366.png?v8\",\"iceland\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f8.png?v8\",\"id\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f194.png?v8\",\"ideograph_advantage\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f250.png?v8\",\"imp\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f47f.png?v8\",\"inbox_tray\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e5.png?v8\",\"incoming_envelope\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e8.png?v8\",\"india\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f3.png?v8\",\"indonesia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1e9.png?v8\",\"infinity\":\"https://github.githubassets.com/images/icons/emoji/unicode/267e.png?v8\",\"information_desk_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f481.png?v8\",\"information_source\":\"https://github.githubassets.com/images/icons/emoji/unicode/2139.png?v8\",\"innocent\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f607.png?v8\",\"interrobang\":\"https://github.githubassets.com/images/icons/emoji/unicode/2049.png?v8\",\"iphone\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4f1.png?v8\",\"iran\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f7.png?v8\",\"iraq\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f6.png?v8\",\"ireland\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1ea.png?v8\",\"isle_of_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f2.png?v8\",\"israel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f1.png?v8\",\"it\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f9.png?v8\",\"izakaya_lantern\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ee.png?v8\",\"jack_o_lantern\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f383.png?v8\",\"jamaica\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f2.png?v8\",\"japan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5fe.png?v8\",\"japanese_castle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ef.png?v8\",\"japanese_goblin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f47a.png?v8\",\"japanese_ogre\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f479.png?v8\",\"jeans\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f456.png?v8\",\"jersey\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1ea.png?v8\",\"jigsaw\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9e9.png?v8\",\"jordan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f4.png?v8\",\"joy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f602.png?v8\",\"joy_cat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f639.png?v8\",\"joystick\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f579.png?v8\",\"jp\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f5.png?v8\",\"judge\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2696.png?v8\",\"juggling_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f939.png?v8\",\"kangaroo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f998.png?v8\",\"kazakhstan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ff.png?v8\",\"kenya\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ea.png?v8\",\"key\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f511.png?v8\",\"keyboard\":\"https://github.githubassets.com/images/icons/emoji/unicode/2328.png?v8\",\"keycap_ten\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f51f.png?v8\",\"kick_scooter\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6f4.png?v8\",\"kimono\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f458.png?v8\",\"kiribati\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ee.png?v8\",\"kiss\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f48b.png?v8\",\"kissing\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f617.png?v8\",\"kissing_cat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f63d.png?v8\",\"kissing_closed_eyes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f61a.png?v8\",\"kissing_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f618.png?v8\",\"kissing_smiling_eyes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f619.png?v8\",\"kite\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa81.png?v8\",\"kiwi_fruit\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f95d.png?v8\",\"kneeling_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ce-2642.png?v8\",\"kneeling_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ce.png?v8\",\"kneeling_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ce-2640.png?v8\",\"knife\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f52a.png?v8\",\"knot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1faa2.png?v8\",\"koala\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f428.png?v8\",\"koko\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f201.png?v8\",\"kosovo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fd-1f1f0.png?v8\",\"kr\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f7.png?v8\",\"kuwait\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1fc.png?v8\",\"kyrgyzstan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ec.png?v8\",\"lab_coat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f97c.png?v8\",\"label\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f7.png?v8\",\"lacrosse\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f94d.png?v8\",\"ladder\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa9c.png?v8\",\"lady_beetle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f41e.png?v8\",\"lantern\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ee.png?v8\",\"laos\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e6.png?v8\",\"large_blue_circle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f535.png?v8\",\"large_blue_diamond\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f537.png?v8\",\"large_orange_diamond\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f536.png?v8\",\"last_quarter_moon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f317.png?v8\",\"last_quarter_moon_with_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f31c.png?v8\",\"latin_cross\":\"https://github.githubassets.com/images/icons/emoji/unicode/271d.png?v8\",\"latvia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fb.png?v8\",\"laughing\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f606.png?v8\",\"leafy_green\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f96c.png?v8\",\"leaves\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f343.png?v8\",\"lebanon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e7.png?v8\",\"ledger\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d2.png?v8\",\"left_luggage\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6c5.png?v8\",\"left_right_arrow\":\"https://github.githubassets.com/images/icons/emoji/unicode/2194.png?v8\",\"left_speech_bubble\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5e8.png?v8\",\"leftwards_arrow_with_hook\":\"https://github.githubassets.com/images/icons/emoji/unicode/21a9.png?v8\",\"leg\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9b5.png?v8\",\"lemon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f34b.png?v8\",\"leo\":\"https://github.githubassets.com/images/icons/emoji/unicode/264c.png?v8\",\"leopard\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f406.png?v8\",\"lesotho\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f8.png?v8\",\"level_slider\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f39a.png?v8\",\"liberia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f7.png?v8\",\"libra\":\"https://github.githubassets.com/images/icons/emoji/unicode/264e.png?v8\",\"libya\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fe.png?v8\",\"liechtenstein\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1ee.png?v8\",\"light_rail\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f688.png?v8\",\"link\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f517.png?v8\",\"lion\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f981.png?v8\",\"lips\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f444.png?v8\",\"lipstick\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f484.png?v8\",\"lithuania\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f9.png?v8\",\"lizard\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f98e.png?v8\",\"llama\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f999.png?v8\",\"lobster\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f99e.png?v8\",\"lock\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f512.png?v8\",\"lock_with_ink_pen\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f50f.png?v8\",\"lollipop\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f36d.png?v8\",\"long_drum\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa98.png?v8\",\"loop\":\"https://github.githubassets.com/images/icons/emoji/unicode/27bf.png?v8\",\"lotion_bottle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9f4.png?v8\",\"lotus_position\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d8.png?v8\",\"lotus_position_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d8-2642.png?v8\",\"lotus_position_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d8-2640.png?v8\",\"loud_sound\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f50a.png?v8\",\"loudspeaker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e2.png?v8\",\"love_hotel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3e9.png?v8\",\"love_letter\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f48c.png?v8\",\"love_you_gesture\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f91f.png?v8\",\"low_brightness\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f505.png?v8\",\"luggage\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9f3.png?v8\",\"lungs\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fac1.png?v8\",\"luxembourg\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fa.png?v8\",\"lying_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f925.png?v8\",\"m\":\"https://github.githubassets.com/images/icons/emoji/unicode/24c2.png?v8\",\"macau\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f4.png?v8\",\"macedonia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f0.png?v8\",\"madagascar\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ec.png?v8\",\"mag\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f50d.png?v8\",\"mag_right\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f50e.png?v8\",\"mage\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d9.png?v8\",\"mage_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d9-2642.png?v8\",\"mage_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d9-2640.png?v8\",\"magic_wand\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa84.png?v8\",\"magnet\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9f2.png?v8\",\"mahjong\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f004.png?v8\",\"mailbox\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4eb.png?v8\",\"mailbox_closed\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ea.png?v8\",\"mailbox_with_mail\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ec.png?v8\",\"mailbox_with_no_mail\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ed.png?v8\",\"malawi\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fc.png?v8\",\"malaysia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fe.png?v8\",\"maldives\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fb.png?v8\",\"male_detective\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f575-2642.png?v8\",\"male_sign\":\"https://github.githubassets.com/images/icons/emoji/unicode/2642.png?v8\",\"mali\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f1.png?v8\",\"malta\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f9.png?v8\",\"mammoth\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9a3.png?v8\",\"man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468.png?v8\",\"man_artist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3a8.png?v8\",\"man_astronaut\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f680.png?v8\",\"man_beard\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d4-2642.png?v8\",\"man_cartwheeling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f938-2642.png?v8\",\"man_cook\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f373.png?v8\",\"man_dancing\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f57a.png?v8\",\"man_facepalming\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f926-2642.png?v8\",\"man_factory_worker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3ed.png?v8\",\"man_farmer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f33e.png?v8\",\"man_feeding_baby\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f37c.png?v8\",\"man_firefighter\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f692.png?v8\",\"man_health_worker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-2695.png?v8\",\"man_in_manual_wheelchair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9bd.png?v8\",\"man_in_motorized_wheelchair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9bc.png?v8\",\"man_in_tuxedo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f935-2642.png?v8\",\"man_judge\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-2696.png?v8\",\"man_juggling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f939-2642.png?v8\",\"man_mechanic\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f527.png?v8\",\"man_office_worker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f4bc.png?v8\",\"man_pilot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-2708.png?v8\",\"man_playing_handball\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93e-2642.png?v8\",\"man_playing_water_polo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93d-2642.png?v8\",\"man_scientist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f52c.png?v8\",\"man_shrugging\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f937-2642.png?v8\",\"man_singer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3a4.png?v8\",\"man_student\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f393.png?v8\",\"man_teacher\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3eb.png?v8\",\"man_technologist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f4bb.png?v8\",\"man_with_gua_pi_mao\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f472.png?v8\",\"man_with_probing_cane\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9af.png?v8\",\"man_with_turban\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f473-2642.png?v8\",\"man_with_veil\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f470-2642.png?v8\",\"mandarin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8\",\"mango\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f96d.png?v8\",\"mans_shoe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f45e.png?v8\",\"mantelpiece_clock\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f570.png?v8\",\"manual_wheelchair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9bd.png?v8\",\"maple_leaf\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f341.png?v8\",\"marshall_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ed.png?v8\",\"martial_arts_uniform\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f94b.png?v8\",\"martinique\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f6.png?v8\",\"mask\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f637.png?v8\",\"massage\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f486.png?v8\",\"massage_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f486-2642.png?v8\",\"massage_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f486-2640.png?v8\",\"mate\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9c9.png?v8\",\"mauritania\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f7.png?v8\",\"mauritius\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fa.png?v8\",\"mayotte\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fe-1f1f9.png?v8\",\"meat_on_bone\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f356.png?v8\",\"mechanic\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f527.png?v8\",\"mechanical_arm\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9be.png?v8\",\"mechanical_leg\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9bf.png?v8\",\"medal_military\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f396.png?v8\",\"medal_sports\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c5.png?v8\",\"medical_symbol\":\"https://github.githubassets.com/images/icons/emoji/unicode/2695.png?v8\",\"mega\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e3.png?v8\",\"melon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f348.png?v8\",\"memo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4dd.png?v8\",\"men_wrestling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93c-2642.png?v8\",\"mending_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/2764-1fa79.png?v8\",\"menorah\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f54e.png?v8\",\"mens\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b9.png?v8\",\"mermaid\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9dc-2640.png?v8\",\"merman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9dc-2642.png?v8\",\"merperson\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9dc.png?v8\",\"metal\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f918.png?v8\",\"metro\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f687.png?v8\",\"mexico\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fd.png?v8\",\"microbe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9a0.png?v8\",\"micronesia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f2.png?v8\",\"microphone\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3a4.png?v8\",\"microscope\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f52c.png?v8\",\"middle_finger\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f595.png?v8\",\"military_helmet\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa96.png?v8\",\"milk_glass\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f95b.png?v8\",\"milky_way\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f30c.png?v8\",\"minibus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f690.png?v8\",\"minidisc\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4bd.png?v8\",\"mirror\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa9e.png?v8\",\"mobile_phone_off\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4f4.png?v8\",\"moldova\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e9.png?v8\",\"monaco\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e8.png?v8\",\"money_mouth_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f911.png?v8\",\"money_with_wings\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4b8.png?v8\",\"moneybag\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4b0.png?v8\",\"mongolia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f3.png?v8\",\"monkey\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f412.png?v8\",\"monkey_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f435.png?v8\",\"monocle_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d0.png?v8\",\"monorail\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f69d.png?v8\",\"montenegro\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ea.png?v8\",\"montserrat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f8.png?v8\",\"moon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f314.png?v8\",\"moon_cake\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f96e.png?v8\",\"morocco\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e6.png?v8\",\"mortar_board\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f393.png?v8\",\"mosque\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f54c.png?v8\",\"mosquito\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f99f.png?v8\",\"motor_boat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6e5.png?v8\",\"motor_scooter\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6f5.png?v8\",\"motorcycle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3cd.png?v8\",\"motorized_wheelchair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9bc.png?v8\",\"motorway\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6e3.png?v8\",\"mount_fuji\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5fb.png?v8\",\"mountain\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f0.png?v8\",\"mountain_bicyclist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b5.png?v8\",\"mountain_biking_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b5-2642.png?v8\",\"mountain_biking_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b5-2640.png?v8\",\"mountain_cableway\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a0.png?v8\",\"mountain_railway\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f69e.png?v8\",\"mountain_snow\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3d4.png?v8\",\"mouse\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f42d.png?v8\",\"mouse2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f401.png?v8\",\"mouse_trap\":\"https://github.githubassets.com/images/icons/emoji/unicode/1faa4.png?v8\",\"movie_camera\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3a5.png?v8\",\"moyai\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5ff.png?v8\",\"mozambique\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ff.png?v8\",\"mrs_claus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f936.png?v8\",\"muscle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4aa.png?v8\",\"mushroom\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f344.png?v8\",\"musical_keyboard\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3b9.png?v8\",\"musical_note\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3b5.png?v8\",\"musical_score\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3bc.png?v8\",\"mute\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f507.png?v8\",\"mx_claus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f384.png?v8\",\"myanmar\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f2.png?v8\",\"nail_care\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f485.png?v8\",\"name_badge\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4db.png?v8\",\"namibia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1e6.png?v8\",\"national_park\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3de.png?v8\",\"nauru\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f7.png?v8\",\"nauseated_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f922.png?v8\",\"nazar_amulet\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ff.png?v8\",\"neckbeard\":\"https://github.githubassets.com/images/icons/emoji/neckbeard.png?v8\",\"necktie\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f454.png?v8\",\"negative_squared_cross_mark\":\"https://github.githubassets.com/images/icons/emoji/unicode/274e.png?v8\",\"nepal\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f5.png?v8\",\"nerd_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f913.png?v8\",\"nesting_dolls\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa86.png?v8\",\"netherlands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f1.png?v8\",\"neutral_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f610.png?v8\",\"new\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f195.png?v8\",\"new_caledonia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1e8.png?v8\",\"new_moon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f311.png?v8\",\"new_moon_with_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f31a.png?v8\",\"new_zealand\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ff.png?v8\",\"newspaper\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4f0.png?v8\",\"newspaper_roll\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5de.png?v8\",\"next_track_button\":\"https://github.githubassets.com/images/icons/emoji/unicode/23ed.png?v8\",\"ng\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f196.png?v8\",\"ng_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f645-2642.png?v8\",\"ng_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f645-2640.png?v8\",\"nicaragua\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ee.png?v8\",\"niger\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ea.png?v8\",\"nigeria\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ec.png?v8\",\"night_with_stars\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f303.png?v8\",\"nine\":\"https://github.githubassets.com/images/icons/emoji/unicode/0039-20e3.png?v8\",\"ninja\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f977.png?v8\",\"niue\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1fa.png?v8\",\"no_bell\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f515.png?v8\",\"no_bicycles\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b3.png?v8\",\"no_entry\":\"https://github.githubassets.com/images/icons/emoji/unicode/26d4.png?v8\",\"no_entry_sign\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6ab.png?v8\",\"no_good\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f645.png?v8\",\"no_good_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f645-2642.png?v8\",\"no_good_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f645-2640.png?v8\",\"no_mobile_phones\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4f5.png?v8\",\"no_mouth\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f636.png?v8\",\"no_pedestrians\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b7.png?v8\",\"no_smoking\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6ad.png?v8\",\"non-potable_water\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b1.png?v8\",\"norfolk_island\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1eb.png?v8\",\"north_korea\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f5.png?v8\",\"northern_mariana_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f5.png?v8\",\"norway\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f4.png?v8\",\"nose\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f443.png?v8\",\"notebook\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d3.png?v8\",\"notebook_with_decorative_cover\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d4.png?v8\",\"notes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3b6.png?v8\",\"nut_and_bolt\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f529.png?v8\",\"o\":\"https://github.githubassets.com/images/icons/emoji/unicode/2b55.png?v8\",\"o2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f17e.png?v8\",\"ocean\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f30a.png?v8\",\"octocat\":\"https://github.githubassets.com/images/icons/emoji/octocat.png?v8\",\"octopus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f419.png?v8\",\"oden\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f362.png?v8\",\"office\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3e2.png?v8\",\"office_worker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f4bc.png?v8\",\"oil_drum\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6e2.png?v8\",\"ok\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f197.png?v8\",\"ok_hand\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f44c.png?v8\",\"ok_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f646-2642.png?v8\",\"ok_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f646.png?v8\",\"ok_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f646-2640.png?v8\",\"old_key\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5dd.png?v8\",\"older_adult\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d3.png?v8\",\"older_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f474.png?v8\",\"older_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f475.png?v8\",\"olive\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fad2.png?v8\",\"om\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f549.png?v8\",\"oman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f4-1f1f2.png?v8\",\"on\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f51b.png?v8\",\"oncoming_automobile\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f698.png?v8\",\"oncoming_bus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f68d.png?v8\",\"oncoming_police_car\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f694.png?v8\",\"oncoming_taxi\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f696.png?v8\",\"one\":\"https://github.githubassets.com/images/icons/emoji/unicode/0031-20e3.png?v8\",\"one_piece_swimsuit\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa71.png?v8\",\"onion\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9c5.png?v8\",\"open_book\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d6.png?v8\",\"open_file_folder\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4c2.png?v8\",\"open_hands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f450.png?v8\",\"open_mouth\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f62e.png?v8\",\"open_umbrella\":\"https://github.githubassets.com/images/icons/emoji/unicode/2602.png?v8\",\"ophiuchus\":\"https://github.githubassets.com/images/icons/emoji/unicode/26ce.png?v8\",\"orange\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8\",\"orange_book\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d9.png?v8\",\"orange_circle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7e0.png?v8\",\"orange_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9e1.png?v8\",\"orange_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7e7.png?v8\",\"orangutan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9a7.png?v8\",\"orthodox_cross\":\"https://github.githubassets.com/images/icons/emoji/unicode/2626.png?v8\",\"otter\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9a6.png?v8\",\"outbox_tray\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e4.png?v8\",\"owl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f989.png?v8\",\"ox\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f402.png?v8\",\"oyster\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9aa.png?v8\",\"package\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e6.png?v8\",\"page_facing_up\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4c4.png?v8\",\"page_with_curl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4c3.png?v8\",\"pager\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4df.png?v8\",\"paintbrush\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f58c.png?v8\",\"pakistan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f0.png?v8\",\"palau\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1fc.png?v8\",\"palestinian_territories\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f8.png?v8\",\"palm_tree\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f334.png?v8\",\"palms_up_together\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f932.png?v8\",\"panama\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1e6.png?v8\",\"pancakes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f95e.png?v8\",\"panda_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f43c.png?v8\",\"paperclip\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ce.png?v8\",\"paperclips\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f587.png?v8\",\"papua_new_guinea\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ec.png?v8\",\"parachute\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa82.png?v8\",\"paraguay\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1fe.png?v8\",\"parasol_on_ground\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f1.png?v8\",\"parking\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f17f.png?v8\",\"parrot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f99c.png?v8\",\"part_alternation_mark\":\"https://github.githubassets.com/images/icons/emoji/unicode/303d.png?v8\",\"partly_sunny\":\"https://github.githubassets.com/images/icons/emoji/unicode/26c5.png?v8\",\"partying_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f973.png?v8\",\"passenger_ship\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6f3.png?v8\",\"passport_control\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6c2.png?v8\",\"pause_button\":\"https://github.githubassets.com/images/icons/emoji/unicode/23f8.png?v8\",\"paw_prints\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f43e.png?v8\",\"peace_symbol\":\"https://github.githubassets.com/images/icons/emoji/unicode/262e.png?v8\",\"peach\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f351.png?v8\",\"peacock\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f99a.png?v8\",\"peanuts\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f95c.png?v8\",\"pear\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f350.png?v8\",\"pen\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f58a.png?v8\",\"pencil\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4dd.png?v8\",\"pencil2\":\"https://github.githubassets.com/images/icons/emoji/unicode/270f.png?v8\",\"penguin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f427.png?v8\",\"pensive\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f614.png?v8\",\"people_holding_hands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f91d-1f9d1.png?v8\",\"people_hugging\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fac2.png?v8\",\"performing_arts\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ad.png?v8\",\"persevere\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f623.png?v8\",\"person_bald\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b2.png?v8\",\"person_curly_hair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b1.png?v8\",\"person_feeding_baby\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f37c.png?v8\",\"person_fencing\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93a.png?v8\",\"person_in_manual_wheelchair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9bd.png?v8\",\"person_in_motorized_wheelchair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9bc.png?v8\",\"person_in_tuxedo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f935.png?v8\",\"person_red_hair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b0.png?v8\",\"person_white_hair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b3.png?v8\",\"person_with_probing_cane\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9af.png?v8\",\"person_with_turban\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f473.png?v8\",\"person_with_veil\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f470.png?v8\",\"peru\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ea.png?v8\",\"petri_dish\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9eb.png?v8\",\"philippines\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ed.png?v8\",\"phone\":\"https://github.githubassets.com/images/icons/emoji/unicode/260e.png?v8\",\"pick\":\"https://github.githubassets.com/images/icons/emoji/unicode/26cf.png?v8\",\"pickup_truck\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6fb.png?v8\",\"pie\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f967.png?v8\",\"pig\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f437.png?v8\",\"pig2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f416.png?v8\",\"pig_nose\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f43d.png?v8\",\"pill\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f48a.png?v8\",\"pilot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2708.png?v8\",\"pinata\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa85.png?v8\",\"pinched_fingers\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f90c.png?v8\",\"pinching_hand\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f90f.png?v8\",\"pineapple\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f34d.png?v8\",\"ping_pong\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3d3.png?v8\",\"pirate_flag\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-2620.png?v8\",\"pisces\":\"https://github.githubassets.com/images/icons/emoji/unicode/2653.png?v8\",\"pitcairn_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f3.png?v8\",\"pizza\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f355.png?v8\",\"placard\":\"https://github.githubassets.com/images/icons/emoji/unicode/1faa7.png?v8\",\"place_of_worship\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6d0.png?v8\",\"plate_with_cutlery\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f37d.png?v8\",\"play_or_pause_button\":\"https://github.githubassets.com/images/icons/emoji/unicode/23ef.png?v8\",\"pleading_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f97a.png?v8\",\"plunger\":\"https://github.githubassets.com/images/icons/emoji/unicode/1faa0.png?v8\",\"point_down\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f447.png?v8\",\"point_left\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f448.png?v8\",\"point_right\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f449.png?v8\",\"point_up\":\"https://github.githubassets.com/images/icons/emoji/unicode/261d.png?v8\",\"point_up_2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f446.png?v8\",\"poland\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f1.png?v8\",\"polar_bear\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f43b-2744.png?v8\",\"police_car\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f693.png?v8\",\"police_officer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8\",\"policeman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46e-2642.png?v8\",\"policewoman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46e-2640.png?v8\",\"poodle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f429.png?v8\",\"poop\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a9.png?v8\",\"popcorn\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f37f.png?v8\",\"portugal\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f9.png?v8\",\"post_office\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3e3.png?v8\",\"postal_horn\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ef.png?v8\",\"postbox\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ee.png?v8\",\"potable_water\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b0.png?v8\",\"potato\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f954.png?v8\",\"potted_plant\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fab4.png?v8\",\"pouch\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f45d.png?v8\",\"poultry_leg\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f357.png?v8\",\"pound\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4b7.png?v8\",\"pout\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f621.png?v8\",\"pouting_cat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f63e.png?v8\",\"pouting_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64e.png?v8\",\"pouting_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64e-2642.png?v8\",\"pouting_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64e-2640.png?v8\",\"pray\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64f.png?v8\",\"prayer_beads\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ff.png?v8\",\"pregnant_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f930.png?v8\",\"pretzel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f968.png?v8\",\"previous_track_button\":\"https://github.githubassets.com/images/icons/emoji/unicode/23ee.png?v8\",\"prince\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f934.png?v8\",\"princess\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f478.png?v8\",\"printer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5a8.png?v8\",\"probing_cane\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9af.png?v8\",\"puerto_rico\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f7.png?v8\",\"punch\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8\",\"purple_circle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7e3.png?v8\",\"purple_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f49c.png?v8\",\"purple_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7ea.png?v8\",\"purse\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f45b.png?v8\",\"pushpin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4cc.png?v8\",\"put_litter_in_its_place\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6ae.png?v8\",\"qatar\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f6-1f1e6.png?v8\",\"question\":\"https://github.githubassets.com/images/icons/emoji/unicode/2753.png?v8\",\"rabbit\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f430.png?v8\",\"rabbit2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f407.png?v8\",\"raccoon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f99d.png?v8\",\"racehorse\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f40e.png?v8\",\"racing_car\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ce.png?v8\",\"radio\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4fb.png?v8\",\"radio_button\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f518.png?v8\",\"radioactive\":\"https://github.githubassets.com/images/icons/emoji/unicode/2622.png?v8\",\"rage\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f621.png?v8\",\"rage1\":\"https://github.githubassets.com/images/icons/emoji/rage1.png?v8\",\"rage2\":\"https://github.githubassets.com/images/icons/emoji/rage2.png?v8\",\"rage3\":\"https://github.githubassets.com/images/icons/emoji/rage3.png?v8\",\"rage4\":\"https://github.githubassets.com/images/icons/emoji/rage4.png?v8\",\"railway_car\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f683.png?v8\",\"railway_track\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6e4.png?v8\",\"rainbow\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f308.png?v8\",\"rainbow_flag\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f3-1f308.png?v8\",\"raised_back_of_hand\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f91a.png?v8\",\"raised_eyebrow\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f928.png?v8\",\"raised_hand\":\"https://github.githubassets.com/images/icons/emoji/unicode/270b.png?v8\",\"raised_hand_with_fingers_splayed\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f590.png?v8\",\"raised_hands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64c.png?v8\",\"raising_hand\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64b.png?v8\",\"raising_hand_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64b-2642.png?v8\",\"raising_hand_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64b-2640.png?v8\",\"ram\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f40f.png?v8\",\"ramen\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f35c.png?v8\",\"rat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f400.png?v8\",\"razor\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa92.png?v8\",\"receipt\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9fe.png?v8\",\"record_button\":\"https://github.githubassets.com/images/icons/emoji/unicode/23fa.png?v8\",\"recycle\":\"https://github.githubassets.com/images/icons/emoji/unicode/267b.png?v8\",\"red_car\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f697.png?v8\",\"red_circle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f534.png?v8\",\"red_envelope\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9e7.png?v8\",\"red_haired_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b0.png?v8\",\"red_haired_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b0.png?v8\",\"red_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7e5.png?v8\",\"registered\":\"https://github.githubassets.com/images/icons/emoji/unicode/00ae.png?v8\",\"relaxed\":\"https://github.githubassets.com/images/icons/emoji/unicode/263a.png?v8\",\"relieved\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f60c.png?v8\",\"reminder_ribbon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f397.png?v8\",\"repeat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f501.png?v8\",\"repeat_one\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f502.png?v8\",\"rescue_worker_helmet\":\"https://github.githubassets.com/images/icons/emoji/unicode/26d1.png?v8\",\"restroom\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6bb.png?v8\",\"reunion\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1ea.png?v8\",\"revolving_hearts\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f49e.png?v8\",\"rewind\":\"https://github.githubassets.com/images/icons/emoji/unicode/23ea.png?v8\",\"rhinoceros\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f98f.png?v8\",\"ribbon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f380.png?v8\",\"rice\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f35a.png?v8\",\"rice_ball\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f359.png?v8\",\"rice_cracker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f358.png?v8\",\"rice_scene\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f391.png?v8\",\"right_anger_bubble\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5ef.png?v8\",\"ring\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f48d.png?v8\",\"ringed_planet\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa90.png?v8\",\"robot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f916.png?v8\",\"rock\":\"https://github.githubassets.com/images/icons/emoji/unicode/1faa8.png?v8\",\"rocket\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f680.png?v8\",\"rofl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f923.png?v8\",\"roll_eyes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f644.png?v8\",\"roll_of_paper\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9fb.png?v8\",\"roller_coaster\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3a2.png?v8\",\"roller_skate\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6fc.png?v8\",\"romania\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1f4.png?v8\",\"rooster\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f413.png?v8\",\"rose\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f339.png?v8\",\"rosette\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f5.png?v8\",\"rotating_light\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a8.png?v8\",\"round_pushpin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4cd.png?v8\",\"rowboat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a3.png?v8\",\"rowing_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a3-2642.png?v8\",\"rowing_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a3-2640.png?v8\",\"ru\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1fa.png?v8\",\"rugby_football\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c9.png?v8\",\"runner\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c3.png?v8\",\"running\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c3.png?v8\",\"running_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c3-2642.png?v8\",\"running_shirt_with_sash\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3bd.png?v8\",\"running_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c3-2640.png?v8\",\"rwanda\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1fc.png?v8\",\"sa\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f202.png?v8\",\"safety_pin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9f7.png?v8\",\"safety_vest\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ba.png?v8\",\"sagittarius\":\"https://github.githubassets.com/images/icons/emoji/unicode/2650.png?v8\",\"sailboat\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f5.png?v8\",\"sake\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f376.png?v8\",\"salt\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9c2.png?v8\",\"samoa\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fc-1f1f8.png?v8\",\"san_marino\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f2.png?v8\",\"sandal\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f461.png?v8\",\"sandwich\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f96a.png?v8\",\"santa\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f385.png?v8\",\"sao_tome_principe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f9.png?v8\",\"sari\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f97b.png?v8\",\"sassy_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f481-2642.png?v8\",\"sassy_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f481-2640.png?v8\",\"satellite\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e1.png?v8\",\"satisfied\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f606.png?v8\",\"saudi_arabia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e6.png?v8\",\"sauna_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d6-2642.png?v8\",\"sauna_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d6.png?v8\",\"sauna_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d6-2640.png?v8\",\"sauropod\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f995.png?v8\",\"saxophone\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3b7.png?v8\",\"scarf\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9e3.png?v8\",\"school\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3eb.png?v8\",\"school_satchel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f392.png?v8\",\"scientist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f52c.png?v8\",\"scissors\":\"https://github.githubassets.com/images/icons/emoji/unicode/2702.png?v8\",\"scorpion\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f982.png?v8\",\"scorpius\":\"https://github.githubassets.com/images/icons/emoji/unicode/264f.png?v8\",\"scotland\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0073-e0063-e0074-e007f.png?v8\",\"scream\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f631.png?v8\",\"scream_cat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f640.png?v8\",\"screwdriver\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa9b.png?v8\",\"scroll\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4dc.png?v8\",\"seal\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ad.png?v8\",\"seat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ba.png?v8\",\"secret\":\"https://github.githubassets.com/images/icons/emoji/unicode/3299.png?v8\",\"see_no_evil\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f648.png?v8\",\"seedling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f331.png?v8\",\"selfie\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f933.png?v8\",\"senegal\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f3.png?v8\",\"serbia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1f8.png?v8\",\"service_dog\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f415-1f9ba.png?v8\",\"seven\":\"https://github.githubassets.com/images/icons/emoji/unicode/0037-20e3.png?v8\",\"sewing_needle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1faa1.png?v8\",\"seychelles\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e8.png?v8\",\"shallow_pan_of_food\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f958.png?v8\",\"shamrock\":\"https://github.githubassets.com/images/icons/emoji/unicode/2618.png?v8\",\"shark\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f988.png?v8\",\"shaved_ice\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f367.png?v8\",\"sheep\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f411.png?v8\",\"shell\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f41a.png?v8\",\"shield\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6e1.png?v8\",\"shinto_shrine\":\"https://github.githubassets.com/images/icons/emoji/unicode/26e9.png?v8\",\"ship\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a2.png?v8\",\"shipit\":\"https://github.githubassets.com/images/icons/emoji/shipit.png?v8\",\"shirt\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f455.png?v8\",\"shoe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f45e.png?v8\",\"shopping\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6cd.png?v8\",\"shopping_cart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6d2.png?v8\",\"shorts\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa73.png?v8\",\"shower\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6bf.png?v8\",\"shrimp\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f990.png?v8\",\"shrug\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f937.png?v8\",\"shushing_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f92b.png?v8\",\"sierra_leone\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f1.png?v8\",\"signal_strength\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4f6.png?v8\",\"singapore\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ec.png?v8\",\"singer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3a4.png?v8\",\"sint_maarten\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fd.png?v8\",\"six\":\"https://github.githubassets.com/images/icons/emoji/unicode/0036-20e3.png?v8\",\"six_pointed_star\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f52f.png?v8\",\"skateboard\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6f9.png?v8\",\"ski\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3bf.png?v8\",\"skier\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f7.png?v8\",\"skull\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f480.png?v8\",\"skull_and_crossbones\":\"https://github.githubassets.com/images/icons/emoji/unicode/2620.png?v8\",\"skunk\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9a8.png?v8\",\"sled\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6f7.png?v8\",\"sleeping\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f634.png?v8\",\"sleeping_bed\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6cc.png?v8\",\"sleepy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f62a.png?v8\",\"slightly_frowning_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f641.png?v8\",\"slightly_smiling_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f642.png?v8\",\"slot_machine\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3b0.png?v8\",\"sloth\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9a5.png?v8\",\"slovakia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f0.png?v8\",\"slovenia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ee.png?v8\",\"small_airplane\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6e9.png?v8\",\"small_blue_diamond\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f539.png?v8\",\"small_orange_diamond\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f538.png?v8\",\"small_red_triangle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f53a.png?v8\",\"small_red_triangle_down\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f53b.png?v8\",\"smile\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f604.png?v8\",\"smile_cat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f638.png?v8\",\"smiley\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f603.png?v8\",\"smiley_cat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f63a.png?v8\",\"smiling_face_with_tear\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f972.png?v8\",\"smiling_face_with_three_hearts\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f970.png?v8\",\"smiling_imp\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f608.png?v8\",\"smirk\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f60f.png?v8\",\"smirk_cat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f63c.png?v8\",\"smoking\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6ac.png?v8\",\"snail\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f40c.png?v8\",\"snake\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f40d.png?v8\",\"sneezing_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f927.png?v8\",\"snowboarder\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c2.png?v8\",\"snowflake\":\"https://github.githubassets.com/images/icons/emoji/unicode/2744.png?v8\",\"snowman\":\"https://github.githubassets.com/images/icons/emoji/unicode/26c4.png?v8\",\"snowman_with_snow\":\"https://github.githubassets.com/images/icons/emoji/unicode/2603.png?v8\",\"soap\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9fc.png?v8\",\"sob\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f62d.png?v8\",\"soccer\":\"https://github.githubassets.com/images/icons/emoji/unicode/26bd.png?v8\",\"socks\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9e6.png?v8\",\"softball\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f94e.png?v8\",\"solomon_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e7.png?v8\",\"somalia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f4.png?v8\",\"soon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f51c.png?v8\",\"sos\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f198.png?v8\",\"sound\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f509.png?v8\",\"south_africa\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1e6.png?v8\",\"south_georgia_south_sandwich_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f8.png?v8\",\"south_sudan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f8.png?v8\",\"space_invader\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f47e.png?v8\",\"spades\":\"https://github.githubassets.com/images/icons/emoji/unicode/2660.png?v8\",\"spaghetti\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f35d.png?v8\",\"sparkle\":\"https://github.githubassets.com/images/icons/emoji/unicode/2747.png?v8\",\"sparkler\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f387.png?v8\",\"sparkles\":\"https://github.githubassets.com/images/icons/emoji/unicode/2728.png?v8\",\"sparkling_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f496.png?v8\",\"speak_no_evil\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64a.png?v8\",\"speaker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f508.png?v8\",\"speaking_head\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5e3.png?v8\",\"speech_balloon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ac.png?v8\",\"speedboat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a4.png?v8\",\"spider\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f577.png?v8\",\"spider_web\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f578.png?v8\",\"spiral_calendar\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5d3.png?v8\",\"spiral_notepad\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5d2.png?v8\",\"sponge\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9fd.png?v8\",\"spoon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f944.png?v8\",\"squid\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f991.png?v8\",\"sri_lanka\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f0.png?v8\",\"st_barthelemy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f1.png?v8\",\"st_helena\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ed.png?v8\",\"st_kitts_nevis\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f3.png?v8\",\"st_lucia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e8.png?v8\",\"st_martin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1eb.png?v8\",\"st_pierre_miquelon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f2.png?v8\",\"st_vincent_grenadines\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1e8.png?v8\",\"stadium\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3df.png?v8\",\"standing_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9cd-2642.png?v8\",\"standing_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9cd.png?v8\",\"standing_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9cd-2640.png?v8\",\"star\":\"https://github.githubassets.com/images/icons/emoji/unicode/2b50.png?v8\",\"star2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f31f.png?v8\",\"star_and_crescent\":\"https://github.githubassets.com/images/icons/emoji/unicode/262a.png?v8\",\"star_of_david\":\"https://github.githubassets.com/images/icons/emoji/unicode/2721.png?v8\",\"star_struck\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f929.png?v8\",\"stars\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f320.png?v8\",\"station\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f689.png?v8\",\"statue_of_liberty\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5fd.png?v8\",\"steam_locomotive\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f682.png?v8\",\"stethoscope\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa7a.png?v8\",\"stew\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f372.png?v8\",\"stop_button\":\"https://github.githubassets.com/images/icons/emoji/unicode/23f9.png?v8\",\"stop_sign\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6d1.png?v8\",\"stopwatch\":\"https://github.githubassets.com/images/icons/emoji/unicode/23f1.png?v8\",\"straight_ruler\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4cf.png?v8\",\"strawberry\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f353.png?v8\",\"stuck_out_tongue\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f61b.png?v8\",\"stuck_out_tongue_closed_eyes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f61d.png?v8\",\"stuck_out_tongue_winking_eye\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f61c.png?v8\",\"student\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f393.png?v8\",\"studio_microphone\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f399.png?v8\",\"stuffed_flatbread\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f959.png?v8\",\"sudan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e9.png?v8\",\"sun_behind_large_cloud\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f325.png?v8\",\"sun_behind_rain_cloud\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f326.png?v8\",\"sun_behind_small_cloud\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f324.png?v8\",\"sun_with_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f31e.png?v8\",\"sunflower\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f33b.png?v8\",\"sunglasses\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f60e.png?v8\",\"sunny\":\"https://github.githubassets.com/images/icons/emoji/unicode/2600.png?v8\",\"sunrise\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f305.png?v8\",\"sunrise_over_mountains\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f304.png?v8\",\"superhero\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9b8.png?v8\",\"superhero_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9b8-2642.png?v8\",\"superhero_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9b8-2640.png?v8\",\"supervillain\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9b9.png?v8\",\"supervillain_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9b9-2642.png?v8\",\"supervillain_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9b9-2640.png?v8\",\"surfer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c4.png?v8\",\"surfing_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c4-2642.png?v8\",\"surfing_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c4-2640.png?v8\",\"suriname\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f7.png?v8\",\"sushi\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f363.png?v8\",\"suspect\":\"https://github.githubassets.com/images/icons/emoji/suspect.png?v8\",\"suspension_railway\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f69f.png?v8\",\"svalbard_jan_mayen\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ef.png?v8\",\"swan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9a2.png?v8\",\"swaziland\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ff.png?v8\",\"sweat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f613.png?v8\",\"sweat_drops\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a6.png?v8\",\"sweat_smile\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f605.png?v8\",\"sweden\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ea.png?v8\",\"sweet_potato\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f360.png?v8\",\"swim_brief\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa72.png?v8\",\"swimmer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ca.png?v8\",\"swimming_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ca-2642.png?v8\",\"swimming_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ca-2640.png?v8\",\"switzerland\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ed.png?v8\",\"symbols\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f523.png?v8\",\"synagogue\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f54d.png?v8\",\"syria\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fe.png?v8\",\"syringe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f489.png?v8\",\"t-rex\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f996.png?v8\",\"taco\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f32e.png?v8\",\"tada\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f389.png?v8\",\"taiwan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1fc.png?v8\",\"tajikistan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ef.png?v8\",\"takeout_box\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f961.png?v8\",\"tamale\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fad4.png?v8\",\"tanabata_tree\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f38b.png?v8\",\"tangerine\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8\",\"tanzania\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ff.png?v8\",\"taurus\":\"https://github.githubassets.com/images/icons/emoji/unicode/2649.png?v8\",\"taxi\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f695.png?v8\",\"tea\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f375.png?v8\",\"teacher\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3eb.png?v8\",\"teapot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fad6.png?v8\",\"technologist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f4bb.png?v8\",\"teddy_bear\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9f8.png?v8\",\"telephone\":\"https://github.githubassets.com/images/icons/emoji/unicode/260e.png?v8\",\"telephone_receiver\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4de.png?v8\",\"telescope\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f52d.png?v8\",\"tennis\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3be.png?v8\",\"tent\":\"https://github.githubassets.com/images/icons/emoji/unicode/26fa.png?v8\",\"test_tube\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ea.png?v8\",\"thailand\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ed.png?v8\",\"thermometer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f321.png?v8\",\"thinking\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f914.png?v8\",\"thong_sandal\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa74.png?v8\",\"thought_balloon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ad.png?v8\",\"thread\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9f5.png?v8\",\"three\":\"https://github.githubassets.com/images/icons/emoji/unicode/0033-20e3.png?v8\",\"thumbsdown\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png?v8\",\"thumbsup\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png?v8\",\"ticket\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ab.png?v8\",\"tickets\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f39f.png?v8\",\"tiger\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f42f.png?v8\",\"tiger2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f405.png?v8\",\"timer_clock\":\"https://github.githubassets.com/images/icons/emoji/unicode/23f2.png?v8\",\"timor_leste\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f1.png?v8\",\"tipping_hand_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f481-2642.png?v8\",\"tipping_hand_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f481.png?v8\",\"tipping_hand_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f481-2640.png?v8\",\"tired_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f62b.png?v8\",\"tm\":\"https://github.githubassets.com/images/icons/emoji/unicode/2122.png?v8\",\"togo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ec.png?v8\",\"toilet\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6bd.png?v8\",\"tokelau\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f0.png?v8\",\"tokyo_tower\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5fc.png?v8\",\"tomato\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f345.png?v8\",\"tonga\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f4.png?v8\",\"tongue\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f445.png?v8\",\"toolbox\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9f0.png?v8\",\"tooth\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9b7.png?v8\",\"toothbrush\":\"https://github.githubassets.com/images/icons/emoji/unicode/1faa5.png?v8\",\"top\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f51d.png?v8\",\"tophat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3a9.png?v8\",\"tornado\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f32a.png?v8\",\"tr\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f7.png?v8\",\"trackball\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5b2.png?v8\",\"tractor\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f69c.png?v8\",\"traffic_light\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a5.png?v8\",\"train\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f68b.png?v8\",\"train2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f686.png?v8\",\"tram\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f68a.png?v8\",\"transgender_flag\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f3-26a7.png?v8\",\"transgender_symbol\":\"https://github.githubassets.com/images/icons/emoji/unicode/26a7.png?v8\",\"triangular_flag_on_post\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a9.png?v8\",\"triangular_ruler\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d0.png?v8\",\"trident\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f531.png?v8\",\"trinidad_tobago\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f9.png?v8\",\"tristan_da_cunha\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e6.png?v8\",\"triumph\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f624.png?v8\",\"trolleybus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f68e.png?v8\",\"trollface\":\"https://github.githubassets.com/images/icons/emoji/trollface.png?v8\",\"trophy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c6.png?v8\",\"tropical_drink\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f379.png?v8\",\"tropical_fish\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f420.png?v8\",\"truck\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f69a.png?v8\",\"trumpet\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ba.png?v8\",\"tshirt\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f455.png?v8\",\"tulip\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f337.png?v8\",\"tumbler_glass\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f943.png?v8\",\"tunisia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f3.png?v8\",\"turkey\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f983.png?v8\",\"turkmenistan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f2.png?v8\",\"turks_caicos_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e8.png?v8\",\"turtle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f422.png?v8\",\"tuvalu\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1fb.png?v8\",\"tv\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4fa.png?v8\",\"twisted_rightwards_arrows\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f500.png?v8\",\"two\":\"https://github.githubassets.com/images/icons/emoji/unicode/0032-20e3.png?v8\",\"two_hearts\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f495.png?v8\",\"two_men_holding_hands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46c.png?v8\",\"two_women_holding_hands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46d.png?v8\",\"u5272\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f239.png?v8\",\"u5408\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f234.png?v8\",\"u55b6\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f23a.png?v8\",\"u6307\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f22f.png?v8\",\"u6708\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f237.png?v8\",\"u6709\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f236.png?v8\",\"u6e80\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f235.png?v8\",\"u7121\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f21a.png?v8\",\"u7533\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f238.png?v8\",\"u7981\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f232.png?v8\",\"u7a7a\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f233.png?v8\",\"uganda\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1ec.png?v8\",\"uk\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e7.png?v8\",\"ukraine\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1e6.png?v8\",\"umbrella\":\"https://github.githubassets.com/images/icons/emoji/unicode/2614.png?v8\",\"unamused\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f612.png?v8\",\"underage\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f51e.png?v8\",\"unicorn\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f984.png?v8\",\"united_arab_emirates\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ea.png?v8\",\"united_nations\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f3.png?v8\",\"unlock\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f513.png?v8\",\"up\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f199.png?v8\",\"upside_down_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f643.png?v8\",\"uruguay\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1fe.png?v8\",\"us\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f8.png?v8\",\"us_outlying_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f2.png?v8\",\"us_virgin_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ee.png?v8\",\"uzbekistan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1ff.png?v8\",\"v\":\"https://github.githubassets.com/images/icons/emoji/unicode/270c.png?v8\",\"vampire\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9db.png?v8\",\"vampire_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9db-2642.png?v8\",\"vampire_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9db-2640.png?v8\",\"vanuatu\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1fa.png?v8\",\"vatican_city\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1e6.png?v8\",\"venezuela\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ea.png?v8\",\"vertical_traffic_light\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a6.png?v8\",\"vhs\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4fc.png?v8\",\"vibration_mode\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4f3.png?v8\",\"video_camera\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4f9.png?v8\",\"video_game\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ae.png?v8\",\"vietnam\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1f3.png?v8\",\"violin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3bb.png?v8\",\"virgo\":\"https://github.githubassets.com/images/icons/emoji/unicode/264d.png?v8\",\"volcano\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f30b.png?v8\",\"volleyball\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3d0.png?v8\",\"vomiting_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f92e.png?v8\",\"vs\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f19a.png?v8\",\"vulcan_salute\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f596.png?v8\",\"waffle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9c7.png?v8\",\"wales\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0077-e006c-e0073-e007f.png?v8\",\"walking\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b6.png?v8\",\"walking_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b6-2642.png?v8\",\"walking_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b6-2640.png?v8\",\"wallis_futuna\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fc-1f1eb.png?v8\",\"waning_crescent_moon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f318.png?v8\",\"waning_gibbous_moon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f316.png?v8\",\"warning\":\"https://github.githubassets.com/images/icons/emoji/unicode/26a0.png?v8\",\"wastebasket\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5d1.png?v8\",\"watch\":\"https://github.githubassets.com/images/icons/emoji/unicode/231a.png?v8\",\"water_buffalo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f403.png?v8\",\"water_polo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93d.png?v8\",\"watermelon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f349.png?v8\",\"wave\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f44b.png?v8\",\"wavy_dash\":\"https://github.githubassets.com/images/icons/emoji/unicode/3030.png?v8\",\"waxing_crescent_moon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f312.png?v8\",\"waxing_gibbous_moon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f314.png?v8\",\"wc\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6be.png?v8\",\"weary\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f629.png?v8\",\"wedding\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f492.png?v8\",\"weight_lifting\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3cb.png?v8\",\"weight_lifting_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3cb-2642.png?v8\",\"weight_lifting_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3cb-2640.png?v8\",\"western_sahara\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ed.png?v8\",\"whale\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f433.png?v8\",\"whale2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f40b.png?v8\",\"wheel_of_dharma\":\"https://github.githubassets.com/images/icons/emoji/unicode/2638.png?v8\",\"wheelchair\":\"https://github.githubassets.com/images/icons/emoji/unicode/267f.png?v8\",\"white_check_mark\":\"https://github.githubassets.com/images/icons/emoji/unicode/2705.png?v8\",\"white_circle\":\"https://github.githubassets.com/images/icons/emoji/unicode/26aa.png?v8\",\"white_flag\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f3.png?v8\",\"white_flower\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ae.png?v8\",\"white_haired_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b3.png?v8\",\"white_haired_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b3.png?v8\",\"white_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f90d.png?v8\",\"white_large_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/2b1c.png?v8\",\"white_medium_small_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/25fd.png?v8\",\"white_medium_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/25fb.png?v8\",\"white_small_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/25ab.png?v8\",\"white_square_button\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f533.png?v8\",\"wilted_flower\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f940.png?v8\",\"wind_chime\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f390.png?v8\",\"wind_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f32c.png?v8\",\"window\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa9f.png?v8\",\"wine_glass\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f377.png?v8\",\"wink\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f609.png?v8\",\"wolf\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f43a.png?v8\",\"woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469.png?v8\",\"woman_artist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3a8.png?v8\",\"woman_astronaut\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f680.png?v8\",\"woman_beard\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d4-2640.png?v8\",\"woman_cartwheeling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f938-2640.png?v8\",\"woman_cook\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f373.png?v8\",\"woman_dancing\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f483.png?v8\",\"woman_facepalming\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f926-2640.png?v8\",\"woman_factory_worker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3ed.png?v8\",\"woman_farmer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f33e.png?v8\",\"woman_feeding_baby\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f37c.png?v8\",\"woman_firefighter\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f692.png?v8\",\"woman_health_worker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-2695.png?v8\",\"woman_in_manual_wheelchair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9bd.png?v8\",\"woman_in_motorized_wheelchair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9bc.png?v8\",\"woman_in_tuxedo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f935-2640.png?v8\",\"woman_judge\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-2696.png?v8\",\"woman_juggling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f939-2640.png?v8\",\"woman_mechanic\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f527.png?v8\",\"woman_office_worker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f4bc.png?v8\",\"woman_pilot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-2708.png?v8\",\"woman_playing_handball\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93e-2640.png?v8\",\"woman_playing_water_polo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93d-2640.png?v8\",\"woman_scientist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f52c.png?v8\",\"woman_shrugging\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f937-2640.png?v8\",\"woman_singer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3a4.png?v8\",\"woman_student\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f393.png?v8\",\"woman_teacher\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3eb.png?v8\",\"woman_technologist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f4bb.png?v8\",\"woman_with_headscarf\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d5.png?v8\",\"woman_with_probing_cane\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9af.png?v8\",\"woman_with_turban\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f473-2640.png?v8\",\"woman_with_veil\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f470-2640.png?v8\",\"womans_clothes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f45a.png?v8\",\"womans_hat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f452.png?v8\",\"women_wrestling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93c-2640.png?v8\",\"womens\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6ba.png?v8\",\"wood\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fab5.png?v8\",\"woozy_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f974.png?v8\",\"world_map\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5fa.png?v8\",\"worm\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fab1.png?v8\",\"worried\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f61f.png?v8\",\"wrench\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f527.png?v8\",\"wrestling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93c.png?v8\",\"writing_hand\":\"https://github.githubassets.com/images/icons/emoji/unicode/270d.png?v8\",\"x\":\"https://github.githubassets.com/images/icons/emoji/unicode/274c.png?v8\",\"yarn\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9f6.png?v8\",\"yawning_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f971.png?v8\",\"yellow_circle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7e1.png?v8\",\"yellow_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f49b.png?v8\",\"yellow_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7e8.png?v8\",\"yemen\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fe-1f1ea.png?v8\",\"yen\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4b4.png?v8\",\"yin_yang\":\"https://github.githubassets.com/images/icons/emoji/unicode/262f.png?v8\",\"yo_yo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa80.png?v8\",\"yum\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f60b.png?v8\",\"zambia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1f2.png?v8\",\"zany_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f92a.png?v8\",\"zap\":\"https://github.githubassets.com/images/icons/emoji/unicode/26a1.png?v8\",\"zebra\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f993.png?v8\",\"zero\":\"https://github.githubassets.com/images/icons/emoji/unicode/0030-20e3.png?v8\",\"zimbabwe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1fc.png?v8\",\"zipper_mouth_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f910.png?v8\",\"zombie\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9df.png?v8\",\"zombie_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2642.png?v8\",\"zombie_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2640.png?v8\",\"zzz\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a4.png?v8\"}" } ] }, @@ -12969,22 +17965,22 @@ "renamed": null }, { - "name": "Get a code of conduct", - "scope": "codesOfConduct", - "id": "getConductCode", - "method": "GET", - "url": "/codes_of_conduct/{key}", + "name": "Add custom labels to a self-hosted runner for an enterprise", + "scope": "enterpriseAdmin", + "id": "addCustomLabelsToSelfHostedRunnerForEnterprise", + "method": "POST", + "url": "/enterprises/{enterprise}/actions/runners/{runner_id}/labels", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/codes-of-conduct#get-a-code-of-conduct", + "description": "Add custom labels 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.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise", "previews": [], "headers": [], "parameters": [ { - "name": "key", - "description": "", + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "PATH", "type": "string", "required": true, @@ -12994,42 +17990,12 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"key\":\"contributor_covenant\",\"name\":\"Contributor Covenant\",\"url\":\"https://api.github.com/codes_of_conduct/contributor_covenant\",\"body\":\"# Contributor Covenant Code of Conduct\\n\\n## Our Pledge\\n\\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\\n\\n## Our Standards\\n\\nExamples of behavior that contributes to creating a positive environment include:\\n\\n* Using welcoming and inclusive language\\n* Being respectful of differing viewpoints and experiences\\n* Gracefully accepting constructive criticism\\n* Focusing on what is best for the community\\n* Showing empathy towards other community members\\n\\nExamples of unacceptable behavior by participants include:\\n\\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\\n* Trolling, insulting/derogatory comments, and personal or political attacks\\n* Public or private harassment\\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\\n* Other conduct which could reasonably be considered inappropriate in a professional setting\\n\\n## Our Responsibilities\\n\\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\\n to any instances of unacceptable behavior.\\n\\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\\n\\n## Scope\\n\\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\\n\\n## Enforcement\\n\\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\\n\\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\\n\\n## Attribution\\n\\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\\n\\n[homepage]: http://contributor-covenant.org\\n[version]: http://contributor-covenant.org/version/1/4/\\n\",\"html_url\":\"http://contributor-covenant.org/version/1/4/\"}" - } - ] }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get the code of conduct for a repository", - "scope": "codesOfConduct", - "id": "getForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/community/code_of_conduct", - "isDeprecated": true, - "deprecationDate": "2021-09-29", - "removalDate": "2021-09-29", - "description": "Returns the contents of the repository's code of conduct file, if one is detected.\n\nA code of conduct is detected if there is a file named `CODE_OF_CONDUCT` in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching.", - "documentationUrl": "https://docs.github.com/rest/reference/codes-of-conduct#get-the-code-of-conduct-for-a-repository", - "previews": [{ "name": "scarlet-witch" }], - "headers": [], - "parameters": [ { - "name": "owner", - "description": "", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -13039,10 +18005,10 @@ "deprecated": null }, { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", + "name": "labels", + "description": "The names of the custom labels to add to the runner.", + "in": "BODY", + "type": "string[]", "required": true, "enum": null, "allowNull": false, @@ -13058,30 +18024,12 @@ "description": "Response", "examples": [ { - "data": "{\"key\":\"contributor_covenant\",\"name\":\"Contributor Covenant\",\"url\":\"https://github.com/LindseyB/cosee/blob/master/CODE_OF_CONDUCT.md\",\"body\":\"# Contributor Covenant Code of Conduct\\n\\n## Our Pledge\\n\\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\\n\\n## Our Standards\\n\\nExamples of behavior that contributes to creating a positive environment include:\\n\\n* Using welcoming and inclusive language\\n* Being respectful of differing viewpoints and experiences\\n* Gracefully accepting constructive criticism\\n* Focusing on what is best for the community\\n* Showing empathy towards other community members\\n\\nExamples of unacceptable behavior by participants include:\\n\\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\\n* Trolling, insulting/derogatory comments, and personal or political attacks\\n* Public or private harassment\\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\\n* Other conduct which could reasonably be considered inappropriate in a professional setting\\n\\n## Our Responsibilities\\n\\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\\nto any instances of unacceptable behavior.\\n\\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\\n\\n## Scope\\n\\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\\nposting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\\n\\n## Enforcement\\n\\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at lindseyb@github.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\\n\\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\\n\\n## Attribution\\n\\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\\n\\n[homepage]: http://contributor-covenant.org\\n[version]: http://contributor-covenant.org/version/1/4/\\n\",\"html_url\":\"https://github.com/LindseyB/cosee/blob/master/CODE_OF_CONDUCT.md\"}" + "data": "{\"total_count\":4,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" } ] - } - ], - "renamed": null - }, - { - "name": "Get emojis", - "scope": "emojis", - "id": "get", - "method": "GET", - "url": "/emojis", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Lists all the emojis available to use on GitHub.", - "documentationUrl": "https://docs.github.com/rest/reference/emojis#get-emojis", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { "code": 200, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null } + }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 422, "description": "Validation failed", "examples": null } ], "renamed": null }, @@ -13095,7 +18043,7 @@ "deprecationDate": null, "removalDate": null, "description": "Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/enterprise-admin#disable-a-selected-organization-for-github-actions-in-an-enterprise", + "documentationUrl": "https://docs.github.com/rest/reference/actions#disable-a-selected-organization-for-github-actions-in-an-enterprise", "previews": [], "headers": [], "parameters": [ @@ -13114,7 +18062,7 @@ }, { "name": "org_id", - "description": "Unique identifier of an organization.", + "description": "The unique identifier of the organization.", "in": "PATH", "type": "integer", "required": true, @@ -13139,7 +18087,7 @@ "deprecationDate": null, "removalDate": null, "description": "Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/enterprise-admin#enable-a-selected-organization-for-github-actions-in-an-enterprise", + "documentationUrl": "https://docs.github.com/rest/reference/actions#enable-a-selected-organization-for-github-actions-in-an-enterprise", "previews": [], "headers": [], "parameters": [ @@ -13158,7 +18106,7 @@ }, { "name": "org_id", - "description": "Unique identifier of an organization.", + "description": "The unique identifier of the organization.", "in": "PATH", "type": "integer", "required": true, @@ -13174,7 +18122,7 @@ "renamed": null }, { - "name": "Get allowed actions for an enterprise", + "name": "Get allowed actions and reusable workflows for an enterprise", "scope": "enterpriseAdmin", "id": "getAllowedActionsEnterprise", "method": "GET", @@ -13182,8 +18130,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/enterprise-admin#get-allowed-actions-for-an-enterprise", + "description": "Gets the selected actions and reusable workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#get-allowed-actions-for-an-enterprise", "previews": [], "headers": [], "parameters": [ @@ -13223,8 +18171,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/enterprise-admin#get-github-actions-permissions-for-an-enterprise", + "description": "Gets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#get-github-actions-permissions-for-an-enterprise", "previews": [], "headers": [], "parameters": [ @@ -13255,6 +18203,128 @@ ], "renamed": null }, + { + "name": "Get GitHub Enterprise Server statistics", + "scope": "enterpriseAdmin", + "id": "getServerStatistics", + "method": "GET", + "url": "/enterprise-installation/{enterprise_or_org}/server-statistics", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Returns aggregate usage metrics for your GitHub Enterprise Server 3.5+ instance for a specified time period up to 365 days.\n\nTo use this endpoint, your GitHub Enterprise Server instance must be connected to GitHub Enterprise Cloud using GitHub Connect. You must enable Server Statistics, and for the API request provide your enterprise account name or organization name connected to the GitHub Enterprise Server. For more information, see \"[Enabling Server Statistics for your enterprise](/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise)\" in the GitHub Enterprise Server documentation.\n\nYou'll need to use a personal access token:\n - If you connected your GitHub Enterprise Server to an enterprise account and enabled Server Statistics, you'll need a personal access token with the `read:enterprise` permission.\n - If you connected your GitHub Enterprise Server to an organization account and enabled Server Statistics, you'll need a personal access token with the `read:org` permission.\n\nFor more information on creating a personal access token, see \"[Creating a personal access token](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"", + "documentationUrl": "https://docs.github.com/rest/reference/enterprise-admin#get-github-enterprise-server-statistics", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "enterprise_or_org", + "description": "The slug version of the enterprise name or the login of an organization.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "date_start", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "date_end", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"server_id\":\"ea6088f3-f095-4bf2-8d7f-c573819e8768\",\"collection_date\":\"2021-12-14T23:59:59Z\",\"schema_version\":\"20220111\",\"ghes_version\":\"3.5.0\",\"host_name\":\"github.example.com\",\"github_connect\":{\"features_enabled\":[\"license_usage_sync\",\"content_analysis\",\"content_analysis_notifications\"]},\"ghe_stats\":{\"comments\":{\"total_commit_comments\":1000,\"total_gist_comments\":1000,\"total_issue_comments\":0,\"total_pull_request_comments\":0},\"gists\":{\"total_gists\":100,\"private_gists\":59,\"public_gists\":41},\"hooks\":{\"total_hooks\":2,\"active_hooks\":1,\"inactive_hooks\":1},\"issues\":{\"total_issues\":3421,\"open_issues\":1234,\"closed_issues\":1222},\"milestones\":{\"total_milestones\":50,\"open_milestones\":20,\"closed_milestones\":30},\"orgs\":{\"total_orgs\":100,\"disabled_orgs\":22,\"total_teams\":299,\"total_team_members\":400},\"pages\":{\"total_pages\":10},\"pulls\":{\"total_pulls\":1232,\"merged_pulls\":223,\"mergeable_pulls\":435,\"unmergeable_pulls\":0},\"repos\":{\"total_repos\":12,\"root_repos\":1,\"fork_repos\":2,\"org_repos\":1,\"total_pushes\":42,\"total_wikis\":1},\"users\":{\"total_users\":2000,\"admin_users\":299,\"suspended_users\":423}},\"dormant_users\":{\"total_dormant_users\":5,\"dormancy_threshold\":\"90 days\"}}" + } + ] + } + ], + "renamed": null + }, + { + "name": "List labels for a self-hosted runner for an enterprise", + "scope": "enterpriseAdmin", + "id": "listLabelsForSelfHostedRunnerForEnterprise", + "method": "GET", + "url": "/enterprises/{enterprise}/actions/runners/{runner_id}/labels", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists all labels for 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.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-an-enterprise", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_count\":4,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" + } + ] + }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, { "name": "List selected organizations enabled for GitHub Actions in an enterprise", "scope": "enterpriseAdmin", @@ -13265,7 +18335,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/enterprise-admin#list-selected-organizations-enabled-for-github-actions-in-an-enterprise", + "documentationUrl": "https://docs.github.com/rest/reference/actions#list-selected-organizations-enabled-for-github-actions-in-an-enterprise", "previews": [], "headers": [], "parameters": [ @@ -13284,7 +18354,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -13323,7 +18393,132 @@ "renamed": null }, { - "name": "Set allowed actions for an enterprise", + "name": "Remove all custom labels from a self-hosted runner for an enterprise", + "scope": "enterpriseAdmin", + "id": "removeAllCustomLabelsFromSelfHostedRunnerForEnterprise", + "method": "DELETE", + "url": "/enterprises/{enterprise}/actions/runners/{runner_id}/labels", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Remove all custom labels from a self-hosted runner configured in an\nenterprise. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_count\":3,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"}]}" + } + ] + }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 422, "description": "Validation failed", "examples": null } + ], + "renamed": null + }, + { + "name": "Remove a custom label from a self-hosted runner for an enterprise", + "scope": "enterpriseAdmin", + "id": "removeCustomLabelFromSelfHostedRunnerForEnterprise", + "method": "DELETE", + "url": "/enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Remove a custom label from a self-hosted runner configured\nin an enterprise. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "name", + "description": "The name of a self-hosted runner's custom label.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_count\":4,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" + } + ] + }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 422, "description": "Validation failed", "examples": null } + ], + "renamed": null + }, + { + "name": "Set allowed actions and reusable workflows for an enterprise", "scope": "enterpriseAdmin", "id": "setAllowedActionsEnterprise", "method": "PUT", @@ -13331,8 +18526,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/enterprise-admin#set-allowed-actions-for-an-enterprise", + "description": "Sets the actions and reusable workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#set-allowed-actions-for-an-enterprise", "previews": [], "headers": [], "parameters": [ @@ -13364,7 +18559,7 @@ }, { "name": "verified_allowed", - "description": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators.", + "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators.", "in": "BODY", "type": "boolean", "required": false, @@ -13377,7 +18572,7 @@ }, { "name": "patterns_allowed", - "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", "in": "BODY", "type": "string[]", "required": false, @@ -13392,6 +18587,75 @@ "responses": [{ "code": 204, "description": "Response", "examples": null }], "renamed": null }, + { + "name": "Set custom labels for a self-hosted runner for an enterprise", + "scope": "enterpriseAdmin", + "id": "setCustomLabelsForSelfHostedRunnerForEnterprise", + "method": "PUT", + "url": "/enterprises/{enterprise}/actions/runners/{runner_id}/labels", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "labels", + "description": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.", + "in": "BODY", + "type": "string[]", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_count\":4,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" + } + ] + }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 422, "description": "Validation failed", "examples": null } + ], + "renamed": null + }, { "name": "Set GitHub Actions permissions for an enterprise", "scope": "enterpriseAdmin", @@ -13401,8 +18665,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/enterprise-admin#set-github-actions-permissions-for-an-enterprise", + "description": "Sets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/actions#set-github-actions-permissions-for-an-enterprise", "previews": [], "headers": [], "parameters": [ @@ -13421,7 +18685,7 @@ }, { "name": "enabled_organizations", - "description": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.", + "description": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions.", "in": "BODY", "type": "string", "required": true, @@ -13434,7 +18698,7 @@ }, { "name": "allowed_actions", - "description": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", + "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", "in": "BODY", "type": "string", "required": false, @@ -13459,7 +18723,7 @@ "deprecationDate": null, "removalDate": null, "description": "Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/enterprise-admin#set-selected-organizations-enabled-for-github-actions-in-an-enterprise", + "documentationUrl": "https://docs.github.com/rest/reference/actions#set-selected-organizations-enabled-for-github-actions-in-an-enterprise", "previews": [], "headers": [], "parameters": [ @@ -13509,7 +18773,7 @@ "parameters": [ { "name": "gist_id", - "description": "gist_id parameter", + "description": "The unique identifier of the gist.", "in": "PATH", "type": "string", "required": true, @@ -13650,7 +18914,7 @@ "parameters": [ { "name": "gist_id", - "description": "gist_id parameter", + "description": "The unique identifier of the gist.", "in": "PATH", "type": "string", "required": true, @@ -13707,7 +18971,7 @@ "parameters": [ { "name": "gist_id", - "description": "gist_id parameter", + "description": "The unique identifier of the gist.", "in": "PATH", "type": "string", "required": true, @@ -13743,7 +19007,7 @@ "parameters": [ { "name": "gist_id", - "description": "gist_id parameter", + "description": "The unique identifier of the gist.", "in": "PATH", "type": "string", "required": true, @@ -13756,7 +19020,7 @@ }, { "name": "comment_id", - "description": "comment_id parameter", + "description": "The unique identifier of the comment.", "in": "PATH", "type": "integer", "required": true, @@ -13792,7 +19056,7 @@ "parameters": [ { "name": "gist_id", - "description": "gist_id parameter", + "description": "The unique identifier of the gist.", "in": "PATH", "type": "string", "required": true, @@ -13837,7 +19101,7 @@ "parameters": [ { "name": "gist_id", - "description": "gist_id parameter", + "description": "The unique identifier of the gist.", "in": "PATH", "type": "string", "required": true, @@ -13881,7 +19145,7 @@ "parameters": [ { "name": "gist_id", - "description": "gist_id parameter", + "description": "The unique identifier of the gist.", "in": "PATH", "type": "string", "required": true, @@ -13894,7 +19158,7 @@ }, { "name": "comment_id", - "description": "comment_id parameter", + "description": "The unique identifier of the comment.", "in": "PATH", "type": "integer", "required": true, @@ -13938,7 +19202,7 @@ "parameters": [ { "name": "gist_id", - "description": "gist_id parameter", + "description": "The unique identifier of the gist.", "in": "PATH", "type": "string", "required": true, @@ -14008,7 +19272,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -14064,7 +19328,7 @@ "parameters": [ { "name": "gist_id", - "description": "gist_id parameter", + "description": "The unique identifier of the gist.", "in": "PATH", "type": "string", "required": true, @@ -14077,7 +19341,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -14134,7 +19398,7 @@ "parameters": [ { "name": "gist_id", - "description": "gist_id parameter", + "description": "The unique identifier of the gist.", "in": "PATH", "type": "string", "required": true, @@ -14147,7 +19411,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -14204,7 +19468,7 @@ "parameters": [ { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -14230,7 +19494,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -14285,7 +19549,7 @@ "parameters": [ { "name": "gist_id", - "description": "gist_id parameter", + "description": "The unique identifier of the gist.", "in": "PATH", "type": "string", "required": true, @@ -14298,7 +19562,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -14368,7 +19632,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -14438,7 +19702,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -14499,7 +19763,7 @@ "parameters": [ { "name": "gist_id", - "description": "gist_id parameter", + "description": "The unique identifier of the gist.", "in": "PATH", "type": "string", "required": true, @@ -14535,7 +19799,7 @@ "parameters": [ { "name": "gist_id", - "description": "gist_id parameter", + "description": "The unique identifier of the gist.", "in": "PATH", "type": "string", "required": true, @@ -14571,7 +19835,7 @@ "parameters": [ { "name": "gist_id", - "description": "gist_id parameter", + "description": "The unique identifier of the gist.", "in": "PATH", "type": "string", "required": true, @@ -14679,7 +19943,7 @@ "parameters": [ { "name": "gist_id", - "description": "gist_id parameter", + "description": "The unique identifier of the gist.", "in": "PATH", "type": "string", "required": true, @@ -14692,7 +19956,7 @@ }, { "name": "comment_id", - "description": "comment_id parameter", + "description": "The unique identifier of the comment.", "in": "PATH", "type": "integer", "required": true, @@ -14747,7 +20011,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -14760,7 +20024,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -14824,14 +20088,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "documentationUrl": "https://docs.github.com/rest/reference/git#create-a-commit", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -14844,7 +20108,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -15043,7 +20307,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -15056,7 +20320,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -15137,7 +20401,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -15150,7 +20414,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -15296,7 +20560,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -15309,7 +20573,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -15444,7 +20708,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -15457,7 +20721,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -15504,7 +20768,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -15517,7 +20781,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -15567,14 +20831,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "documentationUrl": "https://docs.github.com/rest/reference/git#get-a-commit", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -15587,7 +20851,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -15600,7 +20864,7 @@ }, { "name": "commit_sha", - "description": "commit_sha parameter", + "description": "The SHA of the commit.", "in": "PATH", "type": "string", "required": true, @@ -15642,7 +20906,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -15655,7 +20919,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -15710,7 +20974,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -15723,7 +20987,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -15778,7 +21042,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -15791,7 +21055,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -15863,7 +21127,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -15876,7 +21140,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -15902,7 +21166,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -15956,7 +21220,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -15969,7 +21233,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -16152,7 +21416,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -16193,7 +21457,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -16206,7 +21470,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -16307,7 +21571,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -16338,7 +21602,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -16351,7 +21615,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -16413,7 +21677,7 @@ "parameters": [ { "name": "limit", - "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Can be one of: `existing_users`, `contributors_only`, `collaborators_only`.", + "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", "in": "BODY", "type": "string", "required": true, @@ -16426,7 +21690,7 @@ }, { "name": "expiry", - "description": "The duration of the interaction restriction. Can be one of: `one_day`, `three_days`, `one_week`, `one_month`, `six_months`. Default: `one_day`.", + "description": "The duration of the interaction restriction. Default: `one_day`.", "in": "BODY", "type": "string", "required": false, @@ -16474,7 +21738,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -16487,7 +21751,7 @@ }, { "name": "limit", - "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Can be one of: `existing_users`, `contributors_only`, `collaborators_only`.", + "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", "in": "BODY", "type": "string", "required": true, @@ -16500,7 +21764,7 @@ }, { "name": "expiry", - "description": "The duration of the interaction restriction. Can be one of: `one_day`, `three_days`, `one_week`, `one_month`, `six_months`. Default: `one_day`.", + "description": "The duration of the interaction restriction. Default: `one_day`.", "in": "BODY", "type": "string", "required": false, @@ -16548,7 +21812,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -16561,7 +21825,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -16574,7 +21838,7 @@ }, { "name": "limit", - "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Can be one of: `existing_users`, `contributors_only`, `collaborators_only`.", + "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", "in": "BODY", "type": "string", "required": true, @@ -16587,7 +21851,7 @@ }, { "name": "expiry", - "description": "The duration of the interaction restriction. Can be one of: `one_day`, `three_days`, `one_week`, `one_month`, `six_months`. Default: `one_day`.", + "description": "The duration of the interaction restriction. Default: `one_day`.", "in": "BODY", "type": "string", "required": false, @@ -16635,7 +21899,7 @@ "parameters": [ { "name": "limit", - "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Can be one of: `existing_users`, `contributors_only`, `collaborators_only`.", + "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", "in": "BODY", "type": "string", "required": true, @@ -16648,7 +21912,7 @@ }, { "name": "expiry", - "description": "The duration of the interaction restriction. Can be one of: `one_day`, `three_days`, `one_week`, `one_month`, `six_months`. Default: `one_day`.", + "description": "The duration of the interaction restriction. Default: `one_day`.", "in": "BODY", "type": "string", "required": false, @@ -16707,7 +21971,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -16720,7 +21984,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -16733,7 +21997,7 @@ }, { "name": "issue_number", - "description": "issue_number parameter", + "description": "The number that identifies the issue.", "in": "PATH", "type": "integer", "required": true, @@ -16787,7 +22051,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -16800,7 +22064,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -16813,7 +22077,7 @@ }, { "name": "issue_number", - "description": "issue_number parameter", + "description": "The number that identifies the issue.", "in": "PATH", "type": "integer", "required": true, @@ -16882,7 +22146,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -16895,7 +22159,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -16943,14 +22207,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/rest/reference/issues#create-an-issue", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -16963,7 +22227,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -17080,14 +22344,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", + "description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/rest/reference/issues#create-an-issue-comment", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -17100,7 +22364,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -17113,7 +22377,7 @@ }, { "name": "issue_number", - "description": "issue_number parameter", + "description": "The number that identifies the issue.", "in": "PATH", "type": "integer", "required": true, @@ -17171,7 +22435,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -17184,7 +22448,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -17223,7 +22487,7 @@ }, { "name": "description", - "description": "A short description of the label.", + "description": "A short description of the label. Must be 100 characters or fewer.", "in": "BODY", "type": "string", "required": false, @@ -17266,7 +22530,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -17279,7 +22543,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -17374,7 +22638,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -17387,7 +22651,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -17400,7 +22664,7 @@ }, { "name": "comment_id", - "description": "comment_id parameter", + "description": "The unique identifier of the comment.", "in": "PATH", "type": "integer", "required": true, @@ -17431,7 +22695,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -17444,7 +22708,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -17488,7 +22752,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -17501,7 +22765,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -17514,7 +22778,7 @@ }, { "name": "milestone_number", - "description": "milestone_number parameter", + "description": "The number that identifies the milestone.", "in": "PATH", "type": "integer", "required": true, @@ -17541,14 +22805,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was\n[transferred](https://help.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.", + "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was\n[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/issues#get-an-issue", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -17561,7 +22825,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -17574,7 +22838,7 @@ }, { "name": "issue_number", - "description": "issue_number parameter", + "description": "The number that identifies the issue.", "in": "PATH", "type": "integer", "required": true, @@ -17619,7 +22883,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -17632,7 +22896,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -17645,7 +22909,7 @@ }, { "name": "comment_id", - "description": "comment_id parameter", + "description": "The unique identifier of the comment.", "in": "PATH", "type": "integer", "required": true, @@ -17687,7 +22951,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -17700,7 +22964,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -17757,7 +23021,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -17770,7 +23034,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -17825,7 +23089,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -17838,7 +23102,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -17851,7 +23115,7 @@ }, { "name": "milestone_number", - "description": "milestone_number parameter", + "description": "The number that identifies the milestone.", "in": "PATH", "type": "integer", "required": true, @@ -17893,7 +23157,7 @@ "parameters": [ { "name": "filter", - "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all` or `repos`: All issues the authenticated user can see, regardless of participation or creation", + "description": "Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation.", "in": "QUERY", "type": "string", "required": false, @@ -17952,7 +23216,7 @@ }, { "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", + "description": "The direction to sort the results by.", "in": "QUERY", "type": "string", "required": false, @@ -18030,7 +23294,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -18080,14 +23344,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the [available assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.", + "description": "Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.", "documentationUrl": "https://docs.github.com/rest/reference/issues#list-assignees", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -18100,7 +23364,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -18113,7 +23377,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -18168,7 +23432,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -18181,7 +23445,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -18194,7 +23458,7 @@ }, { "name": "issue_number", - "description": "issue_number parameter", + "description": "The number that identifies the issue.", "in": "PATH", "type": "integer", "required": true, @@ -18220,7 +23484,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -18276,7 +23540,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -18289,7 +23553,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -18302,7 +23566,7 @@ }, { "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", + "description": "The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to.", "in": "QUERY", "type": "string", "required": false, @@ -18341,7 +23605,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -18397,7 +23661,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -18410,7 +23674,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -18423,7 +23687,7 @@ }, { "name": "issue_number", - "description": "issue_number parameter", + "description": "The number that identifies the issue.", "in": "PATH", "type": "integer", "required": true, @@ -18436,7 +23700,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -18491,7 +23755,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -18504,7 +23768,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -18517,7 +23781,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -18572,7 +23836,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -18585,7 +23849,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -18598,7 +23862,7 @@ }, { "name": "issue_number", - "description": "issue_number parameter", + "description": "The number that identifies the issue.", "in": "PATH", "type": "integer", "required": true, @@ -18611,7 +23875,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -18637,7 +23901,15 @@ } ], "responses": [ - { "code": 200, "description": "Response", "examples": null }, + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"id\":6430295168,\"node_id\":\"LOE_lADODwFebM5HwC0kzwAAAAF_RoSA\",\"url\":\"https://api.github.com/repos/github/roadmap/issues/events/6430295168\",\"actor\":{\"login\":\"github\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"event\":\"locked\",\"commit_id\":null,\"commit_url\":null,\"created_at\":\"2022-04-13T20:49:13Z\",\"lock_reason\":null,\"performed_via_github_app\":null},{\"id\":6430296748,\"node_id\":\"LE_lADODwFebM5HwC0kzwAAAAF_Roqs\",\"url\":\"https://api.github.com/repos/github/roadmap/issues/events/6430296748\",\"actor\":{\"login\":\"github-product-roadmap\",\"id\":67656570,\"node_id\":\"MDQ6VXNlcjY3NjU2NTcw\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/67656570?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/github-product-roadmap\",\"html_url\":\"https://github.com/github-product-roadmap\",\"followers_url\":\"https://api.github.com/users/github-product-roadmap/followers\",\"following_url\":\"https://api.github.com/users/github-product-roadmap/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github-product-roadmap/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github-product-roadmap/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github-product-roadmap/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github-product-roadmap/orgs\",\"repos_url\":\"https://api.github.com/users/github-product-roadmap/repos\",\"events_url\":\"https://api.github.com/users/github-product-roadmap/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github-product-roadmap/received_events\",\"type\":\"User\",\"site_admin\":false},\"event\":\"labeled\",\"commit_id\":null,\"commit_url\":null,\"created_at\":\"2022-04-13T20:49:34Z\",\"label\":{\"name\":\"beta\",\"color\":\"99dd88\"},\"performed_via_github_app\":null},{\"id\":6635165802,\"node_id\":\"RTE_lADODwFebM5HwC0kzwAAAAGLfJhq\",\"url\":\"https://api.github.com/repos/github/roadmap/issues/events/6635165802\",\"actor\":{\"login\":\"github-product-roadmap\",\"id\":67656570,\"node_id\":\"MDQ6VXNlcjY3NjU2NTcw\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/67656570?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/github-product-roadmap\",\"html_url\":\"https://github.com/github-product-roadmap\",\"followers_url\":\"https://api.github.com/users/github-product-roadmap/followers\",\"following_url\":\"https://api.github.com/users/github-product-roadmap/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github-product-roadmap/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github-product-roadmap/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github-product-roadmap/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github-product-roadmap/orgs\",\"repos_url\":\"https://api.github.com/users/github-product-roadmap/repos\",\"events_url\":\"https://api.github.com/users/github-product-roadmap/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github-product-roadmap/received_events\",\"type\":\"User\",\"site_admin\":false},\"event\":\"renamed\",\"commit_id\":null,\"commit_url\":null,\"created_at\":\"2022-05-18T19:29:01Z\",\"rename\":{\"from\":\"Secret scanning: dry-runs for enterprise-level custom patterns (cloud)\",\"to\":\"Secret scanning: dry-runs for enterprise-level custom patterns\"},\"performed_via_github_app\":null},{\"url\":\"https://api.github.com/repos/github/roadmap/issues/comments/1130876857\",\"html_url\":\"https://github.com/github/roadmap/issues/493#issuecomment-1130876857\",\"issue_url\":\"https://api.github.com/repos/github/roadmap/issues/493\",\"id\":1130876857,\"node_id\":\"IC_kwDODwFebM5DZ8-5\",\"user\":{\"login\":\"octocat\",\"id\":94867353,\"node_id\":\"U_kgDOBaePmQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/94867353?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"created_at\":\"2022-05-19T00:52:15Z\",\"updated_at\":\"2022-05-19T00:52:15Z\",\"author_association\":\"COLLABORATOR\",\"body\":\"🚢 Shipped to the cloud: https://github.blog/changelog/2022-05-12-secret-scanning-dry-runs-for-enterprise-level-custom-patterns/\",\"reactions\":{\"url\":\"https://api.github.com/repos/github/roadmap/issues/comments/1130876857/reactions\",\"total_count\":0,\"+1\":0,\"-1\":0,\"laugh\":0,\"hooray\":0,\"confused\":0,\"heart\":0,\"rocket\":0,\"eyes\":0},\"performed_via_github_app\":null,\"event\":\"commented\",\"actor\":{\"login\":\"octocat\",\"id\":94867353,\"node_id\":\"U_kgDOBaePmQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/94867353?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true}}]" + } + ] + }, { "code": 404, "description": "Resource not found", "examples": null }, { "code": 410, "description": "Gone", "examples": null } ], @@ -18659,7 +23931,7 @@ "parameters": [ { "name": "filter", - "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all` or `repos`: All issues the authenticated user can see, regardless of participation or creation", + "description": "Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation.", "in": "QUERY", "type": "string", "required": false, @@ -18718,7 +23990,7 @@ }, { "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", + "description": "The direction to sort the results by.", "in": "QUERY", "type": "string", "required": false, @@ -18744,7 +24016,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -18800,7 +24072,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -18813,7 +24085,7 @@ }, { "name": "filter", - "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all` or `repos`: All issues the authenticated user can see, regardless of participation or creation", + "description": "Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation.", "in": "QUERY", "type": "string", "required": false, @@ -18872,7 +24144,7 @@ }, { "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", + "description": "The direction to sort the results by.", "in": "QUERY", "type": "string", "required": false, @@ -18898,7 +24170,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -18953,7 +24225,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -18966,7 +24238,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -19070,7 +24342,7 @@ }, { "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", + "description": "The direction to sort the results by.", "in": "QUERY", "type": "string", "required": false, @@ -19096,7 +24368,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -19153,7 +24425,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -19166,7 +24438,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -19179,7 +24451,7 @@ }, { "name": "milestone_number", - "description": "milestone_number parameter", + "description": "The number that identifies the milestone.", "in": "PATH", "type": "integer", "required": true, @@ -19192,7 +24464,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -19246,7 +24518,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -19259,7 +24531,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -19272,7 +24544,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -19327,7 +24599,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -19340,7 +24612,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -19353,7 +24625,7 @@ }, { "name": "issue_number", - "description": "issue_number parameter", + "description": "The number that identifies the issue.", "in": "PATH", "type": "integer", "required": true, @@ -19366,7 +24638,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -19421,7 +24693,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -19434,7 +24706,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -19486,7 +24758,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -19541,7 +24813,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -19554,7 +24826,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -19567,7 +24839,7 @@ }, { "name": "issue_number", - "description": "issue_number parameter", + "description": "The number that identifies the issue.", "in": "PATH", "type": "integer", "required": true, @@ -19617,7 +24889,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -19630,7 +24902,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -19643,7 +24915,7 @@ }, { "name": "issue_number", - "description": "issue_number parameter", + "description": "The number that identifies the issue.", "in": "PATH", "type": "integer", "required": true, @@ -19677,7 +24949,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -19690,7 +24962,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -19703,7 +24975,7 @@ }, { "name": "issue_number", - "description": "issue_number parameter", + "description": "The number that identifies the issue.", "in": "PATH", "type": "integer", "required": true, @@ -19757,7 +25029,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -19770,7 +25042,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -19783,7 +25055,7 @@ }, { "name": "issue_number", - "description": "issue_number parameter", + "description": "The number that identifies the issue.", "in": "PATH", "type": "integer", "required": true, @@ -19839,7 +25111,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -19852,7 +25124,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -19865,7 +25137,7 @@ }, { "name": "issue_number", - "description": "issue_number parameter", + "description": "The number that identifies the issue.", "in": "PATH", "type": "integer", "required": true, @@ -19934,7 +25206,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -19947,7 +25219,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -19960,7 +25232,7 @@ }, { "name": "issue_number", - "description": "issue_number parameter", + "description": "The number that identifies the issue.", "in": "PATH", "type": "integer", "required": true, @@ -19995,7 +25267,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -20008,7 +25280,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -20021,7 +25293,7 @@ }, { "name": "issue_number", - "description": "issue_number parameter", + "description": "The number that identifies the issue.", "in": "PATH", "type": "integer", "required": true, @@ -20159,7 +25431,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -20172,7 +25444,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -20185,7 +25457,7 @@ }, { "name": "comment_id", - "description": "comment_id parameter", + "description": "The unique identifier of the comment.", "in": "PATH", "type": "integer", "required": true, @@ -20240,7 +25512,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -20253,7 +25525,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -20305,7 +25577,7 @@ }, { "name": "description", - "description": "A short description of the label.", + "description": "A short description of the label. Must be 100 characters or fewer.", "in": "BODY", "type": "string", "required": false, @@ -20346,7 +25618,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -20359,7 +25631,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -20372,7 +25644,7 @@ }, { "name": "milestone_number", - "description": "milestone_number parameter", + "description": "The number that identifies the milestone.", "in": "PATH", "type": "integer", "required": true, @@ -20522,7 +25794,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -20577,7 +25849,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -20590,7 +25862,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -20644,7 +25916,7 @@ }, { "name": "mode", - "description": "The rendering mode.", + "description": "The rendering mode. Can be either `markdown` or `gfm`.", "in": "BODY", "type": "string", "required": false, @@ -20657,7 +25929,7 @@ }, { "name": "context", - "description": "The repository context to use when creating references in `gfm` mode.", + "description": "The repository context to use when creating references in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository.", "in": "BODY", "type": "string", "required": false, @@ -20724,7 +25996,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"[About GitHub's IP addresses](https://help.github.com/articles/about-github-s-ip-addresses/).\"\n\n**Note:** The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses.", + "description": "Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/).\"\n\n**Note:** The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses.", "documentationUrl": "https://docs.github.com/rest/reference/meta#get-github-meta-information", "previews": [], "headers": [], @@ -20735,7 +26007,7 @@ "description": "Response", "examples": [ { - "data": "{\"verifiable_password_authentication\":true,\"ssh_key_fingerprints\":{\"SHA256_RSA\":\"nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8\",\"SHA256_DSA\":\"br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ\",\"SHA256_ECDSA\":\"p2QAMXNIC1TJYWeIOttrVc98/R1BUFWu3/LiyKgUfQM\",\"SHA256_ED25519\":\"+DiY3wvvV6TuJJhbpZisF/zLDA0zPMSvHdkr4UvCOqU\"},\"hooks\":[\"192.30.252.0/22\"],\"web\":[\"192.30.252.0/22\",\"185.199.108.0/22\"],\"api\":[\"192.30.252.0/22\",\"185.199.108.0/22\"],\"git\":[\"192.30.252.0/22\"],\"packages\":[\"192.30.252.0/22\"],\"pages\":[\"192.30.252.153/32\",\"192.30.252.154/32\"],\"importer\":[\"54.158.161.132\",\"54.226.70.38\"],\"actions\":[\"13.64.0.0/16\",\"13.65.0.0/16\"],\"dependabot\":[\"54.158.161.132\"]}" + "data": "{\"verifiable_password_authentication\":true,\"ssh_key_fingerprints\":{\"SHA256_RSA\":\"nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8\",\"SHA256_DSA\":\"br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ\",\"SHA256_ECDSA\":\"p2QAMXNIC1TJYWeIOttrVc98/R1BUFWu3/LiyKgUfQM\",\"SHA256_ED25519\":\"+DiY3wvvV6TuJJhbpZisF/zLDA0zPMSvHdkr4UvCOqU\"},\"ssh_keys\":[\"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIOMqqnkVzrm0SdG6UOoqKLsabgH5C9okWi0dh2l9GKJl\",\"ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBEmKSENjQEezOmxkZMy7opKgwFB9nkt5YRrYMjNuG5N87uRgg6CLrbo5wAdT/y6v0mKV0U2w0WZ2YB/++Tpockg=\",\"ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ==\"],\"hooks\":[\"192.30.252.0/22\"],\"web\":[\"192.30.252.0/22\",\"185.199.108.0/22\"],\"api\":[\"192.30.252.0/22\",\"185.199.108.0/22\"],\"git\":[\"192.30.252.0/22\"],\"packages\":[\"192.30.252.0/22\"],\"pages\":[\"192.30.252.153/32\",\"192.30.252.154/32\"],\"importer\":[\"54.158.161.132\",\"54.226.70.38\"],\"actions\":[\"13.64.0.0/16\",\"13.65.0.0/16\"],\"dependabot\":[\"54.158.161.132\"]}" } ] }, @@ -20771,7 +26043,17 @@ "deprecated": null } ], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "\" MMM. .MMM\\n MMMMMMMMMMMMMMMMMMM\\n MMMMMMMMMMMMMMMMMMM ___________________________________\\n MMMMMMMMMMMMMMMMMMMMM | |\\n MMMMMMMMMMMMMMMMMMMMMMM | Avoid administrative distraction. |\\n MMMMMMMMMMMMMMMMMMMMMMMM |_ _______________________________|\\n MMMM::- -:::::::- -::MMMM |/\\n MM~:~ 00~:::::~ 00~:~MM\\n .. MMMMM::.00:::+:::.00::MMMMM ..\\n .MM::::: ._. :::::MM.\\n MMMM;:::::;MMMM\\n -MM MMMMMMM\\n ^ M+ MMMMMMMMM\\n MMMMMMM MM MM MM\\n MM MM MM MM\\n MM MM MM MM\\n .~~MM~MM~MM~MM~~.\\n ~~~~MM:~MM~~~MM~:MM~~~~\\n ~~~~~~==~==~~~==~==~~~~~~\\n ~~~~~~==~==~==~==~~~~~~\\n :~==~==~==~==~~\\n\"" + } + ] + } + ], "renamed": null }, { @@ -20805,7 +26087,17 @@ "previews": [], "headers": [], "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"current_user_url\":\"https://api.github.com/user\",\"current_user_authorizations_html_url\":\"https://github.com/settings/connections/applications{/client_id}\",\"authorizations_url\":\"https://api.github.com/authorizations\",\"code_search_url\":\"https://api.github.com/search/code?q={query}{&page,per_page,sort,order}\",\"commit_search_url\":\"https://api.github.com/search/commits?q={query}{&page,per_page,sort,order}\",\"emails_url\":\"https://api.github.com/user/emails\",\"emojis_url\":\"https://api.github.com/emojis\",\"events_url\":\"https://api.github.com/events\",\"feeds_url\":\"https://api.github.com/feeds\",\"followers_url\":\"https://api.github.com/user/followers\",\"following_url\":\"https://api.github.com/user/following{/target}\",\"gists_url\":\"https://api.github.com/gists{/gist_id}\",\"hub_url\":\"https://api.github.com/hub\",\"issue_search_url\":\"https://api.github.com/search/issues?q={query}{&page,per_page,sort,order}\",\"issues_url\":\"https://api.github.com/issues\",\"keys_url\":\"https://api.github.com/user/keys\",\"label_search_url\":\"https://api.github.com/search/labels?q={query}&repository_id={repository_id}{&page,per_page}\",\"notifications_url\":\"https://api.github.com/notifications\",\"organization_url\":\"https://api.github.com/orgs/{org}\",\"organization_repositories_url\":\"https://api.github.com/orgs/{org}/repos{?type,page,per_page,sort}\",\"organization_teams_url\":\"https://api.github.com/orgs/{org}/teams\",\"public_gists_url\":\"https://api.github.com/gists/public\",\"rate_limit_url\":\"https://api.github.com/rate_limit\",\"repository_url\":\"https://api.github.com/repos/{owner}/{repo}\",\"repository_search_url\":\"https://api.github.com/search/repositories?q={query}{&page,per_page,sort,order}\",\"current_user_repositories_url\":\"https://api.github.com/user/repos{?type,page,per_page,sort}\",\"starred_url\":\"https://api.github.com/user/starred{/owner}{/repo}\",\"starred_gists_url\":\"https://api.github.com/gists/starred\",\"topic_search_url\":\"https://api.github.com/search/topics?q={query}{&page,per_page}\",\"user_url\":\"https://api.github.com/users/{user}\",\"user_organizations_url\":\"https://api.github.com/user/orgs\",\"user_repositories_url\":\"https://api.github.com/users/{user}/repos{?type,page,per_page,sort}\",\"user_search_url\":\"https://api.github.com/search/users?q={query}{&page,per_page,sort,order}\"}" + } + ] + } + ], "renamed": null }, { @@ -20824,7 +26116,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -20837,7 +26129,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -20868,7 +26160,7 @@ "parameters": [ { "name": "migration_id", - "description": "migration_id parameter", + "description": "The unique identifier of the migration.", "in": "PATH", "type": "integer", "required": true, @@ -20909,7 +26201,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -20922,7 +26214,7 @@ }, { "name": "migration_id", - "description": "migration_id parameter", + "description": "The unique identifier of the migration.", "in": "PATH", "type": "integer", "required": true, @@ -20956,7 +26248,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -20969,7 +26261,7 @@ }, { "name": "migration_id", - "description": "migration_id parameter", + "description": "The unique identifier of the migration.", "in": "PATH", "type": "integer", "required": true, @@ -21003,7 +26295,7 @@ "parameters": [ { "name": "migration_id", - "description": "migration_id parameter", + "description": "The unique identifier of the migration.", "in": "PATH", "type": "integer", "required": true, @@ -21043,7 +26335,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -21056,7 +26348,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -21111,7 +26403,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -21124,7 +26416,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -21166,7 +26458,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -21179,7 +26471,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -21220,7 +26512,7 @@ "parameters": [ { "name": "migration_id", - "description": "migration_id parameter", + "description": "The unique identifier of the migration.", "in": "PATH", "type": "integer", "required": true, @@ -21251,7 +26543,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":79,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"state\":\"exported\",\"lock_repositories\":true,\"exclude_attachments\":false,\"exclude_releases\":false,\"exclude_owner_projects\":false,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}],\"url\":\"https://api.github.com/orgs/octo-org/migrations/79\",\"created_at\":\"2015-07-06T15:33:38-07:00\",\"updated_at\":\"2015-07-06T15:33:38-07:00\"}" + "data": "{\"id\":79,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"state\":\"exported\",\"lock_repositories\":true,\"exclude_attachments\":false,\"exclude_releases\":false,\"exclude_owner_projects\":false,\"org_metadata_only\":false,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}],\"url\":\"https://api.github.com/orgs/octo-org/migrations/79\",\"created_at\":\"2015-07-06T15:33:38-07:00\",\"updated_at\":\"2015-07-06T15:33:38-07:00\"}" } ] }, @@ -21282,7 +26574,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -21295,7 +26587,7 @@ }, { "name": "migration_id", - "description": "migration_id parameter", + "description": "The unique identifier of the migration.", "in": "PATH", "type": "integer", "required": true, @@ -21350,7 +26642,7 @@ "parameters": [ { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -21411,7 +26703,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -21424,7 +26716,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -21491,7 +26783,7 @@ "parameters": [ { "name": "migration_id", - "description": "migration_id parameter", + "description": "The unique identifier of the migration.", "in": "PATH", "type": "integer", "required": true, @@ -21504,7 +26796,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -21535,7 +26827,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" } ] }, @@ -21559,7 +26851,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -21572,7 +26864,7 @@ }, { "name": "migration_id", - "description": "migration_id parameter", + "description": "The unique identifier of the migration.", "in": "PATH", "type": "integer", "required": true, @@ -21585,7 +26877,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -21616,7 +26908,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" } ] }, @@ -21640,7 +26932,7 @@ "parameters": [ { "name": "migration_id", - "description": "migration_id parameter", + "description": "The unique identifier of the migration.", "in": "PATH", "type": "integer", "required": true, @@ -21653,7 +26945,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -21684,7 +26976,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" } ] }, @@ -21713,7 +27005,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -21726,7 +27018,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -21801,14 +27093,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.github.com). You can learn more about our LFS feature and working with large files [on our help site](https://help.github.com/articles/versioning-large-files/).", + "description": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.github.com). You can learn more about our LFS feature and working with large files [on our help site](https://docs.github.com/articles/versioning-large-files/).", "documentationUrl": "https://docs.github.com/rest/reference/migrations#update-git-lfs-preference", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -21821,7 +27113,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -21834,7 +27126,7 @@ }, { "name": "use_lfs", - "description": "Can be one of `opt_in` (large files will be stored using Git LFS) or `opt_out` (large files will be removed during the import).", + "description": "Whether to store large files during the import. `opt_in` means large files will be stored using Git LFS. `opt_out` means large files will be removed during the import.", "in": "BODY", "type": "string", "required": true, @@ -21887,6 +27179,32 @@ "alias": null, "deprecated": null }, + { + "name": "exclude_metadata", + "description": "Indicates whether metadata should be excluded and only git source should be included for the migration.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "exclude_git_data", + "description": "Indicates whether the repository git data should be excluded from the migration.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "exclude_attachments", "description": "Do not include attachments in the migration", @@ -21926,6 +27244,19 @@ "alias": null, "deprecated": null }, + { + "name": "org_metadata_only", + "description": "Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "exclude", "description": "Exclude attributes from the API response to improve performance", @@ -21990,7 +27321,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -22027,6 +27358,32 @@ "alias": null, "deprecated": null }, + { + "name": "exclude_metadata", + "description": "Indicates whether metadata should be excluded and only git source should be included for the migration.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "exclude_git_data", + "description": "Indicates whether the repository git data should be excluded from the migration.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "exclude_attachments", "description": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).", @@ -22066,6 +27423,19 @@ "alias": null, "deprecated": null }, + { + "name": "org_metadata_only", + "description": "Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "exclude", "description": "", @@ -22111,7 +27481,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -22124,7 +27494,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -22150,7 +27520,7 @@ }, { "name": "vcs", - "description": "The originating VCS type. Can be one of `subversion`, `git`, `mercurial`, or `tfvc`. Please be aware that without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.", + "description": "The originating VCS type. Without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.", "in": "BODY", "type": "string", "required": false, @@ -22232,7 +27602,7 @@ "parameters": [ { "name": "migration_id", - "description": "migration_id parameter", + "description": "The unique identifier of the migration.", "in": "PATH", "type": "integer", "required": true, @@ -22286,7 +27656,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -22299,7 +27669,7 @@ }, { "name": "migration_id", - "description": "migration_id parameter", + "description": "The unique identifier of the migration.", "in": "PATH", "type": "integer", "required": true, @@ -22339,14 +27709,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.", + "description": "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.\n\nSome servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array.\nYou can select the project to import by providing one of the objects in the `project_choices` array in the update request.", "documentationUrl": "https://docs.github.com/rest/reference/migrations#update-an-import", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -22359,7 +27729,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -22398,11 +27768,11 @@ }, { "name": "vcs", - "description": "", + "description": "The type of version control system you are migrating from.", "in": "BODY", "type": "string", "required": false, - "enum": null, + "enum": ["subversion", "tfvc", "git", "mercurial"], "allowNull": false, "mapToData": null, "validation": null, @@ -22411,7 +27781,7 @@ }, { "name": "tfvc_project", - "description": "", + "description": "For a tfvc import, the name of the project that is being imported.", "in": "BODY", "type": "string", "required": false, @@ -22451,7 +27821,7 @@ "isDeprecated": true, "deprecationDate": "2020-02-14", "removalDate": "2020-11-13", - "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\n**Warning:** Apps must use the [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nCreates OAuth tokens using [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://docs.github.com/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them.\n\nYou can also create tokens on GitHub from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://help.github.com/articles/creating-an-access-token-for-command-line-use).\n\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://help.github.com/articles/about-identity-and-access-management-with-saml-single-sign-on).", + "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\n**Warning:** Apps must use the [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nCreates OAuth tokens using [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://docs.github.com/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them.\n\nYou can also create tokens on GitHub from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/articles/creating-an-access-token-for-command-line-use).\n\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://docs.github.com/articles/about-identity-and-access-management-with-saml-single-sign-on).", "documentationUrl": "https://docs.github.com/rest/reference/oauth-authorizations#create-a-new-authorization", "previews": [], "headers": [], @@ -22573,7 +27943,7 @@ "parameters": [ { "name": "authorization_id", - "description": "authorization_id parameter", + "description": "The unique identifier of the authorization.", "in": "PATH", "type": "integer", "required": true, @@ -22613,7 +27983,7 @@ "parameters": [ { "name": "grant_id", - "description": "grant_id parameter", + "description": "The unique identifier of the grant.", "in": "PATH", "type": "integer", "required": true, @@ -22653,7 +28023,7 @@ "parameters": [ { "name": "authorization_id", - "description": "authorization_id parameter", + "description": "The unique identifier of the authorization.", "in": "PATH", "type": "integer", "required": true, @@ -22701,7 +28071,7 @@ "parameters": [ { "name": "grant_id", - "description": "grant_id parameter", + "description": "The unique identifier of the grant.", "in": "PATH", "type": "integer", "required": true, @@ -22749,7 +28119,7 @@ "parameters": [ { "name": "client_id", - "description": "The client ID of your GitHub app.", + "description": "The client ID of the GitHub app.", "in": "PATH", "type": "string", "required": true, @@ -22872,7 +28242,7 @@ "parameters": [ { "name": "client_id", - "description": "The client ID of your GitHub app.", + "description": "The client ID of the GitHub app.", "in": "PATH", "type": "string", "required": true, @@ -22988,7 +28358,7 @@ "parameters": [ { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -23063,7 +28433,7 @@ "parameters": [ { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -23138,7 +28508,7 @@ "parameters": [ { "name": "authorization_id", - "description": "authorization_id parameter", + "description": "The unique identifier of the authorization.", "in": "PATH", "type": "integer", "required": true, @@ -23258,7 +28628,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -23271,7 +28641,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -23305,7 +28675,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -23318,7 +28688,7 @@ }, { "name": "invitation_id", - "description": "invitation_id parameter", + "description": "The unique identifier of the invitation.", "in": "PATH", "type": "integer", "required": true, @@ -23353,7 +28723,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -23366,7 +28736,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -23408,7 +28778,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -23421,7 +28791,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -23468,7 +28838,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -23481,7 +28851,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -23516,14 +28886,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://help.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)\".", + "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"", "documentationUrl": "https://docs.github.com/rest/reference/orgs#convert-an-organization-member-to-outside-collaborator", "previews": [], "headers": [], "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -23536,7 +28906,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -23546,18 +28916,31 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "async", + "description": "When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ { "code": 202, "description": "User is getting converted asynchronously", - "examples": null + "examples": [{ "data": "null" }] }, { "code": 204, "description": "User was converted", "examples": null }, { "code": 403, - "description": "Forbidden if user is the last owner of the organization or not a member of the organization", + "description": "Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/en/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"", "examples": null }, { "code": 404, "description": "Resource not found", "examples": null } @@ -23580,7 +28963,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -23619,7 +29002,7 @@ }, { "name": "role", - "description": "Specify role for new member. Can be one of: \n\\* `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. \n\\* `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. \n\\* `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization.", + "description": "The role for the new member. \n\\* `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. \n\\* `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. \n\\* `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization.", "in": "BODY", "type": "string", "required": false, @@ -23675,7 +29058,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -23848,7 +29231,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -23861,7 +29244,7 @@ }, { "name": "hook_id", - "description": "", + "description": "The unique identifier of the hook.", "in": "PATH", "type": "integer", "required": true, @@ -23888,14 +29271,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nGitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See \"[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)\" for details. For an example response, see 'Response with GitHub plan information' below.\"", + "description": "To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nGitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See \"[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)\" for details. For an example response, see 'Response with GitHub plan information' below.\"", "documentationUrl": "https://docs.github.com/rest/reference/orgs#get-an-organization", "previews": [], "headers": [], "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -23913,7 +29296,7 @@ "description": "Response", "examples": [ { - "data": "{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"twitter_username\":\"github\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"type\":\"Organization\",\"total_private_repos\":100,\"owned_private_repos\":100,\"private_gists\":81,\"disk_usage\":10000,\"collaborators\":8,\"billing_email\":\"mona@github.com\",\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20,\"filled_seats\":4,\"seats\":5},\"default_repository_permission\":\"read\",\"members_can_create_repositories\":true,\"two_factor_requirement_enabled\":true,\"members_allowed_repository_creation_type\":\"all\",\"members_can_create_public_repositories\":false,\"members_can_create_private_repositories\":false,\"members_can_create_internal_repositories\":false,\"members_can_create_pages\":true}" + "data": "{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"twitter_username\":\"github\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"type\":\"Organization\",\"total_private_repos\":100,\"owned_private_repos\":100,\"private_gists\":81,\"disk_usage\":10000,\"collaborators\":8,\"billing_email\":\"mona@github.com\",\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20,\"filled_seats\":4,\"seats\":5},\"default_repository_permission\":\"read\",\"members_can_create_repositories\":true,\"two_factor_requirement_enabled\":true,\"members_allowed_repository_creation_type\":\"all\",\"members_can_create_public_repositories\":false,\"members_can_create_private_repositories\":false,\"members_can_create_internal_repositories\":false,\"members_can_create_pages\":true,\"members_can_fork_private_repositories\":false}" } ] }, @@ -23937,7 +29320,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -23980,7 +29363,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -23993,7 +29376,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -24036,7 +29419,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -24049,7 +29432,7 @@ }, { "name": "hook_id", - "description": "", + "description": "The unique identifier of the hook.", "in": "PATH", "type": "integer", "required": true, @@ -24091,7 +29474,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -24104,7 +29487,7 @@ }, { "name": "hook_id", - "description": "", + "description": "The unique identifier of the hook.", "in": "PATH", "type": "integer", "required": true, @@ -24145,7 +29528,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -24158,7 +29541,7 @@ }, { "name": "hook_id", - "description": "", + "description": "The unique identifier of the hook.", "in": "PATH", "type": "integer", "required": true, @@ -24228,7 +29611,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -24270,7 +29653,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -24283,7 +29666,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -24337,7 +29720,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -24358,8 +29741,48 @@ "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" } ] - }, - { "code": 415, "description": "Preview header missing", "examples": null } + } + ], + "renamed": null + }, + { + "name": "List custom repository roles in an organization", + "scope": "orgs", + "id": "listCustomRoles", + "method": "GET", + "url": "/organizations/{organization_id}/custom_roles", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".", + "documentationUrl": "https://docs.github.com/rest/reference/orgs#list-custom-repository-roles-in-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "organization_id", + "description": "", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response - list of custom role names", + "examples": [ + { + "data": "{\"total_count\":2,\"custom_roles\":[{\"id\":8030,\"name\":\"Developer\"},{\"id\":8031,\"name\":\"Designer\"}]}" + } + ] + } ], "renamed": null }, @@ -24379,7 +29802,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -24392,7 +29815,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -24447,7 +29870,7 @@ "parameters": [ { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -24501,14 +29924,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "List [public organization memberships](https://help.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead.", + "description": "List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead.", "documentationUrl": "https://docs.github.com/rest/reference/orgs#list-organizations-for-a-user", "previews": [], "headers": [], "parameters": [ { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -24521,7 +29944,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -24575,7 +29998,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -24588,7 +30011,7 @@ }, { "name": "invitation_id", - "description": "invitation_id parameter", + "description": "The unique identifier of the invitation.", "in": "PATH", "type": "integer", "required": true, @@ -24601,7 +30024,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -24656,7 +30079,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -24669,7 +30092,7 @@ }, { "name": "filter", - "description": "Filter members returned in the list. Can be one of: \n\\* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. \n\\* `all` - All members the authenticated user can see.", + "description": "Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. This options is only available for organization owners.", "in": "QUERY", "type": "string", "required": false, @@ -24682,7 +30105,7 @@ }, { "name": "role", - "description": "Filter members returned by their role. Can be one of: \n\\* `all` - All members of the organization, regardless of role. \n\\* `admin` - Organization owners. \n\\* `member` - Non-owner organization members.", + "description": "Filter members returned by their role.", "in": "QUERY", "type": "string", "required": false, @@ -24695,7 +30118,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -24768,7 +30191,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -24830,7 +30253,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -24843,7 +30266,7 @@ }, { "name": "filter", - "description": "Filter the list of outside collaborators. Can be one of: \n\\* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. \n\\* `all`: All outside collaborators.", + "description": "Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned.", "in": "QUERY", "type": "string", "required": false, @@ -24856,7 +30279,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -24910,7 +30333,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -24923,7 +30346,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -24978,7 +30401,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -24991,7 +30414,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -25045,7 +30468,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -25058,7 +30481,7 @@ }, { "name": "hook_id", - "description": "", + "description": "The unique identifier of the hook.", "in": "PATH", "type": "integer", "required": true, @@ -25071,7 +30494,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -25128,7 +30551,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -25141,7 +30564,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -25196,7 +30619,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -25209,7 +30632,7 @@ }, { "name": "hook_id", - "description": "", + "description": "The unique identifier of the hook.", "in": "PATH", "type": "integer", "required": true, @@ -25243,7 +30666,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -25256,7 +30679,7 @@ }, { "name": "hook_id", - "description": "", + "description": "The unique identifier of the hook.", "in": "PATH", "type": "integer", "required": true, @@ -25305,7 +30728,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -25318,7 +30741,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -25352,7 +30775,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -25365,7 +30788,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -25400,7 +30823,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -25413,7 +30836,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -25455,7 +30878,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -25468,7 +30891,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -25499,7 +30922,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -25512,7 +30935,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -25568,7 +30991,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -25581,7 +31004,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -25615,7 +31038,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -25628,7 +31051,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -25659,7 +31082,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -25763,7 +31186,7 @@ }, { "name": "has_organization_projects", - "description": "Toggles whether an organization can use organization projects.", + "description": "Whether an organization can use organization projects.", "in": "BODY", "type": "boolean", "required": false, @@ -25776,7 +31199,7 @@ }, { "name": "has_repository_projects", - "description": "Toggles whether repositories that belong to the organization can use repository projects.", + "description": "Whether repositories that belong to the organization can use repository projects.", "in": "BODY", "type": "boolean", "required": false, @@ -25789,7 +31212,7 @@ }, { "name": "default_repository_permission", - "description": "Default permission level members have for organization repositories: \n\\* `read` - can pull, but not push to or administer this repository. \n\\* `write` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push, and administer this repository. \n\\* `none` - no permissions granted by default.", + "description": "Default permission level members have for organization repositories.", "in": "BODY", "type": "string", "required": false, @@ -25802,7 +31225,7 @@ }, { "name": "members_can_create_repositories", - "description": "Toggles the ability of non-admin organization members to create repositories. Can be one of: \n\\* `true` - all organization members can create repositories. \n\\* `false` - only organization owners can create repositories. \nDefault: `true` \n**Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.", + "description": "Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.", "in": "BODY", "type": "boolean", "required": false, @@ -25815,7 +31238,7 @@ }, { "name": "members_can_create_internal_repositories", - "description": "Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of: \n\\* `true` - all organization members can create internal repositories. \n\\* `false` - only organization owners can create internal repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", + "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", "in": "BODY", "type": "boolean", "required": false, @@ -25828,7 +31251,7 @@ }, { "name": "members_can_create_private_repositories", - "description": "Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: \n\\* `true` - all organization members can create private repositories. \n\\* `false` - only organization owners can create private repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", + "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", "in": "BODY", "type": "boolean", "required": false, @@ -25841,7 +31264,7 @@ }, { "name": "members_can_create_public_repositories", - "description": "Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: \n\\* `true` - all organization members can create public repositories. \n\\* `false` - only organization owners can create public repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", + "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", "in": "BODY", "type": "boolean", "required": false, @@ -25854,7 +31277,7 @@ }, { "name": "members_allowed_repository_creation_type", - "description": "Specifies which types of repositories non-admin organization members can create. Can be one of: \n\\* `all` - all organization members can create public and private repositories. \n\\* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n\\* `none` - only admin members can create repositories. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", + "description": "Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", "in": "BODY", "type": "string", "required": false, @@ -25867,7 +31290,7 @@ }, { "name": "members_can_create_pages", - "description": "Toggles whether organization members can create GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create GitHub Pages sites. \n\\* `false` - no organization members can create GitHub Pages sites. Existing published sites will not be impacted.", + "description": "Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.", "in": "BODY", "type": "boolean", "required": false, @@ -25880,7 +31303,7 @@ }, { "name": "members_can_create_public_pages", - "description": "Toggles whether organization members can create public GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create public GitHub Pages sites. \n\\* `false` - no organization members can create public GitHub Pages sites. Existing published sites will not be impacted.", + "description": "Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted.", "in": "BODY", "type": "boolean", "required": false, @@ -25893,7 +31316,20 @@ }, { "name": "members_can_create_private_pages", - "description": "Toggles whether organization members can create private GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create private GitHub Pages sites. \n\\* `false` - no organization members can create private GitHub Pages sites. Existing published sites will not be impacted.", + "description": "Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "members_can_fork_private_repositories", + "description": "Whether organization members can fork private organization repositories.", "in": "BODY", "type": "boolean", "required": false, @@ -25924,7 +31360,7 @@ "description": "Response", "examples": [ { - "data": "{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"twitter_username\":\"github\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\",\"total_private_repos\":100,\"owned_private_repos\":100,\"private_gists\":81,\"disk_usage\":10000,\"collaborators\":8,\"billing_email\":\"mona@github.com\",\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20},\"default_repository_permission\":\"read\",\"members_can_create_repositories\":true,\"two_factor_requirement_enabled\":true,\"members_allowed_repository_creation_type\":\"all\",\"members_can_create_public_repositories\":false,\"members_can_create_private_repositories\":false,\"members_can_create_internal_repositories\":false,\"members_can_create_pages\":true,\"members_can_create_public_pages\":true,\"members_can_create_private_pages\":true,\"updated_at\":\"2014-03-03T18:58:10Z\"}" + "data": "{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"twitter_username\":\"github\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\",\"total_private_repos\":100,\"owned_private_repos\":100,\"private_gists\":81,\"disk_usage\":10000,\"collaborators\":8,\"billing_email\":\"mona@github.com\",\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20},\"default_repository_permission\":\"read\",\"members_can_create_repositories\":true,\"two_factor_requirement_enabled\":true,\"members_allowed_repository_creation_type\":\"all\",\"members_can_create_public_repositories\":false,\"members_can_create_private_repositories\":false,\"members_can_create_internal_repositories\":false,\"members_can_create_pages\":true,\"members_can_create_public_pages\":true,\"members_can_create_private_pages\":true,\"members_can_fork_private_repositories\":false,\"updated_at\":\"2014-03-03T18:58:10Z\"}" } ] }, @@ -25949,7 +31385,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -26006,7 +31442,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -26019,7 +31455,7 @@ }, { "name": "hook_id", - "description": "", + "description": "The unique identifier of the hook.", "in": "PATH", "type": "integer", "required": true, @@ -26166,7 +31602,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -26179,7 +31615,7 @@ }, { "name": "hook_id", - "description": "", + "description": "The unique identifier of the hook.", "in": "PATH", "type": "integer", "required": true, @@ -26272,7 +31708,7 @@ "parameters": [ { "name": "package_type", - "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", "in": "PATH", "type": "string", "required": true, @@ -26325,7 +31761,7 @@ "parameters": [ { "name": "package_type", - "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", "in": "PATH", "type": "string", "required": true, @@ -26351,7 +31787,7 @@ }, { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -26391,7 +31827,7 @@ "parameters": [ { "name": "package_type", - "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", "in": "PATH", "type": "string", "required": true, @@ -26417,7 +31853,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -26457,7 +31893,7 @@ "parameters": [ { "name": "package_type", - "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", "in": "PATH", "type": "string", "required": true, @@ -26523,7 +31959,7 @@ "parameters": [ { "name": "package_type", - "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", "in": "PATH", "type": "string", "required": true, @@ -26549,7 +31985,7 @@ }, { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -26602,7 +32038,7 @@ "parameters": [ { "name": "package_type", - "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", "in": "PATH", "type": "string", "required": true, @@ -26628,7 +32064,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -26681,7 +32117,7 @@ "parameters": [ { "name": "package_type", - "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", "in": "PATH", "type": "string", "required": true, @@ -26707,7 +32143,7 @@ }, { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -26733,7 +32169,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -26805,7 +32241,7 @@ "parameters": [ { "name": "package_type", - "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", "in": "PATH", "type": "string", "required": true, @@ -26844,7 +32280,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -26916,7 +32352,7 @@ "parameters": [ { "name": "package_type", - "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", "in": "PATH", "type": "string", "required": true, @@ -26955,7 +32391,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -27016,7 +32452,7 @@ "parameters": [ { "name": "package_type", - "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", "in": "PATH", "type": "string", "required": true, @@ -27042,7 +32478,7 @@ }, { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -27068,7 +32504,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -27129,7 +32565,7 @@ "parameters": [ { "name": "package_type", - "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", "in": "PATH", "type": "string", "required": true, @@ -27155,7 +32591,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -27203,7 +32639,7 @@ "parameters": [ { "name": "package_type", - "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", "in": "PATH", "type": "string", "required": true, @@ -27257,7 +32693,7 @@ "parameters": [ { "name": "package_type", - "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", "in": "PATH", "type": "string", "required": true, @@ -27283,7 +32719,7 @@ }, { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -27324,7 +32760,7 @@ "parameters": [ { "name": "package_type", - "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", "in": "PATH", "type": "string", "required": true, @@ -27350,7 +32786,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -27391,7 +32827,7 @@ "parameters": [ { "name": "package_type", - "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", "in": "PATH", "type": "string", "required": true, @@ -27458,7 +32894,7 @@ "parameters": [ { "name": "package_type", - "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", "in": "PATH", "type": "string", "required": true, @@ -27484,7 +32920,7 @@ }, { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -27538,7 +32974,7 @@ "parameters": [ { "name": "package_type", - "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", "in": "PATH", "type": "string", "required": true, @@ -27577,7 +33013,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -27618,7 +33054,7 @@ "parameters": [ { "name": "package_type", - "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", "in": "QUERY", "type": "string", "required": true, @@ -27631,7 +33067,7 @@ }, { "name": "visibility", - "description": "The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set.", + "description": "The selected visibility of the packages. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set.", "in": "QUERY", "type": "string", "required": false, @@ -27672,7 +33108,7 @@ "parameters": [ { "name": "package_type", - "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", "in": "QUERY", "type": "string", "required": true, @@ -27685,7 +33121,7 @@ }, { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -27698,7 +33134,7 @@ }, { "name": "visibility", - "description": "The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set.", + "description": "The selected visibility of the packages. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set.", "in": "QUERY", "type": "string", "required": false, @@ -27745,7 +33181,7 @@ "parameters": [ { "name": "package_type", - "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", "in": "QUERY", "type": "string", "required": true, @@ -27758,7 +33194,7 @@ }, { "name": "visibility", - "description": "The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set.", + "description": "The selected visibility of the packages. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set.", "in": "QUERY", "type": "string", "required": false, @@ -27771,7 +33207,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -27818,7 +33254,7 @@ "parameters": [ { "name": "package_type", - "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", "in": "PATH", "type": "string", "required": true, @@ -27884,7 +33320,7 @@ "parameters": [ { "name": "package_type", - "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", "in": "PATH", "type": "string", "required": true, @@ -27910,7 +33346,7 @@ }, { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -27963,7 +33399,7 @@ "parameters": [ { "name": "package_type", - "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", "in": "PATH", "type": "string", "required": true, @@ -27989,7 +33425,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -28042,7 +33478,7 @@ "parameters": [ { "name": "package_type", - "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", "in": "PATH", "type": "string", "required": true, @@ -28108,7 +33544,7 @@ "parameters": [ { "name": "package_type", - "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", "in": "PATH", "type": "string", "required": true, @@ -28134,7 +33570,7 @@ }, { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -28187,7 +33623,7 @@ "parameters": [ { "name": "package_type", - "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", "in": "PATH", "type": "string", "required": true, @@ -28213,7 +33649,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -28266,7 +33702,7 @@ "parameters": [ { "name": "project_id", - "description": "", + "description": "The unique identifier of the project.", "in": "PATH", "type": "integer", "required": true, @@ -28279,7 +33715,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -28334,7 +33770,7 @@ "parameters": [ { "name": "column_id", - "description": "column_id parameter", + "description": "The unique identifier of the column.", "in": "PATH", "type": "integer", "required": true, @@ -28423,7 +33859,7 @@ "parameters": [ { "name": "project_id", - "description": "", + "description": "The unique identifier of the project.", "in": "PATH", "type": "integer", "required": true, @@ -28527,11 +33963,6 @@ "examples": null }, { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, { "code": 422, "description": "Validation failed", "examples": null } ], "renamed": null @@ -28552,7 +33983,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -28628,7 +34059,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -28641,7 +34072,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -28717,7 +34148,7 @@ "parameters": [ { "name": "project_id", - "description": "", + "description": "The unique identifier of the project.", "in": "PATH", "type": "integer", "required": true, @@ -28759,7 +34190,7 @@ "parameters": [ { "name": "card_id", - "description": "card_id parameter", + "description": "The unique identifier of the card.", "in": "PATH", "type": "integer", "required": true, @@ -28800,7 +34231,7 @@ "parameters": [ { "name": "column_id", - "description": "column_id parameter", + "description": "The unique identifier of the column.", "in": "PATH", "type": "integer", "required": true, @@ -28840,7 +34271,7 @@ "parameters": [ { "name": "project_id", - "description": "", + "description": "The unique identifier of the project.", "in": "PATH", "type": "integer", "required": true, @@ -28888,7 +34319,7 @@ "parameters": [ { "name": "card_id", - "description": "card_id parameter", + "description": "The unique identifier of the card.", "in": "PATH", "type": "integer", "required": true, @@ -28937,7 +34368,7 @@ "parameters": [ { "name": "column_id", - "description": "column_id parameter", + "description": "The unique identifier of the column.", "in": "PATH", "type": "integer", "required": true, @@ -28986,7 +34417,7 @@ "parameters": [ { "name": "project_id", - "description": "", + "description": "The unique identifier of the project.", "in": "PATH", "type": "integer", "required": true, @@ -28999,7 +34430,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -29049,7 +34480,7 @@ "parameters": [ { "name": "column_id", - "description": "column_id parameter", + "description": "The unique identifier of the column.", "in": "PATH", "type": "integer", "required": true, @@ -29062,7 +34493,7 @@ }, { "name": "archived_state", - "description": "Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`.", + "description": "Filters the project cards that are returned by the card's state.", "in": "QUERY", "type": "string", "required": false, @@ -29075,7 +34506,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -29136,7 +34567,7 @@ "parameters": [ { "name": "project_id", - "description": "", + "description": "The unique identifier of the project.", "in": "PATH", "type": "integer", "required": true, @@ -29149,7 +34580,7 @@ }, { "name": "affiliation", - "description": "Filters the collaborators by their affiliation. Can be one of: \n\\* `outside`: Outside collaborators of a project that are not a member of the project's organization. \n\\* `direct`: Collaborators with permissions to a project, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.", + "description": "Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see.", "in": "QUERY", "type": "string", "required": false, @@ -29162,7 +34593,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -29225,7 +34656,7 @@ "parameters": [ { "name": "project_id", - "description": "", + "description": "The unique identifier of the project.", "in": "PATH", "type": "integer", "required": true, @@ -29238,7 +34669,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -29299,7 +34730,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -29325,7 +34756,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -29380,7 +34811,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -29393,7 +34824,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -29419,7 +34850,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -29482,7 +34913,7 @@ "parameters": [ { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -29508,7 +34939,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -29563,7 +34994,7 @@ "parameters": [ { "name": "card_id", - "description": "card_id parameter", + "description": "The unique identifier of the card.", "in": "PATH", "type": "integer", "required": true, @@ -29602,7 +35033,11 @@ } ], "responses": [ - { "code": 201, "description": "Response", "examples": null }, + { + "code": 201, + "description": "Response", + "examples": [{ "data": "null" }] + }, { "code": 304, "description": "Not modified", "examples": null }, { "code": 401, @@ -29631,7 +35066,7 @@ "parameters": [ { "name": "column_id", - "description": "column_id parameter", + "description": "The unique identifier of the column.", "in": "PATH", "type": "integer", "required": true, @@ -29657,7 +35092,11 @@ } ], "responses": [ - { "code": 201, "description": "Response", "examples": null }, + { + "code": 201, + "description": "Response", + "examples": [{ "data": "null" }] + }, { "code": 304, "description": "Not modified", "examples": null }, { "code": 401, @@ -29685,7 +35124,7 @@ "parameters": [ { "name": "project_id", - "description": "", + "description": "The unique identifier of the project.", "in": "PATH", "type": "integer", "required": true, @@ -29698,7 +35137,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -29740,7 +35179,7 @@ "parameters": [ { "name": "project_id", - "description": "", + "description": "The unique identifier of the project.", "in": "PATH", "type": "integer", "required": true, @@ -29860,7 +35299,7 @@ "parameters": [ { "name": "card_id", - "description": "card_id parameter", + "description": "The unique identifier of the card.", "in": "PATH", "type": "integer", "required": true, @@ -29936,7 +35375,7 @@ "parameters": [ { "name": "column_id", - "description": "column_id parameter", + "description": "The unique identifier of the column.", "in": "PATH", "type": "integer", "required": true, @@ -29997,7 +35436,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -30010,7 +35449,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -30023,7 +35462,7 @@ }, { "name": "pull_number", - "description": "", + "description": "The number that identifies the pull request.", "in": "PATH", "type": "integer", "required": true, @@ -30058,14 +35497,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nYou can create a new pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nYou can create a new pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/rest/reference/pulls#create-a-pull-request", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -30078,7 +35517,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -30143,7 +35582,7 @@ }, { "name": "maintainer_can_modify", - "description": "Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", + "description": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", "in": "BODY", "type": "boolean", "required": false, @@ -30156,7 +35595,7 @@ }, { "name": "draft", - "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.", + "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.", "in": "BODY", "type": "boolean", "required": false, @@ -30212,7 +35651,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -30225,7 +35664,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -30238,7 +35677,7 @@ }, { "name": "pull_number", - "description": "", + "description": "The number that identifies the pull request.", "in": "PATH", "type": "integer", "required": true, @@ -30251,7 +35690,7 @@ }, { "name": "comment_id", - "description": "comment_id parameter", + "description": "The unique identifier of the comment.", "in": "PATH", "type": "integer", "required": true, @@ -30306,7 +35745,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -30319,7 +35758,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -30332,7 +35771,7 @@ }, { "name": "pull_number", - "description": "", + "description": "The number that identifies the pull request.", "in": "PATH", "type": "integer", "required": true, @@ -30511,14 +35950,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see the [`comfort-fade` preview notice](https://docs.github.com/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", + "description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nThe `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/rest/reference/pulls#create-a-review-comment-for-a-pull-request", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -30531,7 +35970,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -30544,7 +35983,7 @@ }, { "name": "pull_number", - "description": "", + "description": "The number that identifies the pull request.", "in": "PATH", "type": "integer", "required": true, @@ -30596,7 +36035,7 @@ }, { "name": "position", - "description": "**Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", + "description": "**This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", "in": "BODY", "type": "integer", "required": false, @@ -30609,7 +36048,7 @@ }, { "name": "side", - "description": "**Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", + "description": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", "in": "BODY", "type": "string", "required": false, @@ -30622,7 +36061,7 @@ }, { "name": "line", - "description": "**Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", + "description": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", "in": "BODY", "type": "integer", "required": false, @@ -30635,7 +36074,7 @@ }, { "name": "start_line", - "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", + "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", "in": "BODY", "type": "integer", "required": false, @@ -30648,7 +36087,7 @@ }, { "name": "start_side", - "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", "in": "BODY", "type": "string", "required": false, @@ -30661,7 +36100,7 @@ }, { "name": "in_reply_to", - "description": "", + "description": "The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored.", "in": "BODY", "type": "integer", "required": false, @@ -30704,7 +36143,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -30717,7 +36156,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -30730,7 +36169,7 @@ }, { "name": "pull_number", - "description": "", + "description": "The number that identifies the pull request.", "in": "PATH", "type": "integer", "required": true, @@ -30743,7 +36182,7 @@ }, { "name": "review_id", - "description": "review_id parameter", + "description": "The unique identifier of the review.", "in": "PATH", "type": "integer", "required": true, @@ -30786,7 +36225,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -30799,7 +36238,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -30812,7 +36251,7 @@ }, { "name": "comment_id", - "description": "comment_id parameter", + "description": "The unique identifier of the comment.", "in": "PATH", "type": "integer", "required": true, @@ -30846,7 +36285,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -30859,7 +36298,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -30872,7 +36311,7 @@ }, { "name": "pull_number", - "description": "", + "description": "The number that identifies the pull request.", "in": "PATH", "type": "integer", "required": true, @@ -30885,7 +36324,7 @@ }, { "name": "review_id", - "description": "review_id parameter", + "description": "The unique identifier of the review.", "in": "PATH", "type": "integer", "required": true, @@ -30947,14 +36386,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://docs.github.com/rest/reference/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/reference/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://help.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://help.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://help.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://docs.github.com/rest/reference/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/reference/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://docs.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", "documentationUrl": "https://docs.github.com/rest/reference/pulls#get-a-pull-request", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -30967,7 +36406,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -30980,7 +36419,7 @@ }, { "name": "pull_number", - "description": "", + "description": "The number that identifies the pull request.", "in": "PATH", "type": "integer", "required": true, @@ -31024,7 +36463,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -31037,7 +36476,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -31050,7 +36489,7 @@ }, { "name": "pull_number", - "description": "", + "description": "The number that identifies the pull request.", "in": "PATH", "type": "integer", "required": true, @@ -31063,7 +36502,7 @@ }, { "name": "review_id", - "description": "review_id parameter", + "description": "The unique identifier of the review.", "in": "PATH", "type": "integer", "required": true, @@ -31105,7 +36544,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -31118,7 +36557,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -31131,7 +36570,7 @@ }, { "name": "comment_id", - "description": "comment_id parameter", + "description": "The unique identifier of the comment.", "in": "PATH", "type": "integer", "required": true, @@ -31166,14 +36605,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "documentationUrl": "https://docs.github.com/rest/reference/pulls#list-pull-requests", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -31186,7 +36625,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -31264,7 +36703,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -31320,7 +36759,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -31333,7 +36772,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -31346,7 +36785,7 @@ }, { "name": "pull_number", - "description": "", + "description": "The number that identifies the pull request.", "in": "PATH", "type": "integer", "required": true, @@ -31359,7 +36798,7 @@ }, { "name": "review_id", - "description": "review_id parameter", + "description": "The unique identifier of the review.", "in": "PATH", "type": "integer", "required": true, @@ -31372,7 +36811,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -31427,7 +36866,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -31440,7 +36879,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -31453,7 +36892,7 @@ }, { "name": "pull_number", - "description": "", + "description": "The number that identifies the pull request.", "in": "PATH", "type": "integer", "required": true, @@ -31466,7 +36905,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -31520,7 +36959,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -31533,7 +36972,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -31546,7 +36985,7 @@ }, { "name": "pull_number", - "description": "", + "description": "The number that identifies the pull request.", "in": "PATH", "type": "integer", "required": true, @@ -31559,7 +36998,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -31615,7 +37054,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -31628,7 +37067,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -31641,7 +37080,7 @@ }, { "name": "pull_number", - "description": "", + "description": "The number that identifies the pull request.", "in": "PATH", "type": "integer", "required": true, @@ -31654,7 +37093,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -31708,7 +37147,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -31721,7 +37160,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -31734,7 +37173,7 @@ }, { "name": "pull_number", - "description": "", + "description": "The number that identifies the pull request.", "in": "PATH", "type": "integer", "required": true, @@ -31747,7 +37186,7 @@ }, { "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", + "description": "The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to.", "in": "QUERY", "type": "string", "required": false, @@ -31786,7 +37225,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -31840,7 +37279,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -31853,7 +37292,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -31905,7 +37344,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -31959,7 +37398,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -31972,7 +37411,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -31985,7 +37424,7 @@ }, { "name": "pull_number", - "description": "", + "description": "The number that identifies the pull request.", "in": "PATH", "type": "integer", "required": true, @@ -31998,7 +37437,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -32052,7 +37491,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -32065,7 +37504,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -32078,7 +37517,7 @@ }, { "name": "pull_number", - "description": "", + "description": "The number that identifies the pull request.", "in": "PATH", "type": "integer", "required": true, @@ -32190,7 +37629,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -32203,7 +37642,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -32216,7 +37655,7 @@ }, { "name": "pull_number", - "description": "", + "description": "The number that identifies the pull request.", "in": "PATH", "type": "integer", "required": true, @@ -32276,7 +37715,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -32289,7 +37728,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -32302,7 +37741,7 @@ }, { "name": "pull_number", - "description": "", + "description": "The number that identifies the pull request.", "in": "PATH", "type": "integer", "required": true, @@ -32375,7 +37814,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -32388,7 +37827,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -32401,7 +37840,7 @@ }, { "name": "pull_number", - "description": "", + "description": "The number that identifies the pull request.", "in": "PATH", "type": "integer", "required": true, @@ -32414,7 +37853,7 @@ }, { "name": "review_id", - "description": "review_id parameter", + "description": "The unique identifier of the review.", "in": "PATH", "type": "integer", "required": true, @@ -32477,14 +37916,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.", + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.", "documentationUrl": "https://docs.github.com/rest/reference/pulls/#update-a-pull-request", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -32497,7 +37936,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -32510,7 +37949,7 @@ }, { "name": "pull_number", - "description": "", + "description": "The number that identifies the pull request.", "in": "PATH", "type": "integer", "required": true, @@ -32575,7 +38014,7 @@ }, { "name": "maintainer_can_modify", - "description": "Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", + "description": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", "in": "BODY", "type": "boolean", "required": false, @@ -32618,7 +38057,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -32631,7 +38070,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -32644,7 +38083,7 @@ }, { "name": "pull_number", - "description": "", + "description": "The number that identifies the pull request.", "in": "PATH", "type": "integer", "required": true, @@ -32700,7 +38139,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -32713,7 +38152,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -32726,7 +38165,7 @@ }, { "name": "pull_number", - "description": "", + "description": "The number that identifies the pull request.", "in": "PATH", "type": "integer", "required": true, @@ -32739,7 +38178,7 @@ }, { "name": "review_id", - "description": "review_id parameter", + "description": "The unique identifier of the review.", "in": "PATH", "type": "integer", "required": true, @@ -32794,7 +38233,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -32807,7 +38246,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -32820,7 +38259,7 @@ }, { "name": "comment_id", - "description": "comment_id parameter", + "description": "The unique identifier of the comment.", "in": "PATH", "type": "integer", "required": true, @@ -32903,7 +38342,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -32916,7 +38355,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -32929,7 +38368,7 @@ }, { "name": "comment_id", - "description": "comment_id parameter", + "description": "The unique identifier of the comment.", "in": "PATH", "type": "integer", "required": true, @@ -32982,11 +38421,6 @@ } ] }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, { "code": 422, "description": "Validation failed", "examples": null } ], "renamed": null @@ -33007,7 +38441,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -33020,7 +38454,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -33033,7 +38467,7 @@ }, { "name": "issue_number", - "description": "issue_number parameter", + "description": "The number that identifies the issue.", "in": "PATH", "type": "integer", "required": true, @@ -33106,7 +38540,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -33119,7 +38553,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -33132,7 +38566,7 @@ }, { "name": "comment_id", - "description": "comment_id parameter", + "description": "The unique identifier of the comment.", "in": "PATH", "type": "integer", "required": true, @@ -33205,7 +38639,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -33218,7 +38652,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -33231,7 +38665,7 @@ }, { "name": "comment_id", - "description": "comment_id parameter", + "description": "The unique identifier of the comment.", "in": "PATH", "type": "integer", "required": true, @@ -33304,7 +38738,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -33317,7 +38751,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -33330,7 +38764,7 @@ }, { "name": "release_id", - "description": "release_id parameter", + "description": "The unique identifier of the release.", "in": "PATH", "type": "integer", "required": true, @@ -33394,7 +38828,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -33407,7 +38841,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -33420,7 +38854,7 @@ }, { "name": "discussion_number", - "description": "", + "description": "The number that identifies the discussion.", "in": "PATH", "type": "integer", "required": true, @@ -33433,7 +38867,7 @@ }, { "name": "comment_number", - "description": "", + "description": "The number that identifies the comment.", "in": "PATH", "type": "integer", "required": true, @@ -33470,7 +38904,7 @@ "responses": [ { "code": 200, - "description": "Response", + "description": "Response when the reaction type has already been added to this team discussion comment", "examples": [ { "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" @@ -33505,7 +38939,7 @@ "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -33518,7 +38952,7 @@ }, { "name": "discussion_number", - "description": "", + "description": "The number that identifies the discussion.", "in": "PATH", "type": "integer", "required": true, @@ -33531,7 +38965,7 @@ }, { "name": "comment_number", - "description": "", + "description": "The number that identifies the comment.", "in": "PATH", "type": "integer", "required": true, @@ -33594,7 +39028,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -33607,7 +39041,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -33620,7 +39054,7 @@ }, { "name": "discussion_number", - "description": "", + "description": "The number that identifies the discussion.", "in": "PATH", "type": "integer", "required": true, @@ -33692,7 +39126,7 @@ "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -33705,7 +39139,7 @@ }, { "name": "discussion_number", - "description": "", + "description": "The number that identifies the discussion.", "in": "PATH", "type": "integer", "required": true, @@ -33768,7 +39202,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -33781,7 +39215,147 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "comment_id", + "description": "The unique identifier of the comment.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "reaction_id", + "description": "The unique identifier of the reaction.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [{ "code": 204, "description": "Response", "examples": null }], + "renamed": null + }, + { + "name": "Delete an issue reaction", + "scope": "reactions", + "id": "deleteForIssue", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.\n\nDelete a reaction to an [issue](https://docs.github.com/rest/reference/issues/).", + "documentationUrl": "https://docs.github.com/rest/reference/reactions#delete-an-issue-reaction", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "reaction_id", + "description": "The unique identifier of the reaction.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [{ "code": 204, "description": "Response", "examples": null }], + "renamed": null + }, + { + "name": "Delete an issue comment reaction", + "scope": "reactions", + "id": "deleteForIssueComment", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments).", + "documentationUrl": "https://docs.github.com/rest/reference/reactions#delete-an-issue-comment-reaction", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -33794,7 +39368,7 @@ }, { "name": "comment_id", - "description": "comment_id parameter", + "description": "The unique identifier of the comment.", "in": "PATH", "type": "integer", "required": true, @@ -33807,7 +39381,7 @@ }, { "name": "reaction_id", - "description": "", + "description": "The unique identifier of the reaction.", "in": "PATH", "type": "integer", "required": true, @@ -33823,22 +39397,22 @@ "renamed": null }, { - "name": "Delete an issue reaction", + "name": "Delete a pull request comment reaction", "scope": "reactions", - "id": "deleteForIssue", + "id": "deleteForPullRequestComment", "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}", + "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.\n\nDelete a reaction to an [issue](https://docs.github.com/rest/reference/issues/).", - "documentationUrl": "https://docs.github.com/rest/reference/reactions#delete-an-issue-reaction", + "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`\n\nDelete a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments).", + "documentationUrl": "https://docs.github.com/rest/reference/reactions#delete-a-pull-request-comment-reaction", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -33851,7 +39425,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -33863,8 +39437,8 @@ "deprecated": null }, { - "name": "issue_number", - "description": "issue_number parameter", + "name": "comment_id", + "description": "The unique identifier of the comment.", "in": "PATH", "type": "integer", "required": true, @@ -33877,7 +39451,7 @@ }, { "name": "reaction_id", - "description": "", + "description": "The unique identifier of the reaction.", "in": "PATH", "type": "integer", "required": true, @@ -33893,22 +39467,22 @@ "renamed": null }, { - "name": "Delete an issue comment reaction", + "name": "Delete a release reaction", "scope": "reactions", - "id": "deleteForIssueComment", + "id": "deleteForRelease", "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}", + "url": "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments).", - "documentationUrl": "https://docs.github.com/rest/reference/reactions#delete-an-issue-comment-reaction", + "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`.\n\nDelete a reaction to a [release](https://docs.github.com/rest/reference/repos#releases).", + "documentationUrl": "https://docs.github.com/rest/reference/reactions/#delete-a-release-reaction", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -33921,7 +39495,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -33933,8 +39507,8 @@ "deprecated": null }, { - "name": "comment_id", - "description": "comment_id parameter", + "name": "release_id", + "description": "The unique identifier of the release.", "in": "PATH", "type": "integer", "required": true, @@ -33947,7 +39521,7 @@ }, { "name": "reaction_id", - "description": "", + "description": "The unique identifier of the reaction.", "in": "PATH", "type": "integer", "required": true, @@ -33963,22 +39537,22 @@ "renamed": null }, { - "name": "Delete a pull request comment reaction", + "name": "Delete team discussion reaction", "scope": "reactions", - "id": "deleteForPullRequestComment", + "id": "deleteForTeamDiscussion", "method": "DELETE", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}", + "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`\n\nDelete a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments).", - "documentationUrl": "https://docs.github.com/rest/reference/reactions#delete-a-pull-request-comment-reaction", + "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "documentationUrl": "https://docs.github.com/rest/reference/reactions#delete-team-discussion-reaction", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -33990,8 +39564,8 @@ "deprecated": null }, { - "name": "repo", - "description": "", + "name": "team_slug", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -34003,8 +39577,8 @@ "deprecated": null }, { - "name": "comment_id", - "description": "comment_id parameter", + "name": "discussion_number", + "description": "The number that identifies the discussion.", "in": "PATH", "type": "integer", "required": true, @@ -34017,7 +39591,7 @@ }, { "name": "reaction_id", - "description": "", + "description": "The unique identifier of the reaction.", "in": "PATH", "type": "integer", "required": true, @@ -34033,22 +39607,22 @@ "renamed": null }, { - "name": "Delete team discussion reaction", + "name": "Delete team discussion comment reaction", "scope": "reactions", - "id": "deleteForTeamDiscussion", + "id": "deleteForTeamDiscussionComment", "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}", + "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/rest/reference/reactions#delete-team-discussion-reaction", + "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "documentationUrl": "https://docs.github.com/rest/reference/reactions#delete-team-discussion-comment-reaction", "previews": [], "headers": [], "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -34061,7 +39635,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -34074,7 +39648,20 @@ }, { "name": "discussion_number", - "description": "", + "description": "The number that identifies the discussion.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "comment_number", + "description": "The number that identifies the comment.", "in": "PATH", "type": "integer", "required": true, @@ -34087,7 +39674,7 @@ }, { "name": "reaction_id", - "description": "", + "description": "The unique identifier of the reaction.", "in": "PATH", "type": "integer", "required": true, @@ -34103,22 +39690,22 @@ "renamed": null }, { - "name": "Delete team discussion comment reaction", + "name": "List reactions for a commit comment", "scope": "reactions", - "id": "deleteForTeamDiscussionComment", - "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}", + "id": "listForCommitComment", + "method": "GET", + "url": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/rest/reference/reactions#delete-team-discussion-comment-reaction", + "description": "List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments).", + "documentationUrl": "https://docs.github.com/rest/reference/reactions#list-reactions-for-a-commit-comment", "previews": [], "headers": [], "parameters": [ { - "name": "org", - "description": "", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -34130,8 +39717,8 @@ "deprecated": null }, { - "name": "team_slug", - "description": "team_slug parameter", + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -34143,8 +39730,8 @@ "deprecated": null }, { - "name": "discussion_number", - "description": "", + "name": "comment_id", + "description": "The unique identifier of the comment.", "in": "PATH", "type": "integer", "required": true, @@ -34156,11 +39743,33 @@ "deprecated": null }, { - "name": "comment_number", - "description": "", - "in": "PATH", + "name": "content", + "description": "Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a commit comment.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", "type": "integer", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -34169,11 +39778,11 @@ "deprecated": null }, { - "name": "reaction_id", - "description": "", - "in": "PATH", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", "type": "integer", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -34182,26 +39791,63 @@ "deprecated": null } ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" + } + ] + }, + { "code": 404, "description": "Resource not found", "examples": null } + ], "renamed": null }, { - "name": "Delete a reaction (Legacy)", + "name": "List reactions for an issue", "scope": "reactions", - "id": "deleteLegacy", - "method": "DELETE", - "url": "/reactions/{reaction_id}", - "isDeprecated": true, - "deprecationDate": "2020-02-26", - "removalDate": "2021-02-21", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this [blog post](https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/).\n\nOAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments).", - "documentationUrl": "https://docs.github.com/rest/reference/reactions/#delete-a-reaction-legacy", + "id": "listForIssue", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "List the reactions to an [issue](https://docs.github.com/rest/reference/issues).", + "documentationUrl": "https://docs.github.com/rest/reference/reactions#list-reactions-for-an-issue", "previews": [], "headers": [], "parameters": [ { - "name": "reaction_id", - "description": "", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", "in": "PATH", "type": "integer", "required": true, @@ -34211,38 +39857,88 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "content", + "description": "Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, { - "code": 401, - "description": "Requires authentication", - "examples": null + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" + } + ] }, - { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, { "code": 410, "description": "Gone", "examples": null } ], "renamed": null }, { - "name": "List reactions for a commit comment", + "name": "List reactions for an issue comment", "scope": "reactions", - "id": "listForCommitComment", + "id": "listForIssueComment", "method": "GET", - "url": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", + "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments).", - "documentationUrl": "https://docs.github.com/rest/reference/reactions#list-reactions-for-a-commit-comment", + "description": "List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments).", + "documentationUrl": "https://docs.github.com/rest/reference/reactions#list-reactions-for-an-issue-comment", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -34255,7 +39951,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -34268,7 +39964,7 @@ }, { "name": "comment_id", - "description": "comment_id parameter", + "description": "The unique identifier of the comment.", "in": "PATH", "type": "integer", "required": true, @@ -34281,7 +39977,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a commit comment.", + "description": "Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue comment.", "in": "QUERY", "type": "string", "required": false, @@ -34303,7 +39999,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -34343,22 +40039,22 @@ "renamed": null }, { - "name": "List reactions for an issue", + "name": "List reactions for a pull request review comment", "scope": "reactions", - "id": "listForIssue", + "id": "listForPullRequestReviewComment", "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", + "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "List the reactions to an [issue](https://docs.github.com/rest/reference/issues).", - "documentationUrl": "https://docs.github.com/rest/reference/reactions#list-reactions-for-an-issue", + "description": "List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments).", + "documentationUrl": "https://docs.github.com/rest/reference/reactions#list-reactions-for-a-pull-request-review-comment", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -34371,7 +40067,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -34383,8 +40079,8 @@ "deprecated": null }, { - "name": "issue_number", - "description": "issue_number parameter", + "name": "comment_id", + "description": "The unique identifier of the comment.", "in": "PATH", "type": "integer", "required": true, @@ -34397,7 +40093,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue.", + "description": "Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a pull request review comment.", "in": "QUERY", "type": "string", "required": false, @@ -34419,124 +40115,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "List reactions for an issue comment", - "scope": "reactions", - "id": "listForIssueComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments).", - "documentationUrl": "https://docs.github.com/rest/reference/reactions#list-reactions-for-an-issue-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "comment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue comment.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -34576,22 +40155,22 @@ "renamed": null }, { - "name": "List reactions for a pull request review comment", + "name": "List reactions for a release", "scope": "reactions", - "id": "listForPullRequestReviewComment", + "id": "listForRelease", "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", + "url": "/repos/{owner}/{repo}/releases/{release_id}/reactions", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments).", - "documentationUrl": "https://docs.github.com/rest/reference/reactions#list-reactions-for-a-pull-request-review-comment", + "description": "List the reactions to a [release](https://docs.github.com/rest/reference/repos#releases).", + "documentationUrl": "https://docs.github.com/rest/reference/reactions/#list-reactions-for-a-release", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -34604,7 +40183,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -34616,8 +40195,8 @@ "deprecated": null }, { - "name": "comment_id", - "description": "comment_id parameter", + "name": "release_id", + "description": "The unique identifier of the release.", "in": "PATH", "type": "integer", "required": true, @@ -34630,20 +40209,11 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a pull request review comment.", + "description": "Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a release.", "in": "QUERY", "type": "string", "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], + "enum": ["+1", "laugh", "heart", "hooray", "rocket", "eyes"], "allowNull": false, "mapToData": null, "validation": null, @@ -34652,7 +40222,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -34707,7 +40277,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -34720,7 +40290,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -34733,7 +40303,7 @@ }, { "name": "discussion_number", - "description": "", + "description": "The number that identifies the discussion.", "in": "PATH", "type": "integer", "required": true, @@ -34746,7 +40316,7 @@ }, { "name": "comment_number", - "description": "", + "description": "The number that identifies the comment.", "in": "PATH", "type": "integer", "required": true, @@ -34781,7 +40351,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -34835,7 +40405,7 @@ "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -34848,7 +40418,7 @@ }, { "name": "discussion_number", - "description": "", + "description": "The number that identifies the discussion.", "in": "PATH", "type": "integer", "required": true, @@ -34861,7 +40431,7 @@ }, { "name": "comment_number", - "description": "", + "description": "The number that identifies the comment.", "in": "PATH", "type": "integer", "required": true, @@ -34896,7 +40466,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -34950,7 +40520,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -34963,7 +40533,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -34976,7 +40546,7 @@ }, { "name": "discussion_number", - "description": "", + "description": "The number that identifies the discussion.", "in": "PATH", "type": "integer", "required": true, @@ -35011,7 +40581,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -35065,7 +40635,7 @@ "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -35078,7 +40648,7 @@ }, { "name": "discussion_number", - "description": "", + "description": "The number that identifies the discussion.", "in": "PATH", "type": "integer", "required": true, @@ -35113,7 +40683,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -35167,7 +40737,7 @@ "parameters": [ { "name": "invitation_id", - "description": "invitation_id parameter", + "description": "The unique identifier of the invitation.", "in": "PATH", "type": "integer", "required": true, @@ -35212,7 +40782,7 @@ "parameters": [ { "name": "invitation_id", - "description": "invitation_id parameter", + "description": "The unique identifier of the invitation.", "in": "PATH", "type": "integer", "required": true, @@ -35242,14 +40812,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "documentationUrl": "https://docs.github.com/rest/reference/repos#add-app-access-restrictions", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -35262,7 +40832,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -35323,14 +40893,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/rest/reference/repos#invitations).\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", + "description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/rest/reference/repos#invitations).\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", "documentationUrl": "https://docs.github.com/rest/reference/repos#add-a-repository-collaborator", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -35343,7 +40913,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -35356,7 +40926,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -35369,7 +40939,7 @@ }, { "name": "permission", - "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access. \n\\* custom repository role name - Can assign a custom repository role if the owning organization has defined any.", + "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** In addition to the enumerated values, you can also specify a custom repository role name, if the owning organization has defined any.", "in": "BODY", "type": "string", "required": false, @@ -35379,19 +40949,6 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "permissions", - "description": "", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null } ], "responses": [ @@ -35406,7 +40963,7 @@ }, { "code": 204, - "description": "Response when person is already a collaborator", + "description": "Response when:\n- an existing collaborator is added as a collaborator\n- an organization member is added as an individual collaborator\n- an existing team member (whose team is also a repository collaborator) is added as an individual collaborator", "examples": null }, { "code": 403, "description": "Forbidden", "examples": null }, @@ -35423,14 +40980,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "documentationUrl": "https://docs.github.com/rest/reference/repos#add-status-check-contexts", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -35443,7 +41000,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -35506,14 +41063,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "documentationUrl": "https://docs.github.com/rest/reference/repos#add-team-access-restrictions", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -35526,7 +41083,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -35587,14 +41144,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified people push access for this branch.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified people push access for this branch.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "documentationUrl": "https://docs.github.com/rest/reference/repos#add-user-access-restrictions", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -35607,7 +41164,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -35668,14 +41225,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nTeam members will include the members of child teams.", + "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nTeam members will include the members of child teams.\n\nYou must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this\nendpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this\nendpoint.", "documentationUrl": "https://docs.github.com/rest/reference/repos#check-if-a-user-is-a-repository-collaborator", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -35688,7 +41245,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -35701,7 +41258,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -35736,14 +41293,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\".", + "description": "Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\".", "documentationUrl": "https://docs.github.com/rest/reference/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -35756,7 +41313,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -35782,6 +41339,74 @@ ], "renamed": null }, + { + "name": "List CODEOWNERS errors", + "scope": "repos", + "id": "codeownersErrors", + "method": "GET", + "url": "/repos/{owner}/{repo}/codeowners/errors", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "List any syntax errors that are detected in the CODEOWNERS\nfile.\n\nFor more information about the correct CODEOWNERS syntax,\nsee \"[About code owners](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).\"", + "documentationUrl": "https://docs.github.com/rest/reference/repos#list-codeowners-errors", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "ref", + "description": "A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository's default branch (e.g. `main`)", + "in": "QUERY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"errors\":[{\"line\":3,\"column\":1,\"kind\":\"Invalid pattern\",\"source\":\"***/*.rb @monalisa\",\"suggestion\":\"Did you mean `**/*.rb`?\",\"message\":\"Invalid pattern on line 3: Did you mean `**/*.rb`?\\n\\n ***/*.rb @monalisa\\n ^\",\"path\":\".github/CODEOWNERS\"},{\"line\":7,\"column\":7,\"kind\":\"Invalid owner\",\"source\":\"*.txt docs@\",\"suggestion\":null,\"message\":\"Invalid owner on line 7:\\n\\n *.txt docs@\\n ^\",\"path\":\".github/CODEOWNERS\"}]}" + } + ] + }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, { "name": "Compare two commits", "scope": "repos", @@ -35906,7 +41531,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -35919,7 +41544,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -35945,7 +41570,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -36001,7 +41626,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -36014,7 +41639,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -36082,7 +41707,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -36095,7 +41720,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -36108,7 +41733,7 @@ }, { "name": "commit_sha", - "description": "commit_sha parameter", + "description": "The SHA of the commit.", "in": "PATH", "type": "string", "required": true, @@ -36196,14 +41821,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.", "documentationUrl": "https://docs.github.com/rest/reference/repos#create-commit-signature-protection", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -36216,7 +41841,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -36271,7 +41896,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -36284,7 +41909,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -36310,7 +41935,7 @@ }, { "name": "state", - "description": "The state of the status. Can be one of `error`, `failure`, `pending`, or `success`.", + "description": "The state of the status.", "in": "BODY", "type": "string", "required": true, @@ -36390,7 +42015,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -36403,7 +42028,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -36442,7 +42067,7 @@ }, { "name": "read_only", - "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://help.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://help.github.com/articles/permission-levels-for-a-user-account-repository/).\"", + "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"", "in": "BODY", "type": "boolean", "required": false, @@ -36477,14 +42102,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deployments offer a few configurable parameters with certain defaults.\n\nThe `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them\nbefore we merge a pull request.\n\nThe `environment` parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is `production`.\n\nThe `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.\n\nBy default, [commit statuses](https://docs.github.com/rest/reference/repos#statuses) for every submitted context must be in a `success`\nstate. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.\n\nUsers with `repo` or `repo_deployment` scopes can create a deployment for a given ref.\n\n#### Merged branch response\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\n#### Merge conflict response\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't\nbe merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\n#### Failed commit status checks\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.", + "description": "Deployments offer a few configurable parameters with certain defaults.\n\nThe `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them\nbefore we merge a pull request.\n\nThe `environment` parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is `production`.\n\nThe `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.\n\nBy default, [commit statuses](https://docs.github.com/rest/commits/statuses) for every submitted context must be in a `success`\nstate. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.\n\nUsers with `repo` or `repo_deployment` scopes can create a deployment for a given ref.\n\n#### Merged branch response\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\n#### Merge conflict response\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't\nbe merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\n#### Failed commit status checks\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.", "documentationUrl": "https://docs.github.com/rest/reference/repos#create-a-deployment", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -36497,7 +42122,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -36549,7 +42174,7 @@ }, { "name": "required_contexts", - "description": "The [status](https://docs.github.com/rest/reference/repos#statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.", + "description": "The [status](https://docs.github.com/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.", "in": "BODY", "type": "string[]", "required": false, @@ -36670,7 +42295,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -36683,7 +42308,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -36709,7 +42334,7 @@ }, { "name": "state", - "description": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.", + "description": "The state of the status. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.", "in": "BODY", "type": "string", "required": true, @@ -36830,14 +42455,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see \"[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch).\"\n\nThe `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow.\n\nThis endpoint requires write access to the repository by providing either:\n\n - Personal access tokens with `repo` scope. For more information, see \"[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)\" in the GitHub Help documentation.\n - GitHub Apps with both `metadata:read` and `contents:read&write` permissions.\n\nThis input example shows how you can use the `client_payload` as a test to debug your workflow.", + "description": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see \"[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch).\"\n\nThe `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow.\n\nThis endpoint requires write access to the repository by providing either:\n\n - Personal access tokens with `repo` scope. For more information, see \"[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)\" in the GitHub Help documentation.\n - GitHub Apps with both `metadata:read` and `contents:read&write` permissions.\n\nThis input example shows how you can use the `client_payload` as a test to debug your workflow.", "documentationUrl": "https://docs.github.com/rest/reference/repos#create-a-repository-dispatch-event", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -36850,7 +42475,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -36863,7 +42488,7 @@ }, { "name": "event_type", - "description": "A custom webhook event name.", + "description": "A custom webhook event name. Must be 100 characters or fewer.", "in": "BODY", "type": "string", "required": true, @@ -37196,7 +42821,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -37209,7 +42834,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -37268,7 +42893,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -37333,11 +42958,11 @@ }, { "name": "visibility", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation.", + "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation.", "in": "BODY", "type": "string", "required": false, - "enum": ["public", "private", "visibility", "internal"], + "enum": ["public", "private", "internal"], "allowNull": false, "mapToData": null, "validation": null, @@ -37437,7 +43062,7 @@ }, { "name": "license_template", - "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", + "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", "in": "BODY", "type": "string", "required": false, @@ -37512,6 +43137,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "use_squash_pr_title_as_default", + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -37545,7 +43183,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -37558,7 +43196,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -37610,7 +43248,7 @@ }, { "name": "reviewers[].type", - "description": "The type of reviewer. Must be one of: `User` or `Team`", + "description": "The type of reviewer.", "in": "BODY", "type": "string", "required": false, @@ -37708,7 +43346,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -37721,7 +43359,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -37943,7 +43581,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -37956,7 +43594,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -37972,7 +43610,7 @@ "description": "The source branch and directory used to publish your Pages site.", "in": "BODY", "type": "object", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -38038,7 +43676,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -38051,7 +43689,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -38186,6 +43824,71 @@ ], "renamed": null }, + { + "name": "Create a tag protection state for a repository", + "scope": "repos", + "id": "createTagProtection", + "method": "POST", + "url": "/repos/{owner}/{repo}/tags/protection", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "This creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.", + "documentationUrl": "https://docs.github.com/rest/reference/repos#create-tag-protection-state-for-a-repository", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "pattern", + "description": "An optional glob pattern to match against when enforcing tag protection.", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 201, + "description": "Response", + "examples": [{ "data": "{\"enabled\":true}" }] + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, { "name": "Create a repository using a template", "scope": "repos", @@ -38321,7 +44024,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -38334,7 +44037,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -38508,7 +44211,7 @@ "parameters": [ { "name": "invitation_id", - "description": "invitation_id parameter", + "description": "The unique identifier of the invitation.", "in": "PATH", "type": "integer", "required": true, @@ -38553,7 +44256,7 @@ "parameters": [ { "name": "invitation_id", - "description": "invitation_id parameter", + "description": "The unique identifier of the invitation.", "in": "PATH", "type": "integer", "required": true, @@ -38590,7 +44293,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -38603,7 +44306,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -38640,14 +44343,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nDisables the ability to restrict who can push to this branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nDisables the ability to restrict who can push to this branch.", "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-access-restrictions", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -38660,7 +44363,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -38697,14 +44400,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-admin-branch-protection", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -38717,7 +44420,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -38764,7 +44467,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -38777,7 +44480,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -38823,7 +44526,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -38836,7 +44539,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -38849,7 +44552,7 @@ }, { "name": "autolink_id", - "description": "autolink_id parameter", + "description": "The unique identifier of the autolink.", "in": "PATH", "type": "integer", "required": true, @@ -38876,14 +44579,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-branch-protection", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -38896,7 +44599,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -38943,7 +44646,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -38956,7 +44659,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -38969,7 +44672,7 @@ }, { "name": "comment_id", - "description": "comment_id parameter", + "description": "The unique identifier of the comment.", "in": "PATH", "type": "integer", "required": true, @@ -38996,14 +44699,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.", "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-commit-signature-protection", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -39016,7 +44719,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -39063,7 +44766,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -39076,7 +44779,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -39089,7 +44792,7 @@ }, { "name": "key_id", - "description": "key_id parameter", + "description": "The unique identifier of the key.", "in": "PATH", "type": "integer", "required": true, @@ -39113,14 +44816,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "To ensure there can always be an active deployment, you can only delete an _inactive_ deployment. Anyone with `repo` or `repo_deployment` scopes can delete an inactive deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/rest/reference/repos/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/rest/reference/repos#create-a-deployment-status).\"", + "description": "If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/rest/reference/repos/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/rest/reference/repos#create-a-deployment-status).\"", "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-a-deployment", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -39133,7 +44836,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -39181,7 +44884,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -39194,7 +44897,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -39369,7 +45072,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -39382,7 +45085,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -39395,7 +45098,7 @@ }, { "name": "invitation_id", - "description": "invitation_id parameter", + "description": "The unique identifier of the invitation.", "in": "PATH", "type": "integer", "required": true, @@ -39426,7 +45129,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -39439,7 +45142,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -39467,14 +45170,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-pull-request-review-protection", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -39487,7 +45190,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -39534,7 +45237,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -39547,7 +45250,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -39560,7 +45263,7 @@ }, { "name": "release_id", - "description": "release_id parameter", + "description": "The unique identifier of the release.", "in": "PATH", "type": "integer", "required": true, @@ -39591,7 +45294,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -39604,7 +45307,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -39617,7 +45320,7 @@ }, { "name": "asset_id", - "description": "asset_id parameter", + "description": "The unique identifier of the asset.", "in": "PATH", "type": "integer", "required": true, @@ -39632,6 +45335,67 @@ "responses": [{ "code": 204, "description": "Response", "examples": null }], "renamed": null }, + { + "name": "Delete a tag protection state for a repository", + "scope": "repos", + "id": "deleteTagProtection", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "This deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.", + "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-tag-protection-state-for-a-repository", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "tag_protection_id", + "description": "The unique identifier of the tag protection.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { "code": 204, "description": "Response", "examples": null }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, { "name": "Delete a repository webhook", "scope": "repos", @@ -39648,7 +45412,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -39661,7 +45425,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -39674,7 +45438,7 @@ }, { "name": "hook_id", - "description": "", + "description": "The unique identifier of the hook.", "in": "PATH", "type": "integer", "required": true, @@ -39701,14 +45465,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring automated security fixes](https://help.github.com/en/articles/configuring-automated-security-fixes)\".", + "description": "Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)\".", "documentationUrl": "https://docs.github.com/rest/reference/repos#disable-automated-security-fixes", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -39721,7 +45485,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -39745,14 +45509,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note:** The Git LFS API endpoints are currently in beta and are subject to change.", + "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#disable-git-lfs-for-a-repository", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -39765,7 +45529,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -39789,14 +45553,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\".", + "description": "Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\".", "documentationUrl": "https://docs.github.com/rest/reference/repos#disable-vulnerability-alerts", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -39809,7 +45573,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -39840,7 +45604,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -39853,7 +45617,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -39902,7 +45666,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -39915,7 +45679,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -39964,7 +45728,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -39977,7 +45741,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -40021,7 +45785,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -40034,7 +45798,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -40071,14 +45835,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring automated security fixes](https://help.github.com/en/articles/configuring-automated-security-fixes)\".", + "description": "Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)\".", "documentationUrl": "https://docs.github.com/rest/reference/repos#enable-automated-security-fixes", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -40091,7 +45855,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -40115,14 +45879,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note:** The Git LFS API endpoints are currently in beta and are subject to change.", + "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#enable-git-lfs-for-a-repository", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -40135,7 +45899,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -40166,14 +45930,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\".", + "description": "Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\".", "documentationUrl": "https://docs.github.com/rest/reference/repos#enable-vulnerability-alerts", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -40186,7 +45950,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -40217,7 +45981,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -40230,7 +45994,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -40324,7 +46088,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -40337,7 +46101,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -40374,14 +46138,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch.\n\n**Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch.\n\n**Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-access-restrictions", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -40394,7 +46158,75 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "branch", + "description": "The name of the branch.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\"apps_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]}" + } + ] + }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "Get admin branch protection", + "scope": "repos", + "id": "getAdminBranchProtection", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/rest/reference/repos#get-admin-branch-protection", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -40425,31 +46257,30 @@ "description": "Response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\"apps_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\"enabled\":true}" } ] - }, - { "code": 404, "description": "Resource not found", "examples": null } + } ], "renamed": null }, { - "name": "Get admin branch protection", + "name": "Get all environments", "scope": "repos", - "id": "getAdminBranchProtection", + "id": "getAllEnvironments", "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", + "url": "/repos/{owner}/{repo}/environments", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/rest/reference/repos#get-admin-branch-protection", + "description": "Get all environments for a repository.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/repos#get-all-environments", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -40462,7 +46293,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -40474,52 +46305,11 @@ "deprecated": null }, { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\"enabled\":true}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get all environments", - "scope": "repos", - "id": "getAllEnvironments", - "method": "GET", - "url": "/repos/{owner}/{repo}/environments", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Get all environments for a repository.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/repos#get-all-environments", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -40528,11 +46318,11 @@ "deprecated": null }, { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -40563,14 +46353,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-all-status-check-contexts", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -40583,7 +46373,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -40629,12 +46419,12 @@ "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-all-repository-topics", - "previews": [{ "name": "mercy" }], + "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -40647,7 +46437,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -40673,7 +46463,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -40693,8 +46483,7 @@ { "data": "{\"names\":[\"octocat\",\"atom\",\"electron\",\"api\"]}" } ] }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } + { "code": 404, "description": "Resource not found", "examples": null } ], "renamed": null }, @@ -40707,14 +46496,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-apps-with-access-to-the-protected-branch", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -40727,7 +46516,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -40782,7 +46571,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -40795,7 +46584,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -40808,7 +46597,7 @@ }, { "name": "autolink_id", - "description": "autolink_id parameter", + "description": "The unique identifier of the autolink.", "in": "PATH", "type": "integer", "required": true, @@ -40850,7 +46639,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -40863,7 +46652,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -40891,8 +46680,7 @@ "responses": [ { "code": 200, "description": "Response", "examples": null }, { "code": 301, "description": "Moved permanently", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } + { "code": 404, "description": "Resource not found", "examples": null } ], "renamed": null }, @@ -40905,14 +46693,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-branch-protection", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -40925,7 +46713,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -40956,7 +46744,7 @@ "description": "Response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection\",\"required_status_checks\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks\",\"contexts\":[\"continuous-integration/travis-ci\"],\"contexts_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts\",\"enforcement_level\":\"non_admins\"},\"enforce_admins\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\"enabled\":true},\"required_pull_request_reviews\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2},\"restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\"apps_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]},\"required_linear_history\":{\"enabled\":true},\"allow_force_pushes\":{\"enabled\":true},\"allow_deletions\":{\"enabled\":true},\"required_conversation_resolution\":{\"enabled\":true}}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection\",\"required_status_checks\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks\",\"contexts\":[\"continuous-integration/travis-ci\"],\"contexts_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts\",\"enforcement_level\":\"non_admins\"},\"enforce_admins\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\"enabled\":true},\"required_pull_request_reviews\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2},\"restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\"apps_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]},\"required_linear_history\":{\"enabled\":true},\"allow_force_pushes\":{\"enabled\":true},\"allow_deletions\":{\"enabled\":true},\"required_conversation_resolution\":{\"enabled\":true}}" } ] }, @@ -40980,7 +46768,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -40993,7 +46781,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -41006,7 +46794,7 @@ }, { "name": "per", - "description": "Must be one of: `day`, `week`.", + "description": "The time frame to display results for.", "in": "QUERY", "type": "string", "required": false, @@ -41048,7 +46836,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -41061,7 +46849,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -41104,7 +46892,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -41117,7 +46905,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -41130,7 +46918,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -41148,7 +46936,7 @@ "description": "if user has admin permissions", "examples": [ { - "data": "{\"permission\":\"admin\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" + "data": "{\"permission\":\"admin\",\"role_name\":\"admin\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" } ] }, @@ -41165,14 +46953,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\nThe most recent status for each context is returned, up to 100. This field [paginates](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination) if there are over 100 contexts.\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`", + "description": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-the-combined-status-for-a-specific-reference", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -41185,7 +46973,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -41211,7 +46999,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -41266,7 +47054,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -41279,7 +47067,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -41305,7 +47093,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -41362,7 +47150,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -41375,7 +47163,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -41422,7 +47210,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -41435,7 +47223,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -41448,7 +47236,7 @@ }, { "name": "comment_id", - "description": "comment_id parameter", + "description": "The unique identifier of the comment.", "in": "PATH", "type": "integer", "required": true, @@ -41483,14 +47271,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://help.github.com/articles/signing-commits-with-gpg) in GitHub Help.\n\n**Note**: You must enable branch protection to require signed commits.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help.\n\n**Note**: You must enable branch protection to require signed commits.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-commit-signature-protection", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -41503,7 +47291,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -41558,7 +47346,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -41571,7 +47359,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -41605,14 +47393,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit\n`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. \n\nFiles and symlinks support [a custom media type](https://docs.github.com/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Note**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/rest/reference/git#get-a-tree).\n* This API supports files up to 1 megabyte in size.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.", + "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit\n`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. \n\nFiles and symlinks support [a custom media type](https://docs.github.com/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Note**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/rest/reference/git#get-a-tree).\n\n#### Size limits\nIf the requested file's size is:\n* 1 MB or smaller: All features of this endpoint are supported.\n* Between 1-100 MB: Only the `raw` or `object` [custom media types](https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents) are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty string and the `encoding` field will be `\"none\"`. To get the contents of these larger files, use the `raw` media type.\n * Greater than 100 MB: This endpoint is not supported.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-repository-content", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -41625,7 +47413,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -41705,7 +47493,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -41718,7 +47506,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -41765,7 +47553,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -41778,7 +47566,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -41791,7 +47579,7 @@ }, { "name": "key_id", - "description": "key_id parameter", + "description": "The unique identifier of the key.", "in": "PATH", "type": "integer", "required": true, @@ -41833,7 +47621,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -41846,7 +47634,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -41901,7 +47689,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -41914,7 +47702,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -41982,7 +47770,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -41995,7 +47783,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -42049,7 +47837,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -42062,7 +47850,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -42103,7 +47891,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -42116,7 +47904,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -42157,7 +47945,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -42170,7 +47958,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -42212,7 +48000,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -42225,7 +48013,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -42279,7 +48067,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -42292,7 +48080,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -42345,7 +48133,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -42358,7 +48146,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -42393,14 +48181,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-pull-request-review-protection", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -42413,7 +48201,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -42444,7 +48232,7 @@ "description": "Response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2}" } ] } @@ -42467,7 +48255,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -42480,7 +48268,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -42522,7 +48310,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -42535,7 +48323,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -42591,7 +48379,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -42604,7 +48392,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -42673,7 +48461,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -42686,7 +48474,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -42699,7 +48487,7 @@ }, { "name": "release_id", - "description": "release_id parameter", + "description": "The unique identifier of the release.", "in": "PATH", "type": "integer", "required": true, @@ -42741,7 +48529,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -42754,7 +48542,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -42767,7 +48555,7 @@ }, { "name": "asset_id", - "description": "asset_id parameter", + "description": "The unique identifier of the asset.", "in": "PATH", "type": "integer", "required": true, @@ -42790,8 +48578,7 @@ ] }, { "code": 302, "description": "Found", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } + { "code": 404, "description": "Resource not found", "examples": null } ], "renamed": null }, @@ -42811,7 +48598,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -42824,7 +48611,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -42872,14 +48659,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-status-checks-protection", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -42892,7 +48679,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -42940,14 +48727,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-teams-with-access-to-the-protected-branch", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -42960,7 +48747,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -43015,7 +48802,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -43028,7 +48815,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -43070,7 +48857,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -43083,7 +48870,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -43118,14 +48905,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch.", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-users-with-access-to-the-protected-branch", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -43138,7 +48925,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -43193,7 +48980,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -43206,7 +48993,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -43219,7 +49006,7 @@ }, { "name": "per", - "description": "Must be one of: `day`, `week`.", + "description": "The time frame to display results for.", "in": "QUERY", "type": "string", "required": false, @@ -43261,7 +49048,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -43274,7 +49061,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -43287,7 +49074,7 @@ }, { "name": "hook_id", - "description": "", + "description": "The unique identifier of the hook.", "in": "PATH", "type": "integer", "required": true, @@ -43329,7 +49116,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -43342,7 +49129,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -43355,7 +49142,7 @@ }, { "name": "hook_id", - "description": "", + "description": "The unique identifier of the hook.", "in": "PATH", "type": "integer", "required": true, @@ -43396,7 +49183,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -43409,7 +49196,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -43422,7 +49209,7 @@ }, { "name": "hook_id", - "description": "", + "description": "The unique identifier of the hook.", "in": "PATH", "type": "integer", "required": true, @@ -43479,7 +49266,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -43492,7 +49279,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -43546,7 +49333,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -43559,7 +49346,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -43585,7 +49372,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -43633,14 +49420,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-branches-for-head-commit", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -43653,7 +49440,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -43666,7 +49453,7 @@ }, { "name": "commit_sha", - "description": "commit_sha parameter", + "description": "The SHA of the commit.", "in": "PATH", "type": "string", "required": true, @@ -43701,14 +49488,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nTeam members will include the members of child teams.", + "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.\n\nTeam members will include the members of child teams.\n\nYou must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this\nendpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this\nendpoint.", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-repository-collaborators", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -43721,7 +49508,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -43734,7 +49521,7 @@ }, { "name": "affiliation", - "description": "Filter collaborators returned by their affiliation. Can be one of: \n\\* `outside`: All outside collaborators of an organization-owned repository. \n\\* `direct`: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.", + "description": "Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` means all collaborators with permissions to an organization-owned repository, regardless of organization membership status. `all` means all collaborators the authenticated user can see.", "in": "QUERY", "type": "string", "required": false, @@ -43747,7 +49534,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -43778,7 +49565,7 @@ "description": "Response", "examples": [ { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false,\"permissions\":{\"pull\":true,\"push\":true,\"admin\":false}}]" + "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false,\"permissions\":{\"pull\":true,\"triage\":true,\"push\":true,\"maintain\":false,\"admin\":false},\"role_name\":\"write\"}]" } ] }, @@ -43802,7 +49589,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -43815,7 +49602,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -43828,7 +49615,7 @@ }, { "name": "commit_sha", - "description": "commit_sha parameter", + "description": "The SHA of the commit.", "in": "PATH", "type": "string", "required": true, @@ -43841,7 +49628,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -43895,7 +49682,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -43908,7 +49695,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -43921,7 +49708,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -43975,7 +49762,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -43988,7 +49775,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -44014,7 +49801,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -44069,7 +49856,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -44082,7 +49869,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -44160,7 +49947,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -44219,7 +50006,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -44232,7 +50019,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -44258,7 +50045,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -44319,7 +50106,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -44332,7 +50119,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -44345,7 +50132,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -44399,7 +50186,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -44412,7 +50199,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -44438,7 +50225,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -44493,7 +50280,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -44506,7 +50293,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -44571,7 +50358,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -44625,7 +50412,7 @@ "parameters": [ { "name": "visibility", - "description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.", + "description": "Limit results to repositories with the specified visibility.", "in": "QUERY", "type": "string", "required": false, @@ -44651,7 +50438,7 @@ }, { "name": "type", - "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", + "description": "Limit results to repositories of the specified type. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", "in": "QUERY", "type": "string", "required": false, @@ -44664,7 +50451,7 @@ }, { "name": "sort", - "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", + "description": "The property to sort the results by.", "in": "QUERY", "type": "string", "required": false, @@ -44677,7 +50464,7 @@ }, { "name": "direction", - "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`", + "description": "The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.", "in": "QUERY", "type": "string", "required": false, @@ -44690,7 +50477,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -44778,7 +50565,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -44791,7 +50578,7 @@ }, { "name": "type", - "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`. However, the `internal` value is not yet supported when a GitHub App calls this API with an installation access token.", + "description": "Specifies the types of repositories you want returned. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`. However, the `internal` value is not yet supported when a GitHub App calls this API with an installation access token.", "in": "QUERY", "type": "string", "required": false, @@ -44812,7 +50599,7 @@ }, { "name": "sort", - "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", + "description": "The property to sort the results by.", "in": "QUERY", "type": "string", "required": false, @@ -44825,7 +50612,7 @@ }, { "name": "direction", - "description": "Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc`", + "description": "The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.", "in": "QUERY", "type": "string", "required": false, @@ -44838,7 +50625,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -44869,7 +50656,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" } ] } @@ -44892,7 +50679,7 @@ "parameters": [ { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -44905,7 +50692,7 @@ }, { "name": "type", - "description": "Can be one of `all`, `owner`, `member`.", + "description": "Limit results to repositories of the specified type.", "in": "QUERY", "type": "string", "required": false, @@ -44918,7 +50705,7 @@ }, { "name": "sort", - "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", + "description": "The property to sort the results by.", "in": "QUERY", "type": "string", "required": false, @@ -44931,7 +50718,7 @@ }, { "name": "direction", - "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`", + "description": "The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.", "in": "QUERY", "type": "string", "required": false, @@ -44944,7 +50731,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -44975,7 +50762,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" } ] } @@ -44998,7 +50785,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -45011,7 +50798,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -45037,7 +50824,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -45093,7 +50880,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -45106,7 +50893,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -45119,7 +50906,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -45173,7 +50960,7 @@ "parameters": [ { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -45235,7 +51022,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -45248,7 +51035,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -45285,7 +51072,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -45298,7 +51085,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -45311,7 +51098,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -45401,14 +51188,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests) endpoint.", + "description": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests.", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-pull-requests-associated-with-a-commit", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -45421,7 +51208,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -45434,7 +51221,7 @@ }, { "name": "commit_sha", - "description": "commit_sha parameter", + "description": "The SHA of the commit.", "in": "PATH", "type": "string", "required": true, @@ -45447,7 +51234,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -45501,7 +51288,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -45514,7 +51301,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -45527,7 +51314,7 @@ }, { "name": "release_id", - "description": "release_id parameter", + "description": "The unique identifier of the release.", "in": "PATH", "type": "integer", "required": true, @@ -45540,7 +51327,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -45594,7 +51381,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -45607,7 +51394,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -45620,7 +51407,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -45659,6 +51446,58 @@ ], "renamed": null }, + { + "name": "List tag protection states for a repository", + "scope": "repos", + "id": "listTagProtection", + "method": "GET", + "url": "/repos/{owner}/{repo}/tags/protection", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "This returns the tag protection states of a repository.\n\nThis information is only available to repository administrators.", + "documentationUrl": "https://docs.github.com/rest/reference/repos#list-tag-protection-state-of-a-repository", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [{ "data": "[{\"id\":2,\"pattern\":\"v1.*\"}]" }] + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, { "name": "List repository tags", "scope": "repos", @@ -45675,7 +51514,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -45688,7 +51527,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -45701,7 +51540,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -45755,7 +51594,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -45768,7 +51607,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -45781,7 +51620,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -45835,7 +51674,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -45848,7 +51687,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -45861,7 +51700,7 @@ }, { "name": "hook_id", - "description": "", + "description": "The unique identifier of the hook.", "in": "PATH", "type": "integer", "required": true, @@ -45874,7 +51713,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -45931,7 +51770,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -45944,7 +51783,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -45957,7 +51796,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -46012,7 +51851,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -46025,7 +51864,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -46115,14 +51954,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note:** This endpoint is currently in beta and subject to change.\n\nSync a branch of a forked repository to keep it up-to-date with the upstream repository.", + "description": "Sync a branch of a forked repository to keep it up-to-date with the upstream repository.", "documentationUrl": "https://docs.github.com/rest/reference/repos#sync-a-fork-branch-with-the-upstream-repository", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -46135,7 +51974,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -46199,7 +52038,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -46212,7 +52051,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -46225,7 +52064,7 @@ }, { "name": "hook_id", - "description": "", + "description": "The unique identifier of the hook.", "in": "PATH", "type": "integer", "required": true, @@ -46259,7 +52098,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -46272,7 +52111,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -46285,7 +52124,7 @@ }, { "name": "hook_id", - "description": "", + "description": "The unique identifier of the hook.", "in": "PATH", "type": "integer", "required": true, @@ -46327,14 +52166,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "documentationUrl": "https://docs.github.com/rest/reference/repos#remove-app-access-restrictions", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -46347,7 +52186,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -46415,7 +52254,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -46428,7 +52267,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -46441,7 +52280,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -46465,14 +52304,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "documentationUrl": "https://docs.github.com/rest/reference/repos#remove-status-check-contexts", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -46485,7 +52324,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -46543,14 +52382,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "documentationUrl": "https://docs.github.com/rest/reference/repos#remove-status-check-protection", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -46563,7 +52402,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -46600,14 +52439,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "documentationUrl": "https://docs.github.com/rest/reference/repos#remove-team-access-restrictions", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -46620,7 +52459,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -46681,14 +52520,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a user to push to this branch.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a user to push to this branch.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "documentationUrl": "https://docs.github.com/rest/reference/repos#remove-user-access-restrictions", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -46701,7 +52540,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -46769,7 +52608,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -46782,7 +52621,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -46847,12 +52686,12 @@ "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#replace-all-repository-topics", - "previews": [{ "name": "mercy" }], + "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -46865,7 +52704,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -46899,11 +52738,6 @@ ] }, { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, { "code": 422, "description": "Validation failed", "examples": null } ], "renamed": null @@ -46924,7 +52758,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -46937,7 +52771,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -46971,14 +52805,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", "documentationUrl": "https://docs.github.com/rest/reference/repos#set-admin-branch-protection", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -46991,7 +52825,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -47038,14 +52872,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "documentationUrl": "https://docs.github.com/rest/reference/repos#set-app-access-restrictions", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -47058,7 +52892,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -47119,14 +52953,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "documentationUrl": "https://docs.github.com/rest/reference/repos#set-status-check-contexts", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -47139,7 +52973,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -47197,14 +53031,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "documentationUrl": "https://docs.github.com/rest/reference/repos#set-team-access-restrictions", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -47217,7 +53051,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -47278,14 +53112,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "documentationUrl": "https://docs.github.com/rest/reference/repos#set-user-access-restrictions", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -47298,7 +53132,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -47366,7 +53200,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -47379,7 +53213,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -47392,7 +53226,7 @@ }, { "name": "hook_id", - "description": "", + "description": "The unique identifier of the hook.", "in": "PATH", "type": "integer", "required": true, @@ -47419,14 +53253,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://help.github.com/articles/about-repository-transfers/).", + "description": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/).", "documentationUrl": "https://docs.github.com/rest/reference/repos#transfer-a-repository", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -47439,7 +53273,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -47506,7 +53340,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -47519,7 +53353,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -47571,7 +53405,7 @@ }, { "name": "private", - "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", "in": "BODY", "type": "boolean", "required": false, @@ -47588,7 +53422,7 @@ "in": "BODY", "type": "string", "required": false, - "enum": ["public", "private", "visibility", "internal"], + "enum": ["public", "private", "internal"], "allowNull": false, "mapToData": null, "validation": null, @@ -47660,6 +53494,32 @@ "alias": null, "deprecated": null }, + { + "name": "security_and_analysis.secret_scanning_push_protection", + "description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", + "in": "BODY", + "type": "object", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "security_and_analysis.secret_scanning_push_protection.status", + "description": "Can be `enabled` or `disabled`.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "has_issues", "description": "Either `true` to enable issues for this repository or `false` to disable them.", @@ -47790,6 +53650,32 @@ "alias": null, "deprecated": null }, + { + "name": "allow_update_branch", + "description": "Either `true` to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "use_squash_pr_title_as_default", + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "archived", "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", @@ -47843,14 +53729,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.\n\n**Note**: The list of users, apps, and teams in total is limited to 100 items.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.\n\n**Note**: The list of users, apps, and teams in total is limited to 100 items.", "documentationUrl": "https://docs.github.com/rest/reference/repos#update-branch-protection", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -47863,7 +53749,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -47915,7 +53801,7 @@ }, { "name": "required_status_checks.contexts", - "description": "The list of status checks to require in order to merge into this branch", + "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "in": "BODY", "type": "string[]", "required": true, @@ -47926,6 +53812,45 @@ "alias": null, "deprecated": null }, + { + "name": "required_status_checks.checks", + "description": "The list of status checks to require in order to merge into this branch.", + "in": "BODY", + "type": "object[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "required_status_checks.checks[].context", + "description": "The name of the required check", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "required_status_checks.checks[].app_id", + "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "in": "BODY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "enforce_admins", "description": "Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable.", @@ -47954,7 +53879,7 @@ }, { "name": "required_pull_request_reviews.dismissal_restrictions", - "description": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", + "description": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", "in": "BODY", "type": "object", "required": false, @@ -47991,6 +53916,19 @@ "alias": null, "deprecated": null }, + { + "name": "required_pull_request_reviews.dismissal_restrictions.apps", + "description": "The list of app `slug`s with dismissal access", + "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "required_pull_request_reviews.dismiss_stale_reviews", "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", @@ -48006,7 +53944,7 @@ }, { "name": "required_pull_request_reviews.require_code_owner_reviews", - "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) review them.", + "description": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", "in": "BODY", "type": "boolean", "required": false, @@ -48019,7 +53957,7 @@ }, { "name": "required_pull_request_reviews.required_approving_review_count", - "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.", + "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.", "in": "BODY", "type": "integer", "required": false, @@ -48030,6 +53968,58 @@ "alias": null, "deprecated": null }, + { + "name": "required_pull_request_reviews.bypass_pull_request_allowances", + "description": "Allow specific users, teams, or apps to bypass pull request requirements.", + "in": "BODY", + "type": "object", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "required_pull_request_reviews.bypass_pull_request_allowances.users", + "description": "The list of user `login`s allowed to bypass pull request requirements.", + "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "required_pull_request_reviews.bypass_pull_request_allowances.teams", + "description": "The list of team `slug`s allowed to bypass pull request requirements.", + "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "required_pull_request_reviews.bypass_pull_request_allowances.apps", + "description": "The list of app `slug`s allowed to bypass pull request requirements.", + "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "restrictions", "description": "Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable.", @@ -48084,7 +54074,7 @@ }, { "name": "required_linear_history", - "description": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://help.github.com/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation.", + "description": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation.", "in": "BODY", "type": "boolean", "required": false, @@ -48097,7 +54087,7 @@ }, { "name": "allow_force_pushes", - "description": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"", + "description": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"", "in": "BODY", "type": "boolean", "required": false, @@ -48110,7 +54100,20 @@ }, { "name": "allow_deletions", - "description": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.", + "description": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "block_creations", + "description": "If set to `true`, the `restrictions` branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to `true` to restrict new branch creation. Default: `false`.", "in": "BODY", "type": "boolean", "required": false, @@ -48159,7 +54162,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -48172,7 +54175,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -48185,7 +54188,7 @@ }, { "name": "comment_id", - "description": "comment_id parameter", + "description": "The unique identifier of the comment.", "in": "PATH", "type": "integer", "required": true, @@ -48240,7 +54243,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -48253,7 +54256,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -48266,7 +54269,7 @@ }, { "name": "cname", - "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://help.github.com/articles/using-a-custom-domain-with-github-pages/).\"", + "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/).\"", "in": "BODY", "type": "string", "required": false, @@ -48341,7 +54344,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -48354,7 +54357,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -48367,7 +54370,7 @@ }, { "name": "invitation_id", - "description": "invitation_id parameter", + "description": "The unique identifier of the invitation.", "in": "PATH", "type": "integer", "required": true, @@ -48414,14 +54417,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.", "documentationUrl": "https://docs.github.com/rest/reference/repos#update-pull-request-review-protection", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -48434,7 +54437,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -48460,7 +54463,7 @@ }, { "name": "dismissal_restrictions", - "description": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", + "description": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", "in": "BODY", "type": "object", "required": false, @@ -48497,6 +54500,19 @@ "alias": null, "deprecated": null }, + { + "name": "dismissal_restrictions.apps", + "description": "The list of app `slug`s with dismissal access", + "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "dismiss_stale_reviews", "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", @@ -48512,7 +54528,7 @@ }, { "name": "require_code_owner_reviews", - "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed.", + "description": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) have reviewed.", "in": "BODY", "type": "boolean", "required": false, @@ -48525,7 +54541,7 @@ }, { "name": "required_approving_review_count", - "description": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.", + "description": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.", "in": "BODY", "type": "integer", "required": false, @@ -48535,6 +54551,58 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "bypass_pull_request_allowances", + "description": "Allow specific users, teams, or apps to bypass pull request requirements.", + "in": "BODY", + "type": "object", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "bypass_pull_request_allowances.users", + "description": "The list of user `login`s allowed to bypass pull request requirements.", + "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "bypass_pull_request_allowances.teams", + "description": "The list of team `slug`s allowed to bypass pull request requirements.", + "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "bypass_pull_request_allowances.apps", + "description": "The list of app `slug`s allowed to bypass pull request requirements.", + "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -48543,7 +54611,7 @@ "description": "Response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2}" } ] }, @@ -48567,7 +54635,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -48580,7 +54648,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -48593,7 +54661,7 @@ }, { "name": "release_id", - "description": "release_id parameter", + "description": "The unique identifier of the release.", "in": "PATH", "type": "integer", "required": true, @@ -48730,7 +54798,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -48743,7 +54811,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -48756,7 +54824,7 @@ }, { "name": "asset_id", - "description": "asset_id parameter", + "description": "The unique identifier of the asset.", "in": "PATH", "type": "integer", "required": true, @@ -48829,14 +54897,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.", - "documentationUrl": "https://docs.github.com/rest/reference/repos#update-status-check-potection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.", + "documentationUrl": "https://docs.github.com/rest/reference/repos#update-status-check-protection", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -48849,7 +54917,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -48888,7 +54956,7 @@ }, { "name": "contexts", - "description": "The list of status checks to require in order to merge into this branch", + "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "in": "BODY", "type": "string[]", "required": false, @@ -48898,6 +54966,45 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "checks", + "description": "The list of status checks to require in order to merge into this branch.", + "in": "BODY", + "type": "object[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "checks[].context", + "description": "The name of the required check", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "checks[].app_id", + "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "in": "BODY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -48929,14 +55036,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.", - "documentationUrl": "https://docs.github.com/rest/reference/repos#update-status-check-potection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.", + "documentationUrl": "https://docs.github.com/rest/reference/repos#update-status-check-protection", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -48949,7 +55056,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -48988,7 +55095,7 @@ }, { "name": "contexts", - "description": "The list of status checks to require in order to merge into this branch", + "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", "in": "BODY", "type": "string[]", "required": false, @@ -48998,6 +55105,45 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "checks", + "description": "The list of status checks to require in order to merge into this branch.", + "in": "BODY", + "type": "object[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "checks[].context", + "description": "The name of the required check", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "checks[].app_id", + "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "in": "BODY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -49031,7 +55177,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -49044,7 +55190,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -49057,7 +55203,7 @@ }, { "name": "hook_id", - "description": "", + "description": "The unique identifier of the hook.", "in": "PATH", "type": "integer", "required": true, @@ -49243,7 +55389,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -49256,7 +55402,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -49269,7 +55415,7 @@ }, { "name": "hook_id", - "description": "", + "description": "The unique identifier of the hook.", "in": "PATH", "type": "integer", "required": true, @@ -49362,7 +55508,7 @@ "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -49375,7 +55521,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -49388,7 +55534,7 @@ }, { "name": "release_id", - "description": "release_id parameter", + "description": "The unique identifier of the release.", "in": "PATH", "type": "integer", "required": true, @@ -49486,7 +55632,7 @@ "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See \"[Searching code](https://help.github.com/articles/searching-code/)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See \"[Searching code](https://docs.github.com/search-github/searching-on-github/searching-code)\" for a detailed list of qualifiers.", "in": "QUERY", "type": "string", "required": true, @@ -49525,7 +55671,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -49583,7 +55729,7 @@ "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See \"[Searching commits](https://help.github.com/articles/searching-commits/)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See \"[Searching commits](https://docs.github.com/search-github/searching-on-github/searching-commits)\" for a detailed list of qualifiers.", "in": "QUERY", "type": "string", "required": true, @@ -49622,7 +55768,223 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_count\":1,\"incomplete_results\":false,\"items\":[{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"sha\":\"bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"html_url\":\"https://github.com/octocat/Spoon-Knife/commit/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"comments_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"author\":{\"date\":\"2014-02-04T14:38:36-08:00\",\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"committer\":{\"date\":\"2014-02-12T15:18:55-08:00\",\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"message\":\"Create styles.css and updated README\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/trees/a639e96f9038797fba6e0469f94a4b0cc459fa68\",\"sha\":\"a639e96f9038797fba6e0469f94a4b0cc459fa68\"},\"comment_count\":8},\"author\":{\"login\":\"octocat\",\"id\":583231,\"node_id\":\"MDQ6VXNlcjU4MzIzMQ==\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=3\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"committer\":{},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits/a30c19e3f13765a3b48829788bc1cb8b4e95cee4\",\"html_url\":\"https://github.com/octocat/Spoon-Knife/commit/a30c19e3f13765a3b48829788bc1cb8b4e95cee4\",\"sha\":\"a30c19e3f13765a3b48829788bc1cb8b4e95cee4\"}],\"repository\":{\"id\":1300192,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMzAwMTky\",\"name\":\"Spoon-Knife\",\"full_name\":\"octocat/Spoon-Knife\",\"owner\":{\"login\":\"octocat\",\"id\":583231,\"node_id\":\"MDQ6VXNlcjU4MzIzMQ==\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=3\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Spoon-Knife\",\"description\":\"This repo is for demonstration purposes only.\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife\",\"forks_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/forks\",\"keys_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/teams\",\"hooks_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/events\",\"assignees_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/tags\",\"blobs_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/languages\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/subscription\",\"commits_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/merges\",\"archive_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/downloads\",\"issues_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/deployments\"},\"score\":1,\"node_id\":\"MDQ6VXNlcjU4MzIzMQ==\"}]}" + } + ] + }, + { "code": 304, "description": "Not modified", "examples": null } + ], + "renamed": null + }, + { + "name": "Search issues and pull requests", + "scope": "search", + "id": "issuesAndPullRequests", + "method": "GET", + "url": "/search/issues", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n**Note:** For [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", + "documentationUrl": "https://docs.github.com/rest/reference/search#search-issues-and-pull-requests", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See \"[Searching issues and pull requests](https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests)\" for a detailed list of qualifiers.", + "in": "QUERY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "sort", + "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results)", + "in": "QUERY", + "type": "string", + "required": false, + "enum": [ + "comments", + "reactions", + "reactions-+1", + "reactions--1", + "reactions-smile", + "reactions-thinking_face", + "reactions-heart", + "reactions-tada", + "interactions", + "created", + "updated" + ], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["desc", "asc"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_count\":280,\"incomplete_results\":false,\"items\":[{\"url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132\",\"repository_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit\",\"labels_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/comments\",\"events_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/events\",\"html_url\":\"https://github.com/batterseapower/pinyin-toolkit/issues/132\",\"id\":35802,\"node_id\":\"MDU6SXNzdWUzNTgwMg==\",\"number\":132,\"title\":\"Line Number Indexes Beyond 20 Not Displayed\",\"user\":{\"login\":\"Nick3C\",\"id\":90254,\"node_id\":\"MDQ6VXNlcjkwMjU0\",\"avatar_url\":\"https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/Nick3C\",\"html_url\":\"https://github.com/Nick3C\",\"followers_url\":\"https://api.github.com/users/Nick3C/followers\",\"following_url\":\"https://api.github.com/users/Nick3C/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/Nick3C/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/Nick3C/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/Nick3C/subscriptions\",\"organizations_url\":\"https://api.github.com/users/Nick3C/orgs\",\"repos_url\":\"https://api.github.com/users/Nick3C/repos\",\"events_url\":\"https://api.github.com/users/Nick3C/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/Nick3C/received_events\",\"type\":\"User\",\"site_admin\":true},\"labels\":[{\"id\":4,\"node_id\":\"MDU6TGFiZWw0\",\"url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug\",\"name\":\"bug\",\"color\":\"ff0000\"}],\"state\":\"open\",\"assignee\":null,\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"comments\":15,\"created_at\":\"2009-07-12T20:10:41Z\",\"updated_at\":\"2009-07-19T09:23:43Z\",\"closed_at\":null,\"pull_request\":{\"url\":\"https://api/github.com/repos/octocat/Hello-World/pull/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"body\":\"...\",\"score\":1,\"locked\":true,\"author_association\":\"COLLABORATOR\"}]}" + } + ] + }, + { "code": 304, "description": "Not modified", "examples": null }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 422, "description": "Validation failed", "examples": null }, + { "code": 503, "description": "Service unavailable", "examples": null } + ], + "renamed": null + }, + { + "name": "Search labels", + "scope": "search", + "id": "labels", + "method": "GET", + "url": "/search/labels", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.", + "documentationUrl": "https://docs.github.com/rest/reference/search#search-labels", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "repository_id", + "description": "The id of the repository.", + "in": "QUERY", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "q", + "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query).", + "in": "QUERY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "sort", + "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results)", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["created", "updated"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["desc", "asc"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -49653,31 +56015,34 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":1,\"incomplete_results\":false,\"items\":[{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"sha\":\"bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"html_url\":\"https://github.com/octocat/Spoon-Knife/commit/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"comments_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"author\":{\"date\":\"2014-02-04T14:38:36-08:00\",\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"committer\":{\"date\":\"2014-02-12T15:18:55-08:00\",\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"message\":\"Create styles.css and updated README\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/trees/a639e96f9038797fba6e0469f94a4b0cc459fa68\",\"sha\":\"a639e96f9038797fba6e0469f94a4b0cc459fa68\"},\"comment_count\":8},\"author\":{\"login\":\"octocat\",\"id\":583231,\"node_id\":\"MDQ6VXNlcjU4MzIzMQ==\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=3\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"committer\":{},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits/a30c19e3f13765a3b48829788bc1cb8b4e95cee4\",\"html_url\":\"https://github.com/octocat/Spoon-Knife/commit/a30c19e3f13765a3b48829788bc1cb8b4e95cee4\",\"sha\":\"a30c19e3f13765a3b48829788bc1cb8b4e95cee4\"}],\"repository\":{\"id\":1300192,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMzAwMTky\",\"name\":\"Spoon-Knife\",\"full_name\":\"octocat/Spoon-Knife\",\"owner\":{\"login\":\"octocat\",\"id\":583231,\"node_id\":\"MDQ6VXNlcjU4MzIzMQ==\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=3\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Spoon-Knife\",\"description\":\"This repo is for demonstration purposes only.\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife\",\"forks_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/forks\",\"keys_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/teams\",\"hooks_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/events\",\"assignees_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/tags\",\"blobs_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/languages\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/subscription\",\"commits_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/merges\",\"archive_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/downloads\",\"issues_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/deployments\"},\"score\":1,\"node_id\":\"MDQ6VXNlcjU4MzIzMQ==\"}]}" + "data": "{\"total_count\":2,\"incomplete_results\":false,\"items\":[{\"id\":418327088,\"node_id\":\"MDU6TGFiZWw0MTgzMjcwODg=\",\"url\":\"https://api.github.com/repos/octocat/linguist/labels/enhancement\",\"name\":\"enhancement\",\"color\":\"84b6eb\",\"default\":true,\"description\":\"New feature or request.\",\"score\":1},{\"id\":418327086,\"node_id\":\"MDU6TGFiZWw0MTgzMjcwODY=\",\"url\":\"https://api.github.com/repos/octocat/linguist/labels/bug\",\"name\":\"bug\",\"color\":\"ee0701\",\"default\":true,\"description\":\"Something isn't working.\",\"score\":1}]}" } ] }, - { "code": 304, "description": "Not modified", "examples": null } + { "code": 304, "description": "Not modified", "examples": null }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 422, "description": "Validation failed", "examples": null } ], "renamed": null }, { - "name": "Search issues and pull requests", + "name": "Search repositories", "scope": "search", - "id": "issuesAndPullRequests", + "id": "repos", "method": "GET", - "url": "/search/issues", + "url": "/search/repositories", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n**Note:** For [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", - "documentationUrl": "https://docs.github.com/rest/reference/search#search-issues-and-pull-requests", + "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.", + "documentationUrl": "https://docs.github.com/rest/reference/search#search-repositories", "previews": [], "headers": [], "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See \"[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", "in": "QUERY", "type": "string", "required": true, @@ -49690,23 +56055,11 @@ }, { "name": "sort", - "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results)", + "description": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results)", "in": "QUERY", "type": "string", "required": false, - "enum": [ - "comments", - "reactions", - "reactions-+1", - "reactions--1", - "reactions-smile", - "reactions-thinking_face", - "reactions-heart", - "reactions-tada", - "interactions", - "created", - "updated" - ], + "enum": ["stars", "forks", "help-wanted-issues", "updated"], "allowNull": false, "mapToData": null, "validation": null, @@ -49728,7 +56081,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -49759,47 +56112,33 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":280,\"incomplete_results\":false,\"items\":[{\"url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132\",\"repository_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit\",\"labels_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/comments\",\"events_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/events\",\"html_url\":\"https://github.com/batterseapower/pinyin-toolkit/issues/132\",\"id\":35802,\"node_id\":\"MDU6SXNzdWUzNTgwMg==\",\"number\":132,\"title\":\"Line Number Indexes Beyond 20 Not Displayed\",\"user\":{\"login\":\"Nick3C\",\"id\":90254,\"node_id\":\"MDQ6VXNlcjkwMjU0\",\"avatar_url\":\"https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/Nick3C\",\"html_url\":\"https://github.com/Nick3C\",\"followers_url\":\"https://api.github.com/users/Nick3C/followers\",\"following_url\":\"https://api.github.com/users/Nick3C/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/Nick3C/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/Nick3C/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/Nick3C/subscriptions\",\"organizations_url\":\"https://api.github.com/users/Nick3C/orgs\",\"repos_url\":\"https://api.github.com/users/Nick3C/repos\",\"events_url\":\"https://api.github.com/users/Nick3C/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/Nick3C/received_events\",\"type\":\"User\",\"site_admin\":true},\"labels\":[{\"id\":4,\"node_id\":\"MDU6TGFiZWw0\",\"url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug\",\"name\":\"bug\",\"color\":\"ff0000\"}],\"state\":\"open\",\"assignee\":null,\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"comments\":15,\"created_at\":\"2009-07-12T20:10:41Z\",\"updated_at\":\"2009-07-19T09:23:43Z\",\"closed_at\":null,\"pull_request\":{\"url\":\"https://api/github.com/repos/octocat/Hello-World/pull/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"body\":\"...\",\"score\":1,\"locked\":true,\"author_association\":\"COLLABORATOR\"}]}" + "data": "{\"total_count\":40,\"incomplete_results\":false,\"items\":[{\"id\":3081286,\"node_id\":\"MDEwOlJlcG9zaXRvcnkzMDgxMjg2\",\"name\":\"Tetris\",\"full_name\":\"dtrupenn/Tetris\",\"owner\":{\"login\":\"dtrupenn\",\"id\":872147,\"node_id\":\"MDQ6VXNlcjg3MjE0Nw==\",\"avatar_url\":\"https://secure.gravatar.com/avatar/e7956084e75f239de85d3a31bc172ace?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/dtrupenn\",\"received_events_url\":\"https://api.github.com/users/dtrupenn/received_events\",\"type\":\"User\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"site_admin\":true},\"private\":false,\"html_url\":\"https://github.com/dtrupenn/Tetris\",\"description\":\"A C implementation of Tetris using Pennsim through LC4\",\"fork\":false,\"url\":\"https://api.github.com/repos/dtrupenn/Tetris\",\"created_at\":\"2012-01-01T00:31:50Z\",\"updated_at\":\"2013-01-05T17:58:47Z\",\"pushed_at\":\"2012-01-01T00:37:02Z\",\"homepage\":\"https://github.com\",\"size\":524,\"stargazers_count\":1,\"watchers_count\":1,\"language\":\"Assembly\",\"forks_count\":0,\"open_issues_count\":0,\"master_branch\":\"master\",\"default_branch\":\"master\",\"score\":1,\"archive_url\":\"https://api.github.com/repos/dtrupenn/Tetris/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/dtrupenn/Tetris/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/dtrupenn/Tetris/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/dtrupenn/Tetris/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/dtrupenn/Tetris/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/dtrupenn/Tetris/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/dtrupenn/Tetris/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/dtrupenn/Tetris/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/dtrupenn/Tetris/contributors\",\"deployments_url\":\"https://api.github.com/repos/dtrupenn/Tetris/deployments\",\"downloads_url\":\"https://api.github.com/repos/dtrupenn/Tetris/downloads\",\"events_url\":\"https://api.github.com/repos/dtrupenn/Tetris/events\",\"forks_url\":\"https://api.github.com/repos/dtrupenn/Tetris/forks\",\"git_commits_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/tags{/sha}\",\"git_url\":\"git:github.com/dtrupenn/Tetris.git\",\"issue_comment_url\":\"https://api.github.com/repos/dtrupenn/Tetris/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/dtrupenn/Tetris/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/dtrupenn/Tetris/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/dtrupenn/Tetris/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/dtrupenn/Tetris/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/dtrupenn/Tetris/languages\",\"merges_url\":\"https://api.github.com/repos/dtrupenn/Tetris/merges\",\"milestones_url\":\"https://api.github.com/repos/dtrupenn/Tetris/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/dtrupenn/Tetris/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/dtrupenn/Tetris/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/dtrupenn/Tetris/releases{/id}\",\"ssh_url\":\"git@github.com:dtrupenn/Tetris.git\",\"stargazers_url\":\"https://api.github.com/repos/dtrupenn/Tetris/stargazers\",\"statuses_url\":\"https://api.github.com/repos/dtrupenn/Tetris/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/dtrupenn/Tetris/subscribers\",\"subscription_url\":\"https://api.github.com/repos/dtrupenn/Tetris/subscription\",\"tags_url\":\"https://api.github.com/repos/dtrupenn/Tetris/tags\",\"teams_url\":\"https://api.github.com/repos/dtrupenn/Tetris/teams\",\"trees_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/trees{/sha}\",\"clone_url\":\"https://github.com/dtrupenn/Tetris.git\",\"mirror_url\":\"git:git.example.com/dtrupenn/Tetris\",\"hooks_url\":\"https://api.github.com/repos/dtrupenn/Tetris/hooks\",\"svn_url\":\"https://svn.github.com/dtrupenn/Tetris\",\"forks\":1,\"open_issues\":1,\"watchers\":1,\"has_issues\":true,\"has_projects\":true,\"has_pages\":true,\"has_wiki\":true,\"has_downloads\":true,\"archived\":true,\"disabled\":true,\"visibility\":\"private\",\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"}}]}" } ] }, { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, { "code": 422, "description": "Validation failed", "examples": null }, { "code": 503, "description": "Service unavailable", "examples": null } ], "renamed": null }, { - "name": "Search labels", + "name": "Search topics", "scope": "search", - "id": "labels", + "id": "topics", "method": "GET", - "url": "/search/labels", + "url": "/search/topics", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.", - "documentationUrl": "https://docs.github.com/rest/reference/search#search-labels", + "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See \"[Searching topics](https://docs.github.com/articles/searching-topics/)\" for a detailed list of qualifiers.\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.", + "documentationUrl": "https://docs.github.com/rest/reference/search#search-topics", "previews": [], "headers": [], "parameters": [ - { - "name": "repository_id", - "description": "The id of the repository.", - "in": "QUERY", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "q", - "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query).", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query).", "in": "QUERY", "type": "string", "required": true, @@ -49810,35 +56149,9 @@ "alias": null, "deprecated": null }, - { - "name": "sort", - "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results)", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "order", - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["desc", "asc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -49869,34 +56182,31 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":2,\"incomplete_results\":false,\"items\":[{\"id\":418327088,\"node_id\":\"MDU6TGFiZWw0MTgzMjcwODg=\",\"url\":\"https://api.github.com/repos/octocat/linguist/labels/enhancement\",\"name\":\"enhancement\",\"color\":\"84b6eb\",\"default\":true,\"description\":\"New feature or request.\",\"score\":1},{\"id\":418327086,\"node_id\":\"MDU6TGFiZWw0MTgzMjcwODY=\",\"url\":\"https://api.github.com/repos/octocat/linguist/labels/bug\",\"name\":\"bug\",\"color\":\"ee0701\",\"default\":true,\"description\":\"Something isn't working.\",\"score\":1}]}" + "data": "{\"total_count\":6,\"incomplete_results\":false,\"items\":[{\"name\":\"ruby\",\"display_name\":\"Ruby\",\"short_description\":\"Ruby is a scripting language designed for simplified object-oriented programming.\",\"description\":\"Ruby was developed by Yukihiro \\\"Matz\\\" Matsumoto in 1995 with the intent of having an easily readable programming language. It is integrated with the Rails framework to create dynamic web-applications. Ruby's syntax is similar to that of Perl and Python.\",\"created_by\":\"Yukihiro Matsumoto\",\"released\":\"December 21, 1995\",\"created_at\":\"2016-11-28T22:03:59Z\",\"updated_at\":\"2017-10-30T18:16:32Z\",\"featured\":true,\"curated\":true,\"score\":1},{\"name\":\"rails\",\"display_name\":\"Rails\",\"short_description\":\"Ruby on Rails (Rails) is a web application framework written in Ruby.\",\"description\":\"Ruby on Rails (Rails) is a web application framework written in Ruby. It is meant to help simplify the building of complex websites.\",\"created_by\":\"David Heinemeier Hansson\",\"released\":\"December 13 2005\",\"created_at\":\"2016-12-09T17:03:50Z\",\"updated_at\":\"2017-10-30T16:20:19Z\",\"featured\":true,\"curated\":true,\"score\":1},{\"name\":\"python\",\"display_name\":\"Python\",\"short_description\":\"Python is a dynamically typed programming language.\",\"description\":\"Python is a dynamically typed programming language designed by Guido Van Rossum. Much like the programming language Ruby, Python was designed to be easily read by programmers. Because of its large following and many libraries, Python can be implemented and used to do anything from webpages to scientific research.\",\"created_by\":\"Guido van Rossum\",\"released\":\"February 20, 1991\",\"created_at\":\"2016-12-07T00:07:02Z\",\"updated_at\":\"2017-10-27T22:45:43Z\",\"featured\":true,\"curated\":true,\"score\":1},{\"name\":\"jekyll\",\"display_name\":\"Jekyll\",\"short_description\":\"Jekyll is a simple, blog-aware static site generator.\",\"description\":\"Jekyll is a blog-aware, site generator written in Ruby. It takes raw text files, runs it through a renderer and produces a publishable static website.\",\"created_by\":\"Tom Preston-Werner\",\"released\":\"2008\",\"created_at\":\"2016-12-16T21:53:08Z\",\"updated_at\":\"2017-10-27T19:00:24Z\",\"featured\":true,\"curated\":true,\"score\":1},{\"name\":\"sass\",\"display_name\":\"Sass\",\"short_description\":\"Sass is a stable extension to classic CSS.\",\"description\":\"Sass is a stylesheet language with a main implementation in Ruby. It is an extension of CSS that makes improvements to the old stylesheet format, such as being able to declare variables and using a cleaner nesting syntax.\",\"created_by\":\"Hampton Catlin, Natalie Weizenbaum, Chris Eppstein\",\"released\":\"November 28, 2006\",\"created_at\":\"2016-12-16T21:53:45Z\",\"updated_at\":\"2018-01-16T16:30:40Z\",\"featured\":true,\"curated\":true,\"score\":1},{\"name\":\"homebrew\",\"display_name\":\"Homebrew\",\"short_description\":\"Homebrew is a package manager for macOS.\",\"description\":\"Homebrew is a package manager for Apple's macOS operating system. It simplifies the installation of software and is popular in the Ruby on Rails community.\",\"created_by\":\"Max Howell\",\"released\":\"2009\",\"created_at\":\"2016-12-17T20:30:44Z\",\"updated_at\":\"2018-02-06T16:14:56Z\",\"featured\":true,\"curated\":true,\"score\":1}]}" } ] }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } + { "code": 304, "description": "Not modified", "examples": null } ], "renamed": null }, { - "name": "Search repositories", + "name": "Search users", "scope": "search", - "id": "repos", + "id": "users", "method": "GET", - "url": "/search/repositories", + "url": "/search/users", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.\n\nWhen you include the `mercy` preview header, you can also search for multiple topics by adding more `topic:` instances. For example, your query might look like this:\n\n`q=topic:ruby+topic:rails`", - "documentationUrl": "https://docs.github.com/rest/reference/search#search-repositories", + "description": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for users, you can get text match metadata for the issue **login**, **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you're looking for a list of popular users, you might try this query:\n\n`q=tom+repos:%3E42+followers:%3E1000`\n\nThis query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.", + "documentationUrl": "https://docs.github.com/rest/reference/search#search-users", "previews": [], "headers": [], "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See \"[Searching for repositories](https://help.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See \"[Searching users](https://docs.github.com/search-github/searching-on-github/searching-users)\" for a detailed list of qualifiers.", "in": "QUERY", "type": "string", "required": true, @@ -49909,11 +56219,11 @@ }, { "name": "sort", - "description": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results)", + "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results)", "in": "QUERY", "type": "string", "required": false, - "enum": ["stars", "forks", "help-wanted-issues", "updated"], + "enum": ["followers", "repositories", "joined"], "allowNull": false, "mapToData": null, "validation": null, @@ -49935,7 +56245,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -49966,7 +56276,7 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":40,\"incomplete_results\":false,\"items\":[{\"id\":3081286,\"node_id\":\"MDEwOlJlcG9zaXRvcnkzMDgxMjg2\",\"name\":\"Tetris\",\"full_name\":\"dtrupenn/Tetris\",\"owner\":{\"login\":\"dtrupenn\",\"id\":872147,\"node_id\":\"MDQ6VXNlcjg3MjE0Nw==\",\"avatar_url\":\"https://secure.gravatar.com/avatar/e7956084e75f239de85d3a31bc172ace?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/dtrupenn\",\"received_events_url\":\"https://api.github.com/users/dtrupenn/received_events\",\"type\":\"User\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"site_admin\":true},\"private\":false,\"html_url\":\"https://github.com/dtrupenn/Tetris\",\"description\":\"A C implementation of Tetris using Pennsim through LC4\",\"fork\":false,\"url\":\"https://api.github.com/repos/dtrupenn/Tetris\",\"created_at\":\"2012-01-01T00:31:50Z\",\"updated_at\":\"2013-01-05T17:58:47Z\",\"pushed_at\":\"2012-01-01T00:37:02Z\",\"homepage\":\"https://github.com\",\"size\":524,\"stargazers_count\":1,\"watchers_count\":1,\"language\":\"Assembly\",\"forks_count\":0,\"open_issues_count\":0,\"master_branch\":\"master\",\"default_branch\":\"master\",\"score\":1,\"archive_url\":\"https://api.github.com/repos/dtrupenn/Tetris/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/dtrupenn/Tetris/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/dtrupenn/Tetris/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/dtrupenn/Tetris/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/dtrupenn/Tetris/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/dtrupenn/Tetris/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/dtrupenn/Tetris/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/dtrupenn/Tetris/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/dtrupenn/Tetris/contributors\",\"deployments_url\":\"https://api.github.com/repos/dtrupenn/Tetris/deployments\",\"downloads_url\":\"https://api.github.com/repos/dtrupenn/Tetris/downloads\",\"events_url\":\"https://api.github.com/repos/dtrupenn/Tetris/events\",\"forks_url\":\"https://api.github.com/repos/dtrupenn/Tetris/forks\",\"git_commits_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/tags{/sha}\",\"git_url\":\"git:github.com/dtrupenn/Tetris.git\",\"issue_comment_url\":\"https://api.github.com/repos/dtrupenn/Tetris/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/dtrupenn/Tetris/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/dtrupenn/Tetris/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/dtrupenn/Tetris/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/dtrupenn/Tetris/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/dtrupenn/Tetris/languages\",\"merges_url\":\"https://api.github.com/repos/dtrupenn/Tetris/merges\",\"milestones_url\":\"https://api.github.com/repos/dtrupenn/Tetris/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/dtrupenn/Tetris/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/dtrupenn/Tetris/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/dtrupenn/Tetris/releases{/id}\",\"ssh_url\":\"git@github.com:dtrupenn/Tetris.git\",\"stargazers_url\":\"https://api.github.com/repos/dtrupenn/Tetris/stargazers\",\"statuses_url\":\"https://api.github.com/repos/dtrupenn/Tetris/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/dtrupenn/Tetris/subscribers\",\"subscription_url\":\"https://api.github.com/repos/dtrupenn/Tetris/subscription\",\"tags_url\":\"https://api.github.com/repos/dtrupenn/Tetris/tags\",\"teams_url\":\"https://api.github.com/repos/dtrupenn/Tetris/teams\",\"trees_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/trees{/sha}\",\"clone_url\":\"https://github.com/dtrupenn/Tetris.git\",\"mirror_url\":\"git:git.example.com/dtrupenn/Tetris\",\"hooks_url\":\"https://api.github.com/repos/dtrupenn/Tetris/hooks\",\"svn_url\":\"https://svn.github.com/dtrupenn/Tetris\",\"forks\":1,\"open_issues\":1,\"watchers\":1,\"has_issues\":true,\"has_projects\":true,\"has_pages\":true,\"has_wiki\":true,\"has_downloads\":true,\"archived\":true,\"disabled\":true,\"visibility\":\"private\",\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"}}]}" + "data": "{\"total_count\":12,\"incomplete_results\":false,\"items\":[{\"login\":\"mojombo\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/mojombo\",\"html_url\":\"https://github.com/mojombo\",\"followers_url\":\"https://api.github.com/users/mojombo/followers\",\"subscriptions_url\":\"https://api.github.com/users/mojombo/subscriptions\",\"organizations_url\":\"https://api.github.com/users/mojombo/orgs\",\"repos_url\":\"https://api.github.com/users/mojombo/repos\",\"received_events_url\":\"https://api.github.com/users/mojombo/received_events\",\"type\":\"User\",\"score\":1,\"following_url\":\"https://api.github.com/users/mojombo/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/mojombo/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/mojombo/starred{/owner}{/repo}\",\"events_url\":\"https://api.github.com/users/mojombo/events{/privacy}\",\"site_admin\":true}]}" } ] }, @@ -49977,23 +56287,23 @@ "renamed": null }, { - "name": "Search topics", - "scope": "search", - "id": "topics", + "name": "Get a secret scanning alert", + "scope": "secretScanning", + "id": "getAlert", "method": "GET", - "url": "/search/topics", + "url": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See \"[Searching topics](https://help.github.com/articles/searching-topics/)\" for a detailed list of qualifiers.\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.", - "documentationUrl": "https://docs.github.com/rest/reference/search#search-topics", - "previews": [{ "name": "mercy" }], + "description": "Gets a single secret scanning alert detected in an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.\nFor public repositories, you may instead use the `public_repo` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/secret-scanning#get-a-secret-scanning-alert", + "previews": [], "headers": [], "parameters": [ { - "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query).", - "in": "QUERY", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -50004,11 +56314,11 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -50017,11 +56327,11 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", + "name": "alert_number", + "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", + "in": "PATH", "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -50036,33 +56346,38 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":6,\"incomplete_results\":false,\"items\":[{\"name\":\"ruby\",\"display_name\":\"Ruby\",\"short_description\":\"Ruby is a scripting language designed for simplified object-oriented programming.\",\"description\":\"Ruby was developed by Yukihiro \\\"Matz\\\" Matsumoto in 1995 with the intent of having an easily readable programming language. It is integrated with the Rails framework to create dynamic web-applications. Ruby's syntax is similar to that of Perl and Python.\",\"created_by\":\"Yukihiro Matsumoto\",\"released\":\"December 21, 1995\",\"created_at\":\"2016-11-28T22:03:59Z\",\"updated_at\":\"2017-10-30T18:16:32Z\",\"featured\":true,\"curated\":true,\"score\":1},{\"name\":\"rails\",\"display_name\":\"Rails\",\"short_description\":\"Ruby on Rails (Rails) is a web application framework written in Ruby.\",\"description\":\"Ruby on Rails (Rails) is a web application framework written in Ruby. It is meant to help simplify the building of complex websites.\",\"created_by\":\"David Heinemeier Hansson\",\"released\":\"December 13 2005\",\"created_at\":\"2016-12-09T17:03:50Z\",\"updated_at\":\"2017-10-30T16:20:19Z\",\"featured\":true,\"curated\":true,\"score\":1},{\"name\":\"python\",\"display_name\":\"Python\",\"short_description\":\"Python is a dynamically typed programming language.\",\"description\":\"Python is a dynamically typed programming language designed by Guido Van Rossum. Much like the programming language Ruby, Python was designed to be easily read by programmers. Because of its large following and many libraries, Python can be implemented and used to do anything from webpages to scientific research.\",\"created_by\":\"Guido van Rossum\",\"released\":\"February 20, 1991\",\"created_at\":\"2016-12-07T00:07:02Z\",\"updated_at\":\"2017-10-27T22:45:43Z\",\"featured\":true,\"curated\":true,\"score\":1},{\"name\":\"jekyll\",\"display_name\":\"Jekyll\",\"short_description\":\"Jekyll is a simple, blog-aware static site generator.\",\"description\":\"Jekyll is a blog-aware, site generator written in Ruby. It takes raw text files, runs it through a renderer and produces a publishable static website.\",\"created_by\":\"Tom Preston-Werner\",\"released\":\"2008\",\"created_at\":\"2016-12-16T21:53:08Z\",\"updated_at\":\"2017-10-27T19:00:24Z\",\"featured\":true,\"curated\":true,\"score\":1},{\"name\":\"sass\",\"display_name\":\"Sass\",\"short_description\":\"Sass is a stable extension to classic CSS.\",\"description\":\"Sass is a stylesheet language with a main implementation in Ruby. It is an extension of CSS that makes improvements to the old stylesheet format, such as being able to declare variables and using a cleaner nesting syntax.\",\"created_by\":\"Hampton Catlin, Natalie Weizenbaum, Chris Eppstein\",\"released\":\"November 28, 2006\",\"created_at\":\"2016-12-16T21:53:45Z\",\"updated_at\":\"2018-01-16T16:30:40Z\",\"featured\":true,\"curated\":true,\"score\":1},{\"name\":\"homebrew\",\"display_name\":\"Homebrew\",\"short_description\":\"Homebrew is a package manager for macOS.\",\"description\":\"Homebrew is a package manager for Apple's macOS operating system. It simplifies the installation of software and is popular in the Ruby on Rails community.\",\"created_by\":\"Max Howell\",\"released\":\"2009\",\"created_at\":\"2016-12-17T20:30:44Z\",\"updated_at\":\"2018-02-06T16:14:56Z\",\"featured\":true,\"curated\":true,\"score\":1}]}" + "data": "{\"number\":42,\"created_at\":\"2020-11-06T18:18:30Z\",\"url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42\",\"html_url\":\"https://github.com/owner/private-repo/security/secret-scanning/42\",\"locations_url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations\",\"state\":\"open\",\"resolution\":null,\"resolved_at\":null,\"resolved_by\":null,\"secret_type\":\"mailchimp_api_key\",\"secret_type_display_name\":\"Mailchimp API Key\",\"secret\":\"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2\",\"push_protection_bypassed_by\":null,\"push_protection_bypassed\":false,\"push_protection_bypassed_at\":null}" } ] }, { "code": 304, "description": "Not modified", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } + { + "code": 404, + "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found", + "examples": null + }, + { "code": 503, "description": "Service unavailable", "examples": null } ], "renamed": null }, { - "name": "Search users", - "scope": "search", - "id": "users", + "name": "List secret scanning alerts for an enterprise", + "scope": "secretScanning", + "id": "listAlertsForEnterprise", "method": "GET", - "url": "/search/users", + "url": "/enterprises/{enterprise}/secret-scanning/alerts", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for users, you can get text match metadata for the issue **login**, **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you're looking for a list of popular users, you might try this query:\n\n`q=tom+repos:%3E42+followers:%3E1000`\n\nThis query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.", - "documentationUrl": "https://docs.github.com/rest/reference/search#search-users", + "description": "Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\nTo use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).", + "documentationUrl": "https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-an-enterprise", "previews": [], "headers": [], "parameters": [ { - "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See \"[Searching users](https://help.github.com/articles/searching-users/)\" for a detailed list of qualifiers.", - "in": "QUERY", + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -50073,12 +56388,12 @@ "deprecated": null }, { - "name": "sort", - "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results)", + "name": "state", + "description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state.", "in": "QUERY", "type": "string", "required": false, - "enum": ["followers", "repositories", "joined"], + "enum": ["open", "resolved"], "allowNull": false, "mapToData": null, "validation": null, @@ -50086,12 +56401,12 @@ "deprecated": null }, { - "name": "order", - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "name": "secret_type", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types.", "in": "QUERY", "type": "string", "required": false, - "enum": ["desc", "asc"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -50099,10 +56414,10 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", + "name": "resolution", + "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`.", "in": "QUERY", - "type": "integer", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -50112,55 +56427,37 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", + "name": "sort", + "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.", "in": "QUERY", - "type": "integer", + "type": "string", "required": false, - "enum": null, + "enum": ["created", "updated"], "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":12,\"incomplete_results\":false,\"items\":[{\"login\":\"mojombo\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/mojombo\",\"html_url\":\"https://github.com/mojombo\",\"followers_url\":\"https://api.github.com/users/mojombo/followers\",\"subscriptions_url\":\"https://api.github.com/users/mojombo/subscriptions\",\"organizations_url\":\"https://api.github.com/users/mojombo/orgs\",\"repos_url\":\"https://api.github.com/users/mojombo/repos\",\"received_events_url\":\"https://api.github.com/users/mojombo/received_events\",\"type\":\"User\",\"score\":1,\"following_url\":\"https://api.github.com/users/mojombo/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/mojombo/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/mojombo/starred{/owner}{/repo}\",\"events_url\":\"https://api.github.com/users/mojombo/events{/privacy}\",\"site_admin\":true}]}" - } - ] }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a secret scanning alert", - "scope": "secretScanning", - "id": "getAlert", - "method": "GET", - "url": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/secret-scanning#get-a-secret-scanning-alert", - "previews": [], - "headers": [], - "parameters": [ { - "name": "owner", - "description": "", - "in": "PATH", + "name": "direction", + "description": "The direction to sort the results by.", + "in": "QUERY", "type": "string", - "required": true, + "required": false, + "enum": ["asc", "desc"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -50169,11 +56466,11 @@ "deprecated": null }, { - "name": "repo", - "description": "", - "in": "PATH", + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor.", + "in": "QUERY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -50182,11 +56479,11 @@ "deprecated": null }, { - "name": "alert_number", - "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", - "in": "PATH", - "type": "integer", - "required": true, + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor.", + "in": "QUERY", + "type": "string", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -50201,22 +56498,17 @@ "description": "Response", "examples": [ { - "data": "{\"number\":42,\"created_at\":\"2020-11-06T18:18:30Z\",\"url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42\",\"html_url\":\"https://github.com/owner/private-repo/security/secret-scanning/42\",\"state\":\"open\",\"resolution\":null,\"resolved_at\":null,\"resolved_by\":null,\"secret_type\":\"mailchimp_api_key\",\"secret\":\"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2\"}" + "data": "[{\"number\":2,\"created_at\":\"2020-11-06T18:48:51Z\",\"url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2\",\"html_url\":\"https://github.com/owner/private-repo/security/secret-scanning/2\",\"locations_url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations\",\"state\":\"resolved\",\"resolution\":\"false_positive\",\"resolved_at\":\"2020-11-07T02:47:13Z\",\"resolved_by\":{\"login\":\"monalisa\",\"id\":2,\"node_id\":\"MDQ6VXNlcjI=\",\"avatar_url\":\"https://alambic.github.com/avatars/u/2?\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"secret_type\":\"adafruit_io_key\",\"secret_type_display_name\":\"Adafruit IO Key\",\"secret\":\"aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}},\"push_protection_bypassed_by\":{\"login\":\"monalisa\",\"id\":2,\"node_id\":\"MDQ6VXNlcjI=\",\"avatar_url\":\"https://alambic.github.com/avatars/u/2?\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"push_protection_bypassed\":true,\"push_protection_bypassed_at\":\"2020-11-06T21:48:51Z\"},{\"number\":1,\"created_at\":\"2020-11-06T18:18:30Z\",\"url\":\"https://api.github.com/repos/owner/repo/secret-scanning/alerts/1\",\"html_url\":\"https://github.com/owner/repo/security/secret-scanning/1\",\"locations_url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations\",\"state\":\"open\",\"resolution\":null,\"resolved_at\":null,\"resolved_by\":null,\"secret_type\":\"mailchimp_api_key\",\"secret_type_display_name\":\"Mailchimp API Key\",\"secret\":\"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}},\"push_protection_bypassed_by\":null,\"push_protection_bypassed\":false,\"push_protection_bypassed_at\":null}]" } ] }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 404, - "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found", - "examples": null - }, + { "code": 404, "description": "Resource not found", "examples": null }, { "code": 503, "description": "Service unavailable", "examples": null } ], "renamed": null }, { - "name": "List secret scanning alerts by organization", + "name": "List secret scanning alerts for an organization", "scope": "secretScanning", "id": "listAlertsForOrg", "method": "GET", @@ -50224,14 +56516,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all secret scanning alerts for all eligible repositories in an organization, from newest to oldest.\nTo use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-by-organization", + "description": "Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.\nTo use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope.\nFor public repositories, you may instead use the `public_repo` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-an-organization", "previews": [], "headers": [], "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -50257,7 +56549,7 @@ }, { "name": "secret_type", - "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.\nSee \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types.", "in": "QUERY", "type": "string", "required": false, @@ -50281,6 +56573,32 @@ "alias": null, "deprecated": null }, + { + "name": "sort", + "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["created", "updated"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["asc", "desc"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "page", "description": "Page number of the results to fetch.", @@ -50296,7 +56614,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -50314,7 +56632,7 @@ "description": "Response", "examples": [ { - "data": "[{\"number\":2,\"created_at\":\"2020-11-06T18:48:51Z\",\"url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2\",\"html_url\":\"https://github.com/owner/private-repo/security/secret-scanning/2\",\"state\":\"resolved\",\"resolution\":\"false_positive\",\"resolved_at\":\"2020-11-07T02:47:13Z\",\"resolved_by\":{\"login\":\"monalisa\",\"id\":2,\"node_id\":\"MDQ6VXNlcjI=\",\"avatar_url\":\"https://alambic.github.com/avatars/u/2?\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"secret_type\":\"adafruit_io_key\",\"secret\":\"aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}},{\"number\":1,\"created_at\":\"2020-11-06T18:18:30Z\",\"url\":\"https://api.github.com/repos/owner/repo/secret-scanning/alerts/1\",\"html_url\":\"https://github.com/owner/repo/security/secret-scanning/1\",\"state\":\"open\",\"resolution\":null,\"resolved_at\":null,\"resolved_by\":null,\"secret_type\":\"mailchimp_api_key\",\"secret\":\"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}}]" + "data": "[{\"number\":2,\"created_at\":\"2020-11-06T18:48:51Z\",\"url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2\",\"html_url\":\"https://github.com/owner/private-repo/security/secret-scanning/2\",\"locations_url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations\",\"state\":\"resolved\",\"resolution\":\"false_positive\",\"resolved_at\":\"2020-11-07T02:47:13Z\",\"resolved_by\":{\"login\":\"monalisa\",\"id\":2,\"node_id\":\"MDQ6VXNlcjI=\",\"avatar_url\":\"https://alambic.github.com/avatars/u/2?\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"secret_type\":\"adafruit_io_key\",\"secret_type_display_name\":\"Adafruit IO Key\",\"secret\":\"aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}},\"push_protection_bypassed_by\":{\"login\":\"monalisa\",\"id\":2,\"node_id\":\"MDQ6VXNlcjI=\",\"avatar_url\":\"https://alambic.github.com/avatars/u/2?\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"push_protection_bypassed\":true,\"push_protection_bypassed_at\":\"2020-11-06T21:48:51Z\"},{\"number\":1,\"created_at\":\"2020-11-06T18:18:30Z\",\"url\":\"https://api.github.com/repos/owner/repo/secret-scanning/alerts/1\",\"html_url\":\"https://github.com/owner/repo/security/secret-scanning/1\",\"locations_url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations\",\"state\":\"open\",\"resolution\":null,\"resolved_at\":null,\"resolved_by\":null,\"secret_type\":\"mailchimp_api_key\",\"secret_type_display_name\":\"Mailchimp API Key\",\"secret\":\"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}},\"push_protection_bypassed_by\":null,\"push_protection_bypassed\":false,\"push_protection_bypassed_at\":null}]" } ] }, @@ -50332,14 +56650,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", + "description": "Lists secret scanning alerts for an eligible repository, from newest to oldest.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.\nFor public repositories, you may instead use the `public_repo` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -50352,7 +56670,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -50378,7 +56696,7 @@ }, { "name": "secret_type", - "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.\nSee \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types.", "in": "QUERY", "type": "string", "required": false, @@ -50402,6 +56720,32 @@ "alias": null, "deprecated": null }, + { + "name": "sort", + "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["created", "updated"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["asc", "desc"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "page", "description": "Page number of the results to fetch.", @@ -50417,7 +56761,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -50435,7 +56779,7 @@ "description": "Response", "examples": [ { - "data": "[{\"number\":2,\"created_at\":\"2020-11-06T18:48:51Z\",\"url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2\",\"html_url\":\"https://github.com/owner/private-repo/security/secret-scanning/2\",\"state\":\"resolved\",\"resolution\":\"false_positive\",\"resolved_at\":\"2020-11-07T02:47:13Z\",\"resolved_by\":{\"login\":\"monalisa\",\"id\":2,\"node_id\":\"MDQ6VXNlcjI=\",\"avatar_url\":\"https://alambic.github.com/avatars/u/2?\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"secret_type\":\"adafruit_io_key\",\"secret\":\"aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX\"},{\"number\":1,\"created_at\":\"2020-11-06T18:18:30Z\",\"url\":\"https://api.github.com/repos/owner/repo/secret-scanning/alerts/1\",\"html_url\":\"https://github.com/owner/repo/security/secret-scanning/1\",\"state\":\"open\",\"resolution\":null,\"resolved_at\":null,\"resolved_by\":null,\"secret_type\":\"mailchimp_api_key\",\"secret\":\"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2\"}]" + "data": "[{\"number\":2,\"created_at\":\"2020-11-06T18:48:51Z\",\"url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2\",\"html_url\":\"https://github.com/owner/private-repo/security/secret-scanning/2\",\"locations_url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations\",\"state\":\"resolved\",\"resolution\":\"false_positive\",\"resolved_at\":\"2020-11-07T02:47:13Z\",\"resolved_by\":{\"login\":\"monalisa\",\"id\":2,\"node_id\":\"MDQ6VXNlcjI=\",\"avatar_url\":\"https://alambic.github.com/avatars/u/2?\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"secret_type\":\"adafruit_io_key\",\"secret_type_display_name\":\"Adafruit IO Key\",\"secret\":\"aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\"push_protection_bypassed_by\":{\"login\":\"monalisa\",\"id\":2,\"node_id\":\"MDQ6VXNlcjI=\",\"avatar_url\":\"https://alambic.github.com/avatars/u/2?\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"push_protection_bypassed\":true,\"push_protection_bypassed_at\":\"2020-11-06T21:48:51Z\"},{\"number\":1,\"created_at\":\"2020-11-06T18:18:30Z\",\"url\":\"https://api.github.com/repos/owner/repo/secret-scanning/alerts/1\",\"html_url\":\"https://github.com/owner/repo/security/secret-scanning/1\",\"locations_url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations\",\"state\":\"open\",\"resolution\":null,\"resolved_at\":null,\"resolved_by\":null,\"secret_type\":\"mailchimp_api_key\",\"secret_type_display_name\":\"Mailchimp API Key\",\"secret\":\"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2\",\"push_protection_bypassed_by\":null,\"push_protection_bypassed\":false,\"push_protection_bypassed_at\":null}]" } ] }, @@ -50448,6 +56792,105 @@ ], "renamed": null }, + { + "name": "List locations for a secret scanning alert", + "scope": "secretScanning", + "id": "listLocationsForAlert", + "method": "GET", + "url": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists all locations for a given secret scanning alert for an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.\nFor public repositories, you may instead use the `public_repo` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/secret-scanning#list-locations-for-a-secret-scanning-alert", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "alert_number", + "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"type\":\"commit\",\"details\":{\"path\":\"/example/secrets.txt\",\"start_line\":1,\"end_line\":1,\"start_column\":1,\"end_column\":64,\"blob_sha\":\"af5626b4a114abcb82d63db7c8082c3c4756e51b\",\"blob_url\":\"https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b\",\"commit_sha\":\"f14d7debf9775f957cf4f1e8176da0786431f72b\",\"commit_url\":\"https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b\"}},{\"type\":\"commit\",\"details\":{\"path\":\"/example/secrets.txt\",\"start_line\":5,\"end_line\":5,\"start_column\":1,\"end_column\":64,\"blob_sha\":\"9def38117ab2d8355b982429aa924e268b4b0065\",\"blob_url\":\"https://api.github.com/repos/octocat/hello-world/git/blobs/9def38117ab2d8355b982429aa924e268b4b0065\",\"commit_sha\":\"588483b99a46342501d99e3f10630cfc1219ea32\",\"commit_url\":\"https://api.github.com/repos/octocat/hello-world/git/commits/588483b99a46342501d99e3f10630cfc1219ea32\"}},{\"type\":\"commit\",\"details\":{\"path\":\"/example/secrets.txt\",\"start_line\":12,\"end_line\":12,\"start_column\":1,\"end_column\":64,\"blob_sha\":\"0b33e9c66e19f7fb15137a82ff1c04c10cba6caf\",\"blob_url\":\"https://api.github.com/repos/octocat/hello-world/git/blobs/0b33e9c66e19f7fb15137a82ff1c04c10cba6caf\",\"commit_sha\":\"9def38117ab2d8355b982429aa924e268b4b0065\",\"commit_url\":\"https://api.github.com/repos/octocat/hello-world/git/commits/9def38117ab2d8355b982429aa924e268b4b0065\"}}]" + } + ] + }, + { + "code": 404, + "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found", + "examples": null + }, + { "code": 503, "description": "Service unavailable", "examples": null } + ], + "renamed": null + }, { "name": "Update a secret scanning alert", "scope": "secretScanning", @@ -50457,14 +56900,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint.", + "description": "Updates the status of a secret scanning alert in an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.\nFor public repositories, you may instead use the `public_repo` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/secret-scanning#update-a-secret-scanning-alert", "previews": [], "headers": [], "parameters": [ { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -50477,7 +56920,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -50516,7 +56959,7 @@ }, { "name": "resolution", - "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert. Can be one of `false_positive`, `wont_fix`, `revoked`, or `used_in_tests`.", + "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", "in": "BODY", "type": "string", "required": false, @@ -50540,7 +56983,7 @@ "description": "Response", "examples": [ { - "data": "{\"number\":42,\"created_at\":\"2020-11-06T18:18:30Z\",\"url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42\",\"html_url\":\"https://github.com/owner/private-repo/security/secret-scanning/42\",\"state\":\"resolved\",\"resolution\":\"used_in_tests\",\"resolved_at\":\"2020-11-16T22:42:07Z\",\"resolved_by\":{\"login\":\"monalisa\",\"id\":2,\"node_id\":\"MDQ6VXNlcjI=\",\"avatar_url\":\"https://alambic.github.com/avatars/u/2?\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"secret_type\":\"mailchimp_api_key\",\"secret\":\"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2\"}" + "data": "{\"number\":42,\"created_at\":\"2020-11-06T18:18:30Z\",\"url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42\",\"html_url\":\"https://github.com/owner/private-repo/security/secret-scanning/42\",\"locations_url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations\",\"state\":\"resolved\",\"resolution\":\"used_in_tests\",\"resolved_at\":\"2020-11-16T22:42:07Z\",\"resolved_by\":{\"login\":\"monalisa\",\"id\":2,\"node_id\":\"MDQ6VXNlcjI=\",\"avatar_url\":\"https://alambic.github.com/avatars/u/2?\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"secret_type\":\"mailchimp_api_key\",\"secret_type_display_name\":\"Mailchimp API Key\",\"secret\":\"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2\",\"push_protection_bypassed\":false,\"push_protection_bypassed_by\":null,\"push_protection_bypassed_at\":null}" } ] }, @@ -50567,14 +57010,14 @@ "isDeprecated": true, "deprecationDate": "2020-01-21", "removalDate": "2021-02-01", - "description": "The \"Add team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Add or update team membership for a user](https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", + "description": "The \"Add team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Add or update team membership for a user](https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", "documentationUrl": "https://docs.github.com/rest/reference/teams#add-team-member-legacy", "previews": [], "headers": [], "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -50587,7 +57030,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -50624,14 +57067,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "documentationUrl": "https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user", "previews": [], "headers": [], "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -50644,7 +57087,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -50657,7 +57100,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -50670,7 +57113,7 @@ }, { "name": "role", - "description": "The role that this user should have in the team. Can be one of: \n\\* `member` - a normal member of the team. \n\\* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.", + "description": "The role that this user should have in the team.", "in": "BODY", "type": "string", "required": false, @@ -50714,14 +57157,14 @@ "isDeprecated": true, "deprecationDate": "2020-01-21", "removalDate": "2021-02-01", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", "documentationUrl": "https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user-legacy", "previews": [], "headers": [], "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -50734,7 +57177,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -50747,7 +57190,7 @@ }, { "name": "role", - "description": "The role that this user should have in the team. Can be one of: \n\\* `member` - a normal member of the team. \n\\* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.", + "description": "The role that this user should have in the team.", "in": "BODY", "type": "string", "required": false, @@ -50799,7 +57242,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -50812,7 +57255,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -50825,7 +57268,7 @@ }, { "name": "project_id", - "description": "", + "description": "The unique identifier of the project.", "in": "PATH", "type": "integer", "required": true, @@ -50838,7 +57281,7 @@ }, { "name": "permission", - "description": "The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", + "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", "in": "BODY", "type": "string", "required": false, @@ -50880,7 +57323,7 @@ "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -50893,7 +57336,7 @@ }, { "name": "project_id", - "description": "", + "description": "The unique identifier of the project.", "in": "PATH", "type": "integer", "required": true, @@ -50906,7 +57349,7 @@ }, { "name": "permission", - "description": "The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", + "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", "in": "BODY", "type": "string", "required": false, @@ -50943,14 +57386,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", + "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", "documentationUrl": "https://docs.github.com/rest/reference/teams/#add-or-update-team-repository-permissions", "previews": [], "headers": [], "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -50963,7 +57406,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -50976,7 +57419,7 @@ }, { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -50989,7 +57432,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -51002,7 +57445,7 @@ }, { "name": "permission", - "description": "The permission to grant the team on this repository. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer this repository. \n\\* `push` - team members can pull and push, but not administer this repository. \n\\* `admin` - team members can pull, push and administer this repository. \n\\* `maintain` - team members can manage the repository without access to sensitive or destructive actions. Recommended for project managers. Only applies to repositories owned by organizations. \n\\* `triage` - team members can proactively manage issues and pull requests without write access. Recommended for contributors who triage a repository. Only applies to repositories owned by organizations. \n \nIf no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", + "description": "The permission to grant the team on this repository. In addition to the enumerated values, you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", "in": "BODY", "type": "string", "required": false, @@ -51033,7 +57476,7 @@ "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -51046,7 +57489,7 @@ }, { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -51059,7 +57502,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -51072,7 +57515,7 @@ }, { "name": "permission", - "description": "The permission to grant the team on this repository. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer this repository. \n\\* `push` - team members can pull and push, but not administer this repository. \n\\* `admin` - team members can pull, push and administer this repository. \n \nIf no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", + "description": "The permission to grant the team on this repository. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", "in": "BODY", "type": "string", "required": false, @@ -51107,7 +57550,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -51120,7 +57563,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -51133,7 +57576,7 @@ }, { "name": "project_id", - "description": "", + "description": "The unique identifier of the project.", "in": "PATH", "type": "integer", "required": true, @@ -51179,7 +57622,7 @@ "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -51192,7 +57635,7 @@ }, { "name": "project_id", - "description": "", + "description": "The unique identifier of the project.", "in": "PATH", "type": "integer", "required": true, @@ -51238,7 +57681,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -51251,7 +57694,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -51264,7 +57707,7 @@ }, { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -51277,7 +57720,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -51295,7 +57738,7 @@ "description": "Alternative response with repository permissions", "examples": [ { - "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}" + "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"maintain\":false,\"push\":false,\"triage\":false,\"pull\":true},\"role_name\":\"read\",\"allow_rebase_merge\":true,\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"pull\":true,\"triage\":false,\"push\":false,\"maintain\":false,\"admin\":false},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}" } ] }, @@ -51328,7 +57771,7 @@ "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -51341,7 +57784,7 @@ }, { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -51354,7 +57797,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -51372,7 +57815,7 @@ "description": "Alternative response with extra repository information", "examples": [ { - "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}" + "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"maintain\":false,\"push\":false,\"triage\":false,\"pull\":true},\"role_name\":\"read\",\"allow_rebase_merge\":true,\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"pull\":true,\"triage\":false,\"push\":false,\"maintain\":false,\"admin\":false},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}" } ] }, @@ -51398,14 +57841,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://help.github.com/en/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)\".", + "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://docs.github.com/en/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)\".", "documentationUrl": "https://docs.github.com/rest/reference/teams#create-a-team", "previews": [], "headers": [], "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -51483,11 +57926,11 @@ }, { "name": "permission", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", + "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", "in": "BODY", "type": "string", "required": false, - "enum": ["pull", "push", "admin"], + "enum": ["pull", "push"], "allowNull": false, "mapToData": null, "validation": null, @@ -51539,7 +57982,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -51552,7 +57995,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -51565,7 +58008,7 @@ }, { "name": "discussion_number", - "description": "", + "description": "The number that identifies the discussion.", "in": "PATH", "type": "integer", "required": true, @@ -51619,7 +58062,7 @@ "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -51632,7 +58075,7 @@ }, { "name": "discussion_number", - "description": "", + "description": "The number that identifies the discussion.", "in": "PATH", "type": "integer", "required": true, @@ -51686,7 +58129,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -51699,7 +58142,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -51779,7 +58222,7 @@ "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -51859,7 +58302,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -51872,7 +58315,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -51885,7 +58328,7 @@ }, { "name": "discussion_number", - "description": "", + "description": "The number that identifies the discussion.", "in": "PATH", "type": "integer", "required": true, @@ -51898,7 +58341,7 @@ }, { "name": "comment_number", - "description": "", + "description": "The number that identifies the comment.", "in": "PATH", "type": "integer", "required": true, @@ -51929,7 +58372,7 @@ "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -51942,7 +58385,7 @@ }, { "name": "discussion_number", - "description": "", + "description": "The number that identifies the discussion.", "in": "PATH", "type": "integer", "required": true, @@ -51955,7 +58398,7 @@ }, { "name": "comment_number", - "description": "", + "description": "The number that identifies the comment.", "in": "PATH", "type": "integer", "required": true, @@ -51986,7 +58429,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -51999,7 +58442,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -52012,7 +58455,7 @@ }, { "name": "discussion_number", - "description": "", + "description": "The number that identifies the discussion.", "in": "PATH", "type": "integer", "required": true, @@ -52043,7 +58486,7 @@ "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -52056,7 +58499,7 @@ }, { "name": "discussion_number", - "description": "", + "description": "The number that identifies the discussion.", "in": "PATH", "type": "integer", "required": true, @@ -52087,7 +58530,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -52100,7 +58543,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -52131,7 +58574,7 @@ "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -52166,7 +58609,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -52179,7 +58622,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -52221,7 +58664,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -52234,7 +58677,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -52247,7 +58690,7 @@ }, { "name": "discussion_number", - "description": "", + "description": "The number that identifies the discussion.", "in": "PATH", "type": "integer", "required": true, @@ -52260,7 +58703,7 @@ }, { "name": "comment_number", - "description": "", + "description": "The number that identifies the comment.", "in": "PATH", "type": "integer", "required": true, @@ -52301,7 +58744,7 @@ "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -52314,7 +58757,7 @@ }, { "name": "discussion_number", - "description": "", + "description": "The number that identifies the discussion.", "in": "PATH", "type": "integer", "required": true, @@ -52327,7 +58770,7 @@ }, { "name": "comment_number", - "description": "", + "description": "The number that identifies the comment.", "in": "PATH", "type": "integer", "required": true, @@ -52368,7 +58811,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -52381,7 +58824,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -52394,7 +58837,7 @@ }, { "name": "discussion_number", - "description": "", + "description": "The number that identifies the discussion.", "in": "PATH", "type": "integer", "required": true, @@ -52435,7 +58878,7 @@ "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -52448,7 +58891,7 @@ }, { "name": "discussion_number", - "description": "", + "description": "The number that identifies the discussion.", "in": "PATH", "type": "integer", "required": true, @@ -52489,7 +58932,7 @@ "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -52531,7 +58974,7 @@ "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -52544,7 +58987,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -52582,7 +59025,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -52595,7 +59038,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -52608,7 +59051,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -52654,7 +59097,7 @@ "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -52667,7 +59110,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -52709,7 +59152,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -52722,7 +59165,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -52777,7 +59220,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -52790,7 +59233,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -52803,7 +59246,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -52857,7 +59300,7 @@ "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -52870,7 +59313,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -52927,7 +59370,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -52940,7 +59383,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -52953,7 +59396,7 @@ }, { "name": "discussion_number", - "description": "", + "description": "The number that identifies the discussion.", "in": "PATH", "type": "integer", "required": true, @@ -52966,7 +59409,7 @@ }, { "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", + "description": "The direction to sort the results by.", "in": "QUERY", "type": "string", "required": false, @@ -52979,7 +59422,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -53033,7 +59476,7 @@ "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -53046,7 +59489,7 @@ }, { "name": "discussion_number", - "description": "", + "description": "The number that identifies the discussion.", "in": "PATH", "type": "integer", "required": true, @@ -53059,7 +59502,7 @@ }, { "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", + "description": "The direction to sort the results by.", "in": "QUERY", "type": "string", "required": false, @@ -53072,7 +59515,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -53126,7 +59569,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -53139,7 +59582,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -53152,7 +59595,7 @@ }, { "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", + "description": "The direction to sort the results by.", "in": "QUERY", "type": "string", "required": false, @@ -53165,7 +59608,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -53232,7 +59675,7 @@ "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -53245,7 +59688,7 @@ }, { "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", + "description": "The direction to sort the results by.", "in": "QUERY", "type": "string", "required": false, @@ -53258,7 +59701,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -53312,7 +59755,7 @@ "parameters": [ { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -53369,7 +59812,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -53382,7 +59825,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -53395,7 +59838,7 @@ }, { "name": "role", - "description": "Filters members returned by their role in the team. Can be one of: \n\\* `member` - normal members of the team. \n\\* `maintainer` - team maintainers. \n\\* `all` - all members of the team.", + "description": "Filters members returned by their role in the team.", "in": "QUERY", "type": "string", "required": false, @@ -53408,7 +59851,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -53462,7 +59905,7 @@ "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -53475,7 +59918,7 @@ }, { "name": "role", - "description": "Filters members returned by their role in the team. Can be one of: \n\\* `member` - normal members of the team. \n\\* `maintainer` - team maintainers. \n\\* `all` - all members of the team.", + "description": "Filters members returned by their role in the team.", "in": "QUERY", "type": "string", "required": false, @@ -53488,7 +59931,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -53543,7 +59986,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -53556,7 +59999,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -53569,7 +60012,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -53623,7 +60066,7 @@ "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -53636,7 +60079,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -53690,7 +60133,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -53703,7 +60146,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -53716,7 +60159,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -53770,7 +60213,7 @@ "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -53783,7 +60226,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -53838,7 +60281,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -53851,7 +60294,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -53864,7 +60307,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -53895,7 +60338,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" } ] } @@ -53918,7 +60361,7 @@ "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -53931,7 +60374,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -53962,7 +60405,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" } ] }, @@ -53979,14 +60422,14 @@ "isDeprecated": true, "deprecationDate": "2020-01-21", "removalDate": "2021-02-01", - "description": "The \"Remove team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "description": "The \"Remove team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", "documentationUrl": "https://docs.github.com/rest/reference/teams#remove-team-member-legacy", "previews": [], "headers": [], "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -53999,7 +60442,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -54030,14 +60473,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "documentationUrl": "https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user", "previews": [], "headers": [], "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -54050,7 +60493,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -54063,7 +60506,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -54094,14 +60537,14 @@ "isDeprecated": true, "deprecationDate": "2020-01-21", "removalDate": "2021-02-01", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", "documentationUrl": "https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user-legacy", "previews": [], "headers": [], "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -54114,7 +60557,7 @@ }, { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -54152,7 +60595,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -54165,7 +60608,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -54178,7 +60621,7 @@ }, { "name": "project_id", - "description": "", + "description": "The unique identifier of the project.", "in": "PATH", "type": "integer", "required": true, @@ -54209,7 +60652,7 @@ "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -54222,7 +60665,7 @@ }, { "name": "project_id", - "description": "", + "description": "The unique identifier of the project.", "in": "PATH", "type": "integer", "required": true, @@ -54237,11 +60680,6 @@ "responses": [ { "code": 204, "description": "Response", "examples": null }, { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, { "code": 422, "description": "Validation failed", "examples": null } ], "renamed": null @@ -54262,7 +60700,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -54275,7 +60713,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -54288,7 +60726,7 @@ }, { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -54301,7 +60739,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -54332,7 +60770,7 @@ "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -54345,7 +60783,7 @@ }, { "name": "owner", - "description": "", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -54358,7 +60796,7 @@ }, { "name": "repo", - "description": "", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -54389,7 +60827,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -54402,7 +60840,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -54415,7 +60853,7 @@ }, { "name": "discussion_number", - "description": "", + "description": "The number that identifies the discussion.", "in": "PATH", "type": "integer", "required": true, @@ -54428,7 +60866,7 @@ }, { "name": "comment_number", - "description": "", + "description": "The number that identifies the comment.", "in": "PATH", "type": "integer", "required": true, @@ -54482,7 +60920,7 @@ "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -54495,7 +60933,7 @@ }, { "name": "discussion_number", - "description": "", + "description": "The number that identifies the discussion.", "in": "PATH", "type": "integer", "required": true, @@ -54508,7 +60946,7 @@ }, { "name": "comment_number", - "description": "", + "description": "The number that identifies the comment.", "in": "PATH", "type": "integer", "required": true, @@ -54562,7 +61000,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -54575,7 +61013,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -54588,7 +61026,7 @@ }, { "name": "discussion_number", - "description": "", + "description": "The number that identifies the discussion.", "in": "PATH", "type": "integer", "required": true, @@ -54655,7 +61093,7 @@ "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -54668,7 +61106,7 @@ }, { "name": "discussion_number", - "description": "", + "description": "The number that identifies the discussion.", "in": "PATH", "type": "integer", "required": true, @@ -54735,7 +61173,7 @@ "parameters": [ { "name": "org", - "description": "", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -54748,7 +61186,7 @@ }, { "name": "team_slug", - "description": "team_slug parameter", + "description": "The slug of the team name.", "in": "PATH", "type": "string", "required": true, @@ -54800,7 +61238,7 @@ }, { "name": "permission", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", + "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", "in": "BODY", "type": "string", "required": false, @@ -54854,7 +61292,7 @@ "parameters": [ { "name": "team_id", - "description": "", + "description": "The unique identifier of the team.", "in": "PATH", "type": "integer", "required": true, @@ -54906,7 +61344,7 @@ }, { "name": "permission", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", + "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", "in": "BODY", "type": "string", "required": false, @@ -54934,7 +61372,7 @@ "responses": [ { "code": 200, - "description": "Response", + "description": "Response when the updated information already exists", "examples": [ { "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null,\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"type\":\"Organization\"}}" @@ -55077,7 +61515,7 @@ "parameters": [ { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -55119,7 +61557,7 @@ "parameters": [ { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -55168,7 +61606,7 @@ "parameters": [ { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -55223,7 +61661,7 @@ "parameters": [ { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -55270,6 +61708,19 @@ "previews": [], "headers": [], "parameters": [ + { + "name": "name", + "description": "A descriptive name for the new key.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "armored_public_key", "description": "A GPG key in ASCII-armored format.", @@ -55290,7 +61741,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":3,\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"mastahyeti@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\"}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"raw_key\":\"\\\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\\\nVersion: GnuPG v2\\\\n\\\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\\\nIts/HFYRLiFgDLmTlxo=\\\\n=+OzK\\\\n-----END PGP PUBLIC KEY BLOCK-----\\\"\"}" + "data": "{\"id\":3,\"name\":\"Octocat's GPG Key\",\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"revoked\":false}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"revoked\":false,\"raw_key\":\"\\\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\\\nVersion: GnuPG v2\\\\n\\\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\\\nIts/HFYRLiFgDLmTlxo=\\\\n=+OzK\\\\n-----END PGP PUBLIC KEY BLOCK-----\\\"\"}" } ] }, @@ -55325,6 +61776,19 @@ "previews": [], "headers": [], "parameters": [ + { + "name": "name", + "description": "A descriptive name for the new key.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "armored_public_key", "description": "A GPG key in ASCII-armored format.", @@ -55345,7 +61809,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":3,\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"mastahyeti@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\"}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"raw_key\":\"\\\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\\\nVersion: GnuPG v2\\\\n\\\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\\\nIts/HFYRLiFgDLmTlxo=\\\\n=+OzK\\\\n-----END PGP PUBLIC KEY BLOCK-----\\\"\"}" + "data": "{\"id\":3,\"name\":\"Octocat's GPG Key\",\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"revoked\":false}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"revoked\":false,\"raw_key\":\"\\\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\\\nVersion: GnuPG v2\\\\n\\\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\\\nIts/HFYRLiFgDLmTlxo=\\\\n=+OzK\\\\n-----END PGP PUBLIC KEY BLOCK-----\\\"\"}" } ] }, @@ -55603,7 +62067,7 @@ "parameters": [ { "name": "gpg_key_id", - "description": "gpg_key_id parameter", + "description": "The unique identifier of the GPG key.", "in": "PATH", "type": "integer", "required": true, @@ -55650,7 +62114,7 @@ "parameters": [ { "name": "gpg_key_id", - "description": "gpg_key_id parameter", + "description": "The unique identifier of the GPG key.", "in": "PATH", "type": "integer", "required": true, @@ -55692,7 +62156,7 @@ "parameters": [ { "name": "key_id", - "description": "key_id parameter", + "description": "The unique identifier of the key.", "in": "PATH", "type": "integer", "required": true, @@ -55744,7 +62208,7 @@ "parameters": [ { "name": "key_id", - "description": "key_id parameter", + "description": "The unique identifier of the key.", "in": "PATH", "type": "integer", "required": true, @@ -55785,7 +62249,7 @@ "parameters": [ { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -55863,7 +62327,7 @@ "parameters": [ { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -55888,7 +62352,6 @@ } ] }, - { "code": 202, "description": "Accepted", "examples": null }, { "code": 404, "description": "Resource not found", "examples": null } ], "renamed": null @@ -55909,7 +62372,7 @@ "parameters": [ { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -55978,7 +62441,7 @@ "parameters": [ { "name": "gpg_key_id", - "description": "gpg_key_id parameter", + "description": "The unique identifier of the GPG key.", "in": "PATH", "type": "integer", "required": true, @@ -55996,7 +62459,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":3,\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"mastahyeti@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\"}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"raw_key\":\"\\\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\\\nVersion: GnuPG v2\\\\n\\\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\\\nIts/HFYRLiFgDLmTlxo=\\\\n=+OzK\\\\n-----END PGP PUBLIC KEY BLOCK-----\\\"\"}" + "data": "{\"id\":3,\"name\":\"Octocat's GPG Key\",\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"revoked\":false}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"revoked\":false,\"raw_key\":\"\\\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\\\nVersion: GnuPG v2\\\\n\\\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\\\nIts/HFYRLiFgDLmTlxo=\\\\n=+OzK\\\\n-----END PGP PUBLIC KEY BLOCK-----\\\"\"}" } ] }, @@ -56032,7 +62495,7 @@ "parameters": [ { "name": "gpg_key_id", - "description": "gpg_key_id parameter", + "description": "The unique identifier of the GPG key.", "in": "PATH", "type": "integer", "required": true, @@ -56050,7 +62513,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":3,\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"mastahyeti@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\"}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"raw_key\":\"\\\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\\\nVersion: GnuPG v2\\\\n\\\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\\\nIts/HFYRLiFgDLmTlxo=\\\\n=+OzK\\\\n-----END PGP PUBLIC KEY BLOCK-----\\\"\"}" + "data": "{\"id\":3,\"name\":\"Octocat's GPG Key\",\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"revoked\":false}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"revoked\":false,\"raw_key\":\"\\\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\\\nVersion: GnuPG v2\\\\n\\\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\\\nIts/HFYRLiFgDLmTlxo=\\\\n=+OzK\\\\n-----END PGP PUBLIC KEY BLOCK-----\\\"\"}" } ] }, @@ -56081,7 +62544,7 @@ "parameters": [ { "name": "key_id", - "description": "key_id parameter", + "description": "The unique identifier of the key.", "in": "PATH", "type": "integer", "required": true, @@ -56138,7 +62601,7 @@ "parameters": [ { "name": "key_id", - "description": "key_id parameter", + "description": "The unique identifier of the key.", "in": "PATH", "type": "integer", "required": true, @@ -56200,7 +62663,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -56257,8 +62720,7 @@ "examples": null }, { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } + { "code": 404, "description": "Resource not found", "examples": null } ], "renamed": { "before": { "scope": "users", "id": "listBlockedByAuthenticated" }, @@ -56298,8 +62760,7 @@ "examples": null }, { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } + { "code": 404, "description": "Resource not found", "examples": null } ], "renamed": null }, @@ -56319,7 +62780,7 @@ "parameters": [ { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -56386,7 +62847,7 @@ "parameters": [ { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -56448,7 +62909,7 @@ "parameters": [ { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -56514,7 +62975,7 @@ "parameters": [ { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -56575,7 +63036,7 @@ "parameters": [ { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -56636,7 +63097,7 @@ "parameters": [ { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -56649,7 +63110,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -56703,7 +63164,7 @@ "parameters": [ { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -56716,7 +63177,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -56770,7 +63231,7 @@ "parameters": [ { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -56801,7 +63262,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":3,\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"mastahyeti@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\"}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"raw_key\":\"string\"}]" + "data": "[{\"id\":3,\"name\":\"Octocat's GPG Key\",\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"revoked\":false}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"revoked\":false,\"raw_key\":\"string\"}]" } ] }, @@ -56837,7 +63298,7 @@ "parameters": [ { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -56868,7 +63329,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":3,\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"mastahyeti@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\"}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"raw_key\":\"string\"}]" + "data": "[{\"id\":3,\"name\":\"Octocat's GPG Key\",\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"revoked\":false}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"revoked\":false,\"raw_key\":\"string\"}]" } ] }, @@ -56899,7 +63360,7 @@ "parameters": [ { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -56912,7 +63373,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -56943,7 +63404,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":3,\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"mastahyeti@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\"}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"raw_key\":\"string\"}]" + "data": "[{\"id\":3,\"name\":\"Octocat's GPG Key\",\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"revoked\":false}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"revoked\":false,\"raw_key\":\"string\"}]" } ] } @@ -56966,7 +63427,7 @@ "parameters": [ { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -57036,7 +63497,7 @@ "parameters": [ { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -57098,7 +63559,7 @@ "parameters": [ { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -57111,7 +63572,7 @@ }, { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -57161,7 +63622,7 @@ "parameters": [ { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -57231,7 +63692,7 @@ "parameters": [ { "name": "per_page", - "description": "Results per page (max 100)", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -57404,7 +63865,7 @@ "parameters": [ { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, @@ -57445,7 +63906,7 @@ "parameters": [ { "name": "username", - "description": "", + "description": "The handle for the GitHub user account.", "in": "PATH", "type": "string", "required": true, diff --git a/src/generated/endpoints.ts b/src/generated/endpoints.ts index 0df659009..21b6ba0bd 100644 --- a/src/generated/endpoints.ts +++ b/src/generated/endpoints.ts @@ -1,6 +1,12 @@ import { EndpointsDefaultsAndDecorations } from "../types"; const Endpoints: EndpointsDefaultsAndDecorations = { actions: { + addCustomLabelsToSelfHostedRunnerForOrg: [ + "POST /orgs/{org}/actions/runners/{runner_id}/labels", + ], + addCustomLabelsToSelfHostedRunnerForRepo: [ + "POST /repos/{owner}/{repo}/actions/runners/{runner_id}/labels", + ], addSelectedRepoToOrgSecret: [ "PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", ], @@ -74,6 +80,14 @@ const Endpoints: EndpointsDefaultsAndDecorations = { enableWorkflow: [ "PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable", ], + getActionsCacheUsage: ["GET /repos/{owner}/{repo}/actions/cache/usage"], + getActionsCacheUsageByRepoForOrg: [ + "GET /orgs/{org}/actions/cache/usage-by-repository", + ], + getActionsCacheUsageForEnterprise: [ + "GET /enterprises/{enterprise}/actions/cache/usage", + ], + getActionsCacheUsageForOrg: ["GET /orgs/{org}/actions/cache/usage"], getAllowedActionsOrganization: [ "GET /orgs/{org}/actions/permissions/selected-actions", ], @@ -87,6 +101,15 @@ const Endpoints: EndpointsDefaultsAndDecorations = { getEnvironmentSecret: [ "GET /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", ], + getGithubActionsDefaultWorkflowPermissionsEnterprise: [ + "GET /enterprises/{enterprise}/actions/permissions/workflow", + ], + getGithubActionsDefaultWorkflowPermissionsOrganization: [ + "GET /orgs/{org}/actions/permissions/workflow", + ], + getGithubActionsDefaultWorkflowPermissionsRepository: [ + "GET /repos/{owner}/{repo}/actions/permissions/workflow", + ], getGithubActionsPermissionsOrganization: [ "GET /orgs/{org}/actions/permissions", ], @@ -114,6 +137,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = { "GET /repos/{owner}/{repo}/actions/runners/{runner_id}", ], getWorkflow: ["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}"], + getWorkflowAccessToRepository: [ + "GET /repos/{owner}/{repo}/actions/permissions/access", + ], getWorkflowRun: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}"], getWorkflowRunAttempt: [ "GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}", @@ -134,6 +160,12 @@ const Endpoints: EndpointsDefaultsAndDecorations = { listJobsForWorkflowRunAttempt: [ "GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs", ], + listLabelsForSelfHostedRunnerForOrg: [ + "GET /orgs/{org}/actions/runners/{runner_id}/labels", + ], + listLabelsForSelfHostedRunnerForRepo: [ + "GET /repos/{owner}/{repo}/actions/runners/{runner_id}/labels", + ], listOrgSecrets: ["GET /orgs/{org}/actions/secrets"], listRepoSecrets: ["GET /repos/{owner}/{repo}/actions/secrets"], listRepoWorkflows: ["GET /repos/{owner}/{repo}/actions/workflows"], @@ -156,6 +188,25 @@ const Endpoints: EndpointsDefaultsAndDecorations = { "GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs", ], listWorkflowRunsForRepo: ["GET /repos/{owner}/{repo}/actions/runs"], + reRunJobForWorkflowRun: [ + "POST /repos/{owner}/{repo}/actions/jobs/{job_id}/rerun", + ], + reRunWorkflow: ["POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun"], + reRunWorkflowFailedJobs: [ + "POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs", + ], + removeAllCustomLabelsFromSelfHostedRunnerForOrg: [ + "DELETE /orgs/{org}/actions/runners/{runner_id}/labels", + ], + removeAllCustomLabelsFromSelfHostedRunnerForRepo: [ + "DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}/labels", + ], + removeCustomLabelFromSelfHostedRunnerForOrg: [ + "DELETE /orgs/{org}/actions/runners/{runner_id}/labels/{name}", + ], + removeCustomLabelFromSelfHostedRunnerForRepo: [ + "DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}", + ], removeSelectedRepoFromOrgSecret: [ "DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", ], @@ -168,6 +219,21 @@ const Endpoints: EndpointsDefaultsAndDecorations = { setAllowedActionsRepository: [ "PUT /repos/{owner}/{repo}/actions/permissions/selected-actions", ], + setCustomLabelsForSelfHostedRunnerForOrg: [ + "PUT /orgs/{org}/actions/runners/{runner_id}/labels", + ], + setCustomLabelsForSelfHostedRunnerForRepo: [ + "PUT /repos/{owner}/{repo}/actions/runners/{runner_id}/labels", + ], + setGithubActionsDefaultWorkflowPermissionsEnterprise: [ + "PUT /enterprises/{enterprise}/actions/permissions/workflow", + ], + setGithubActionsDefaultWorkflowPermissionsOrganization: [ + "PUT /orgs/{org}/actions/permissions/workflow", + ], + setGithubActionsDefaultWorkflowPermissionsRepository: [ + "PUT /repos/{owner}/{repo}/actions/permissions/workflow", + ], setGithubActionsPermissionsOrganization: [ "PUT /orgs/{org}/actions/permissions", ], @@ -180,6 +246,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = { setSelectedRepositoriesEnabledGithubActionsOrganization: [ "PUT /orgs/{org}/actions/permissions/repositories", ], + setWorkflowAccessToRepository: [ + "PUT /repos/{owner}/{repo}/actions/permissions/access", + ], }, activity: { checkRepoIsStarredByAuthenticatedUser: ["GET /user/starred/{owner}/{repo}"], @@ -236,14 +305,6 @@ const Endpoints: EndpointsDefaultsAndDecorations = { "PUT /user/installations/{installation_id}/repositories/{repository_id}", ], checkToken: ["POST /applications/{client_id}/token"], - createContentAttachment: [ - "POST /content_references/{content_reference_id}/attachments", - { mediaType: { previews: ["corsair"] } }, - ], - createContentAttachmentForRepo: [ - "POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", - { mediaType: { previews: ["corsair"] } }, - ], createFromManifest: ["POST /app-manifests/{code}/conversions"], createInstallationAccessToken: [ "POST /app/installations/{installation_id}/access_tokens", @@ -307,6 +368,12 @@ const Endpoints: EndpointsDefaultsAndDecorations = { getGithubActionsBillingUser: [ "GET /users/{username}/settings/billing/actions", ], + getGithubAdvancedSecurityBillingGhe: [ + "GET /enterprises/{enterprise}/settings/billing/advanced-security", + ], + getGithubAdvancedSecurityBillingOrg: [ + "GET /orgs/{org}/settings/billing/advanced-security", + ], getGithubPackagesBillingOrg: ["GET /orgs/{org}/settings/billing/packages"], getGithubPackagesBillingUser: [ "GET /users/{username}/settings/billing/packages", @@ -358,6 +425,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { listAlertInstances: [ "GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", ], + listAlertsForOrg: ["GET /orgs/{org}/code-scanning/alerts"], listAlertsForRepo: ["GET /repos/{owner}/{repo}/code-scanning/alerts"], listAlertsInstances: [ "GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", @@ -374,8 +442,121 @@ const Endpoints: EndpointsDefaultsAndDecorations = { getAllCodesOfConduct: ["GET /codes_of_conduct"], getConductCode: ["GET /codes_of_conduct/{key}"], }, + codespaces: { + addRepositoryForSecretForAuthenticatedUser: [ + "PUT /user/codespaces/secrets/{secret_name}/repositories/{repository_id}", + ], + codespaceMachinesForAuthenticatedUser: [ + "GET /user/codespaces/{codespace_name}/machines", + ], + createForAuthenticatedUser: ["POST /user/codespaces"], + createOrUpdateRepoSecret: [ + "PUT /repos/{owner}/{repo}/codespaces/secrets/{secret_name}", + ], + createOrUpdateSecretForAuthenticatedUser: [ + "PUT /user/codespaces/secrets/{secret_name}", + ], + createWithPrForAuthenticatedUser: [ + "POST /repos/{owner}/{repo}/pulls/{pull_number}/codespaces", + ], + createWithRepoForAuthenticatedUser: [ + "POST /repos/{owner}/{repo}/codespaces", + ], + deleteForAuthenticatedUser: ["DELETE /user/codespaces/{codespace_name}"], + deleteRepoSecret: [ + "DELETE /repos/{owner}/{repo}/codespaces/secrets/{secret_name}", + ], + deleteSecretForAuthenticatedUser: [ + "DELETE /user/codespaces/secrets/{secret_name}", + ], + exportForAuthenticatedUser: [ + "POST /user/codespaces/{codespace_name}/exports", + ], + getExportDetailsForAuthenticatedUser: [ + "GET /user/codespaces/{codespace_name}/exports/{export_id}", + ], + getForAuthenticatedUser: ["GET /user/codespaces/{codespace_name}"], + getPublicKeyForAuthenticatedUser: [ + "GET /user/codespaces/secrets/public-key", + ], + getRepoPublicKey: [ + "GET /repos/{owner}/{repo}/codespaces/secrets/public-key", + ], + getRepoSecret: [ + "GET /repos/{owner}/{repo}/codespaces/secrets/{secret_name}", + ], + getSecretForAuthenticatedUser: [ + "GET /user/codespaces/secrets/{secret_name}", + ], + listDevcontainersInRepositoryForAuthenticatedUser: [ + "GET /repos/{owner}/{repo}/codespaces/devcontainers", + ], + listForAuthenticatedUser: ["GET /user/codespaces"], + listInRepositoryForAuthenticatedUser: [ + "GET /repos/{owner}/{repo}/codespaces", + ], + listRepoSecrets: ["GET /repos/{owner}/{repo}/codespaces/secrets"], + listRepositoriesForSecretForAuthenticatedUser: [ + "GET /user/codespaces/secrets/{secret_name}/repositories", + ], + listSecretsForAuthenticatedUser: ["GET /user/codespaces/secrets"], + removeRepositoryForSecretForAuthenticatedUser: [ + "DELETE /user/codespaces/secrets/{secret_name}/repositories/{repository_id}", + ], + repoMachinesForAuthenticatedUser: [ + "GET /repos/{owner}/{repo}/codespaces/machines", + ], + setRepositoriesForSecretForAuthenticatedUser: [ + "PUT /user/codespaces/secrets/{secret_name}/repositories", + ], + startForAuthenticatedUser: ["POST /user/codespaces/{codespace_name}/start"], + stopForAuthenticatedUser: ["POST /user/codespaces/{codespace_name}/stop"], + updateForAuthenticatedUser: ["PATCH /user/codespaces/{codespace_name}"], + }, + dependabot: { + addSelectedRepoToOrgSecret: [ + "PUT /orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", + ], + createOrUpdateOrgSecret: [ + "PUT /orgs/{org}/dependabot/secrets/{secret_name}", + ], + createOrUpdateRepoSecret: [ + "PUT /repos/{owner}/{repo}/dependabot/secrets/{secret_name}", + ], + deleteOrgSecret: ["DELETE /orgs/{org}/dependabot/secrets/{secret_name}"], + deleteRepoSecret: [ + "DELETE /repos/{owner}/{repo}/dependabot/secrets/{secret_name}", + ], + getOrgPublicKey: ["GET /orgs/{org}/dependabot/secrets/public-key"], + getOrgSecret: ["GET /orgs/{org}/dependabot/secrets/{secret_name}"], + getRepoPublicKey: [ + "GET /repos/{owner}/{repo}/dependabot/secrets/public-key", + ], + getRepoSecret: [ + "GET /repos/{owner}/{repo}/dependabot/secrets/{secret_name}", + ], + listOrgSecrets: ["GET /orgs/{org}/dependabot/secrets"], + listRepoSecrets: ["GET /repos/{owner}/{repo}/dependabot/secrets"], + listSelectedReposForOrgSecret: [ + "GET /orgs/{org}/dependabot/secrets/{secret_name}/repositories", + ], + removeSelectedRepoFromOrgSecret: [ + "DELETE /orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", + ], + setSelectedReposForOrgSecret: [ + "PUT /orgs/{org}/dependabot/secrets/{secret_name}/repositories", + ], + }, + dependencyGraph: { + diffRange: [ + "GET /repos/{owner}/{repo}/dependency-graph/compare/{basehead}", + ], + }, emojis: { get: ["GET /emojis"] }, enterpriseAdmin: { + addCustomLabelsToSelfHostedRunnerForEnterprise: [ + "POST /enterprises/{enterprise}/actions/runners/{runner_id}/labels", + ], disableSelectedOrganizationGithubActionsEnterprise: [ "DELETE /enterprises/{enterprise}/actions/permissions/organizations/{org_id}", ], @@ -388,12 +569,27 @@ const Endpoints: EndpointsDefaultsAndDecorations = { getGithubActionsPermissionsEnterprise: [ "GET /enterprises/{enterprise}/actions/permissions", ], + getServerStatistics: [ + "GET /enterprise-installation/{enterprise_or_org}/server-statistics", + ], + listLabelsForSelfHostedRunnerForEnterprise: [ + "GET /enterprises/{enterprise}/actions/runners/{runner_id}/labels", + ], listSelectedOrganizationsEnabledGithubActionsEnterprise: [ "GET /enterprises/{enterprise}/actions/permissions/organizations", ], + removeAllCustomLabelsFromSelfHostedRunnerForEnterprise: [ + "DELETE /enterprises/{enterprise}/actions/runners/{runner_id}/labels", + ], + removeCustomLabelFromSelfHostedRunnerForEnterprise: [ + "DELETE /enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}", + ], setAllowedActionsEnterprise: [ "PUT /enterprises/{enterprise}/actions/permissions/selected-actions", ], + setCustomLabelsForSelfHostedRunnerForEnterprise: [ + "PUT /enterprises/{enterprise}/actions/runners/{runner_id}/labels", + ], setGithubActionsPermissionsEnterprise: [ "PUT /enterprises/{enterprise}/actions/permissions", ], @@ -617,6 +813,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { list: ["GET /organizations"], listAppInstallations: ["GET /orgs/{org}/installations"], listBlockedUsers: ["GET /orgs/{org}/blocks"], + listCustomRoles: ["GET /organizations/{organization_id}/custom_roles"], listFailedInvitations: ["GET /orgs/{org}/failed_invitations"], listForAuthenticatedUser: ["GET /user/orgs"], listForUser: ["GET /users/{username}/orgs"], @@ -860,6 +1057,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = { deleteForPullRequestComment: [ "DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}", ], + deleteForRelease: [ + "DELETE /repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}", + ], deleteForTeamDiscussion: [ "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}", ], @@ -876,6 +1076,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = { listForPullRequestReviewComment: [ "GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", ], + listForRelease: [ + "GET /repos/{owner}/{repo}/releases/{release_id}/reactions", + ], listForTeamDiscussionCommentInOrg: [ "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", ], @@ -917,6 +1120,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { checkVulnerabilityAlerts: [ "GET /repos/{owner}/{repo}/vulnerability-alerts", ], + codeownersErrors: ["GET /repos/{owner}/{repo}/codeowners/errors"], compareCommits: ["GET /repos/{owner}/{repo}/compare/{base}...{head}"], compareCommitsWithBasehead: [ "GET /repos/{owner}/{repo}/compare/{basehead}", @@ -944,6 +1148,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { createOrUpdateFileContents: ["PUT /repos/{owner}/{repo}/contents/{path}"], createPagesSite: ["POST /repos/{owner}/{repo}/pages"], createRelease: ["POST /repos/{owner}/{repo}/releases"], + createTagProtection: ["POST /repos/{owner}/{repo}/tags/protection"], createUsingTemplate: [ "POST /repos/{template_owner}/{template_repo}/generate", ], @@ -990,6 +1195,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = { deleteReleaseAsset: [ "DELETE /repos/{owner}/{repo}/releases/assets/{asset_id}", ], + deleteTagProtection: [ + "DELETE /repos/{owner}/{repo}/tags/protection/{tag_protection_id}", + ], deleteWebhook: ["DELETE /repos/{owner}/{repo}/hooks/{hook_id}"], disableAutomatedSecurityFixes: [ "DELETE /repos/{owner}/{repo}/automated-security-fixes", @@ -1026,10 +1234,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { getAllStatusCheckContexts: [ "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", ], - getAllTopics: [ - "GET /repos/{owner}/{repo}/topics", - { mediaType: { previews: ["mercy"] } }, - ], + getAllTopics: ["GET /repos/{owner}/{repo}/topics"], getAppsWithAccessToProtectedBranch: [ "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", ], @@ -1131,6 +1336,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { "GET /repos/{owner}/{repo}/releases/{release_id}/assets", ], listReleases: ["GET /repos/{owner}/{repo}/releases"], + listTagProtection: ["GET /repos/{owner}/{repo}/tags/protection"], listTags: ["GET /repos/{owner}/{repo}/tags"], listTeams: ["GET /repos/{owner}/{repo}/teams"], listWebhookDeliveries: [ @@ -1170,10 +1376,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { { mapToData: "users" }, ], renameBranch: ["POST /repos/{owner}/{repo}/branches/{branch}/rename"], - replaceAllTopics: [ - "PUT /repos/{owner}/{repo}/topics", - { mediaType: { previews: ["mercy"] } }, - ], + replaceAllTopics: ["PUT /repos/{owner}/{repo}/topics"], requestPagesBuild: ["POST /repos/{owner}/{repo}/pages/builds"], setAdminBranchProtection: [ "POST /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", @@ -1239,15 +1442,21 @@ const Endpoints: EndpointsDefaultsAndDecorations = { issuesAndPullRequests: ["GET /search/issues"], labels: ["GET /search/labels"], repos: ["GET /search/repositories"], - topics: ["GET /search/topics", { mediaType: { previews: ["mercy"] } }], + topics: ["GET /search/topics"], users: ["GET /search/users"], }, secretScanning: { getAlert: [ "GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", ], + listAlertsForEnterprise: [ + "GET /enterprises/{enterprise}/secret-scanning/alerts", + ], listAlertsForOrg: ["GET /orgs/{org}/secret-scanning/alerts"], listAlertsForRepo: ["GET /repos/{owner}/{repo}/secret-scanning/alerts"], + listLocationsForAlert: [ + "GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations", + ], updateAlert: [ "PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", ], diff --git a/src/generated/method-types.ts b/src/generated/method-types.ts index 1c542e037..4dd1c1977 100644 --- a/src/generated/method-types.ts +++ b/src/generated/method-types.ts @@ -3,6 +3,35 @@ import { RestEndpointMethodTypes } from "./parameters-and-response-types"; export type RestEndpointMethods = { actions: { + /** + * Add custom labels to a self-hosted runner configured in an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + addCustomLabelsToSelfHostedRunnerForOrg: { + ( + params?: RestEndpointMethodTypes["actions"]["addCustomLabelsToSelfHostedRunnerForOrg"]["parameters"] + ): Promise< + RestEndpointMethodTypes["actions"]["addCustomLabelsToSelfHostedRunnerForOrg"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Add custom labels to a self-hosted runner configured in a repository. + * + * You must authenticate using an access token with the `repo` scope to use this + * endpoint. + */ + addCustomLabelsToSelfHostedRunnerForRepo: { + ( + params?: RestEndpointMethodTypes["actions"]["addCustomLabelsToSelfHostedRunnerForRepo"]["parameters"] + ): Promise< + RestEndpointMethodTypes["actions"]["addCustomLabelsToSelfHostedRunnerForRepo"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ @@ -73,7 +102,7 @@ export type RestEndpointMethods = { * * #### Example encrypting a secret using Python * - * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3. + * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. * * ``` * from base64 import b64encode @@ -159,7 +188,7 @@ export type RestEndpointMethods = { * * #### Example encrypting a secret using Python * - * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3. + * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. * * ``` * from base64 import b64encode @@ -245,7 +274,7 @@ export type RestEndpointMethods = { * * #### Example encrypting a secret using Python * - * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3. + * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. * * ``` * from base64 import b64encode @@ -391,7 +420,7 @@ export type RestEndpointMethods = { * * You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)." + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)." */ createWorkflowDispatch: { ( @@ -622,7 +651,63 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" + * Gets GitHub Actions cache usage for a repository. + * The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. + * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + */ + getActionsCacheUsage: { + ( + params?: RestEndpointMethodTypes["actions"]["getActionsCacheUsage"]["parameters"] + ): Promise< + RestEndpointMethodTypes["actions"]["getActionsCacheUsage"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Lists repositories and their GitHub Actions cache usage for an organization. + * The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. + * You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint. + */ + getActionsCacheUsageByRepoForOrg: { + ( + params?: RestEndpointMethodTypes["actions"]["getActionsCacheUsageByRepoForOrg"]["parameters"] + ): Promise< + RestEndpointMethodTypes["actions"]["getActionsCacheUsageByRepoForOrg"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Gets the total GitHub Actions cache usage for an enterprise. + * The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + getActionsCacheUsageForEnterprise: { + ( + params?: RestEndpointMethodTypes["actions"]["getActionsCacheUsageForEnterprise"]["parameters"] + ): Promise< + RestEndpointMethodTypes["actions"]["getActionsCacheUsageForEnterprise"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Gets the total GitHub Actions cache usage for an organization. + * The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. + * You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint. + */ + getActionsCacheUsageForOrg: { + ( + params?: RestEndpointMethodTypes["actions"]["getActionsCacheUsageForOrg"]["parameters"] + ): Promise< + RestEndpointMethodTypes["actions"]["getActionsCacheUsageForOrg"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ @@ -636,7 +721,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." + * Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ @@ -684,7 +769,56 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization. + * Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, + * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see + * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + * GitHub Apps must have the `enterprise_administration:write` permission to use this endpoint. + */ + getGithubActionsDefaultWorkflowPermissionsEnterprise: { + ( + params?: RestEndpointMethodTypes["actions"]["getGithubActionsDefaultWorkflowPermissionsEnterprise"]["parameters"] + ): Promise< + RestEndpointMethodTypes["actions"]["getGithubActionsDefaultWorkflowPermissionsEnterprise"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, + * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see + * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + */ + getGithubActionsDefaultWorkflowPermissionsOrganization: { + ( + params?: RestEndpointMethodTypes["actions"]["getGithubActionsDefaultWorkflowPermissionsOrganization"]["parameters"] + ): Promise< + RestEndpointMethodTypes["actions"]["getGithubActionsDefaultWorkflowPermissionsOrganization"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, + * as well as if GitHub Actions can submit approving pull request reviews. + * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API. + */ + getGithubActionsDefaultWorkflowPermissionsRepository: { + ( + params?: RestEndpointMethodTypes["actions"]["getGithubActionsDefaultWorkflowPermissionsRepository"]["parameters"] + ): Promise< + RestEndpointMethodTypes["actions"]["getGithubActionsDefaultWorkflowPermissionsRepository"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ @@ -698,10 +832,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. + * Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository. * - * You must authenticate using an access token with the `repo` scope to use this - * endpoint. GitHub Apps must have the `administration` repository permission to use this API. + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ getGithubActionsPermissionsRepository: { ( @@ -763,10 +896,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. + * Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository. * - * You must authenticate using an access token with the `repo` scope to use this - * endpoint. GitHub Apps must have the `administration` repository permission to use this API. + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. * @deprecated octokit.rest.actions.getRepoPermissions() has been renamed to octokit.rest.actions.getGithubActionsPermissionsRepository() (2020-11-10) */ getRepoPermissions: { @@ -853,6 +985,22 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. + * This endpoint only applies to internal repositories. For more information, see "[Managing GitHub Actions settings for a repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the + * repository `administration` permission to use this endpoint. + */ + getWorkflowAccessToRepository: { + ( + params?: RestEndpointMethodTypes["actions"]["getWorkflowAccessToRepository"]["parameters"] + ): Promise< + RestEndpointMethodTypes["actions"]["getWorkflowAccessToRepository"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ @@ -881,7 +1029,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ @@ -895,7 +1043,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ @@ -956,6 +1104,35 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Lists all labels for a self-hosted runner configured in an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + listLabelsForSelfHostedRunnerForOrg: { + ( + params?: RestEndpointMethodTypes["actions"]["listLabelsForSelfHostedRunnerForOrg"]["parameters"] + ): Promise< + RestEndpointMethodTypes["actions"]["listLabelsForSelfHostedRunnerForOrg"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Lists all labels for a self-hosted runner configured in a repository. + * + * You must authenticate using an access token with the `repo` scope to use this + * endpoint. + */ + listLabelsForSelfHostedRunnerForRepo: { + ( + params?: RestEndpointMethodTypes["actions"]["listLabelsForSelfHostedRunnerForRepo"]["parameters"] + ): Promise< + RestEndpointMethodTypes["actions"]["listLabelsForSelfHostedRunnerForRepo"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ @@ -1112,6 +1289,110 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Re-run a job and its dependent jobs in a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + reRunJobForWorkflowRun: { + ( + params?: RestEndpointMethodTypes["actions"]["reRunJobForWorkflowRun"]["parameters"] + ): Promise< + RestEndpointMethodTypes["actions"]["reRunJobForWorkflowRun"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + reRunWorkflow: { + ( + params?: RestEndpointMethodTypes["actions"]["reRunWorkflow"]["parameters"] + ): Promise< + RestEndpointMethodTypes["actions"]["reRunWorkflow"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. + */ + reRunWorkflowFailedJobs: { + ( + params?: RestEndpointMethodTypes["actions"]["reRunWorkflowFailedJobs"]["parameters"] + ): Promise< + RestEndpointMethodTypes["actions"]["reRunWorkflowFailedJobs"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Remove all custom labels from a self-hosted runner configured in an + * organization. Returns the remaining read-only labels from the runner. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + removeAllCustomLabelsFromSelfHostedRunnerForOrg: { + ( + params?: RestEndpointMethodTypes["actions"]["removeAllCustomLabelsFromSelfHostedRunnerForOrg"]["parameters"] + ): Promise< + RestEndpointMethodTypes["actions"]["removeAllCustomLabelsFromSelfHostedRunnerForOrg"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Remove all custom labels from a self-hosted runner configured in a + * repository. Returns the remaining read-only labels from the runner. + * + * You must authenticate using an access token with the `repo` scope to use this + * endpoint. + */ + removeAllCustomLabelsFromSelfHostedRunnerForRepo: { + ( + params?: RestEndpointMethodTypes["actions"]["removeAllCustomLabelsFromSelfHostedRunnerForRepo"]["parameters"] + ): Promise< + RestEndpointMethodTypes["actions"]["removeAllCustomLabelsFromSelfHostedRunnerForRepo"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Remove a custom label from a self-hosted runner configured + * in an organization. Returns the remaining labels from the runner. + * + * This endpoint returns a `404 Not Found` status if the custom label is not + * present on the runner. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + removeCustomLabelFromSelfHostedRunnerForOrg: { + ( + params?: RestEndpointMethodTypes["actions"]["removeCustomLabelFromSelfHostedRunnerForOrg"]["parameters"] + ): Promise< + RestEndpointMethodTypes["actions"]["removeCustomLabelFromSelfHostedRunnerForOrg"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Remove a custom label from a self-hosted runner configured + * in a repository. Returns the remaining labels from the runner. + * + * This endpoint returns a `404 Not Found` status if the custom label is not + * present on the runner. + * + * You must authenticate using an access token with the `repo` scope to use this + * endpoint. + */ + removeCustomLabelFromSelfHostedRunnerForRepo: { + ( + params?: RestEndpointMethodTypes["actions"]["removeCustomLabelFromSelfHostedRunnerForRepo"]["parameters"] + ): Promise< + RestEndpointMethodTypes["actions"]["removeCustomLabelFromSelfHostedRunnerForRepo"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */ @@ -1139,9 +1420,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." + * Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * If the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings. + * If the organization belongs to an enterprise that has `selected` actions and reusable workflows set at the enterprise level, then you cannot override any of the enterprise's allowed actions and reusable workflows settings. * * To use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the organization. * @@ -1157,9 +1438,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." + * Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * - * If the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings. + * If the repository belongs to an organization or enterprise that has `selected` actions and reusable workflows set at the organization or enterprise levels, then you cannot override any of the allowed actions and reusable workflows settings. * * To use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories. * @@ -1175,9 +1456,89 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization. + * Remove all previous custom labels and set the new custom labels for a specific + * self-hosted runner configured in an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + setCustomLabelsForSelfHostedRunnerForOrg: { + ( + params?: RestEndpointMethodTypes["actions"]["setCustomLabelsForSelfHostedRunnerForOrg"]["parameters"] + ): Promise< + RestEndpointMethodTypes["actions"]["setCustomLabelsForSelfHostedRunnerForOrg"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Remove all previous custom labels and set the new custom labels for a specific + * self-hosted runner configured in a repository. + * + * You must authenticate using an access token with the `repo` scope to use this + * endpoint. + */ + setCustomLabelsForSelfHostedRunnerForRepo: { + ( + params?: RestEndpointMethodTypes["actions"]["setCustomLabelsForSelfHostedRunnerForRepo"]["parameters"] + ): Promise< + RestEndpointMethodTypes["actions"]["setCustomLabelsForSelfHostedRunnerForRepo"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, and sets + * whether GitHub Actions can submit approving pull request reviews. For more information, see + * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + * GitHub Apps must have the `enterprise_administration:write` permission to use this endpoint. + */ + setGithubActionsDefaultWorkflowPermissionsEnterprise: { + ( + params?: RestEndpointMethodTypes["actions"]["setGithubActionsDefaultWorkflowPermissionsEnterprise"]["parameters"] + ): Promise< + RestEndpointMethodTypes["actions"]["setGithubActionsDefaultWorkflowPermissionsEnterprise"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions + * can submit approving pull request reviews. For more information, see + * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + */ + setGithubActionsDefaultWorkflowPermissionsOrganization: { + ( + params?: RestEndpointMethodTypes["actions"]["setGithubActionsDefaultWorkflowPermissionsOrganization"]["parameters"] + ): Promise< + RestEndpointMethodTypes["actions"]["setGithubActionsDefaultWorkflowPermissionsOrganization"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions + * can submit approving pull request reviews. + * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API. + */ + setGithubActionsDefaultWorkflowPermissionsRepository: { + ( + params?: RestEndpointMethodTypes["actions"]["setGithubActionsDefaultWorkflowPermissionsRepository"]["parameters"] + ): Promise< + RestEndpointMethodTypes["actions"]["setGithubActionsDefaultWorkflowPermissionsRepository"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. * - * If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization. + * If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions and reusable workflows, then you cannot override them for the organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ @@ -1191,9 +1552,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. + * Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository. * - * If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository. + * If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions and reusable workflows, then you cannot override them for the repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. */ @@ -1232,6 +1593,22 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. + * This endpoint only applies to internal repositories. For more information, see "[Managing GitHub Actions settings for a repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the + * repository `administration` permission to use this endpoint. + */ + setWorkflowAccessToRepository: { + ( + params?: RestEndpointMethodTypes["actions"]["setWorkflowAccessToRepository"]["parameters"] + ): Promise< + RestEndpointMethodTypes["actions"]["setWorkflowAccessToRepository"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; }; activity: { checkRepoIsStarredByAuthenticatedUser: { @@ -1645,53 +2022,21 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * **Deprecated:** use `apps.createContentAttachmentForRepo()` (`POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments`) instead. Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment. - * - * The app must create a content attachment within six hours of the content reference URL being posted. See "[Using content attachments](https://docs.github.com/apps/using-content-attachments/)" for details about content attachments. - * - * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + * Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. */ - createContentAttachment: { + createFromManifest: { ( - params?: RestEndpointMethodTypes["apps"]["createContentAttachment"]["parameters"] + params?: RestEndpointMethodTypes["apps"]["createFromManifest"]["parameters"] ): Promise< - RestEndpointMethodTypes["apps"]["createContentAttachment"]["response"] + RestEndpointMethodTypes["apps"]["createFromManifest"]["response"] >; defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; /** - * Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment. - * - * The app must create a content attachment within six hours of the content reference URL being posted. See "[Using content attachments](https://docs.github.com/apps/using-content-attachments/)" for details about content attachments. + * Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key. * - * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. - */ - createContentAttachmentForRepo: { - ( - params?: RestEndpointMethodTypes["apps"]["createContentAttachmentForRepo"]["parameters"] - ): Promise< - RestEndpointMethodTypes["apps"]["createContentAttachmentForRepo"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. - */ - createFromManifest: { - ( - params?: RestEndpointMethodTypes["apps"]["createFromManifest"]["parameters"] - ): Promise< - RestEndpointMethodTypes["apps"]["createFromManifest"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key. - * - * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ createInstallationAccessToken: { ( @@ -1756,7 +2101,7 @@ export type RestEndpointMethods = { /** * **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). * - * If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + * If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ getBySlug: { ( @@ -1766,7 +2111,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Enables an authenticated GitHub App to find an installation's information using the installation id. The installation's account type (`target_type`) will be either an organization or a user account, depending which account the repository belongs to. + * Enables an authenticated GitHub App to find an installation's information using the installation id. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ @@ -2159,7 +2504,7 @@ export type RestEndpointMethods = { /** * Gets the summary of the free and paid GitHub Actions minutes used. * - * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * Access tokens must have the `repo` or `admin:org` scope. */ @@ -2175,7 +2520,7 @@ export type RestEndpointMethods = { /** * Gets the summary of the free and paid GitHub Actions minutes used. * - * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * Access tokens must have the `user` scope. */ @@ -2188,10 +2533,37 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Gets the GitHub Advanced Security active committers for an enterprise per repository. + * Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository. + */ + getGithubAdvancedSecurityBillingGhe: { + ( + params?: RestEndpointMethodTypes["billing"]["getGithubAdvancedSecurityBillingGhe"]["parameters"] + ): Promise< + RestEndpointMethodTypes["billing"]["getGithubAdvancedSecurityBillingGhe"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Gets the GitHub Advanced Security active committers for an organization per repository. + * Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of advanced_security_committers for each repository. + * If this organization defers to an enterprise for billing, the total_advanced_security_committers returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level. + */ + getGithubAdvancedSecurityBillingOrg: { + ( + params?: RestEndpointMethodTypes["billing"]["getGithubAdvancedSecurityBillingOrg"]["parameters"] + ): Promise< + RestEndpointMethodTypes["billing"]["getGithubAdvancedSecurityBillingOrg"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * * Access tokens must have the `repo` or `admin:org` scope. */ @@ -2207,7 +2579,7 @@ export type RestEndpointMethods = { /** * Gets the free and paid storage used for GitHub Packages in gigabytes. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * * Access tokens must have the `user` scope. */ @@ -2221,9 +2593,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. + * Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * * Access tokens must have the `repo` or `admin:org` scope. */ @@ -2237,9 +2609,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. + * Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * * Access tokens must have the `user` scope. */ @@ -2409,7 +2781,7 @@ export type RestEndpointMethods = { /** * Deletes a specified code scanning analysis from a repository. For * private repositories, you must use an access token with the `repo` scope. For public repositories, - * you must use an access token with `public_repo` and `repo:security_events` scopes. + * you must use an access token with `public_repo` scope. * GitHub Apps must have the `security_events` write permission to use this endpoint. * * You can delete one analysis at a time. @@ -2441,13 +2813,13 @@ export type RestEndpointMethods = { * ``` * * The response from a successful `DELETE` operation provides you with - * two alternative URLs for deleting the next analysis in the set - * (see the example default response below). + * two alternative URLs for deleting the next analysis in the set: + * `next_analysis_url` and `confirm_delete_url`. * Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis - * in the set. This is a useful option if you want to preserve at least one analysis + * in a set. This is a useful option if you want to preserve at least one analysis * for the specified tool in your repository. * Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool. - * When you delete the last analysis in a set the value of `next_analysis_url` and `confirm_delete_url` + * When you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url` * in the 200 response is `null`. * * As an example of the deletion process, @@ -2457,9 +2829,11 @@ export type RestEndpointMethods = { * You therefore have two separate sets of analyses for this tool. * You've now decided that you want to remove all of the analyses for the tool. * To do this you must make 15 separate deletion requests. - * To start, you must find the deletable analysis for one of the sets, - * step through deleting the analyses in that set, - * and then repeat the process for the second set. + * To start, you must find an analysis that's identified as deletable. + * Each set of analyses always has one that's identified as deletable. + * Having found the deletable analysis for one of the two sets, + * delete this analysis and then continue deleting the next analysis in the set until they're all deleted. + * Then repeat the process for the second set. * The procedure therefore consists of a nested loop: * * **Outer loop**: @@ -2482,7 +2856,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint. + * Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. * * **Deprecation notice**: * The instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by `instances_url`. @@ -2498,7 +2872,8 @@ export type RestEndpointMethods = { }; /** * Gets a specified code scanning analysis for a repository. - * You must use an access token with the `security_events` scope to use this endpoint. + * You must use an access token with the `security_events` scope to use this endpoint with private repos, + * the `public_repo` scope also grants permission to read security events on public repos only. * GitHub Apps must have the `security_events` read permission to use this endpoint. * * The default JSON response contains fields that describe the analysis. @@ -2516,156 +2891,1106 @@ export type RestEndpointMethods = { * This is formatted as * [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). */ - getAnalysis: { + getAnalysis: { + ( + params?: RestEndpointMethodTypes["codeScanning"]["getAnalysis"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codeScanning"]["getAnalysis"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. + */ + getSarif: { + ( + params?: RestEndpointMethodTypes["codeScanning"]["getSarif"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codeScanning"]["getSarif"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Lists all instances of the specified code scanning alert. + * You must use an access token with the `security_events` scope to use this endpoint with private repos, + * the `public_repo` scope also grants permission to read security events on public repos only. + * GitHub Apps must have the `security_events` read permission to use this endpoint. + */ + listAlertInstances: { + ( + params?: RestEndpointMethodTypes["codeScanning"]["listAlertInstances"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codeScanning"]["listAlertInstances"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Lists all code scanning alerts for the default branch (usually `main` + * or `master`) for all eligible repositories in an organization. + * To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. + * + * GitHub Apps must have the `security_events` read permission to use this endpoint. + */ + listAlertsForOrg: { + ( + params?: RestEndpointMethodTypes["codeScanning"]["listAlertsForOrg"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codeScanning"]["listAlertsForOrg"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Lists all open code scanning alerts for the default branch (usually `main` + * or `master`). You must use an access token with the `security_events` scope to use + * this endpoint with private repos, the `public_repo` scope also grants permission to read + * security events on public repos only. GitHub Apps must have the `security_events` read + * permission to use this endpoint. + * + * The response includes a `most_recent_instance` object. + * This provides details of the most recent instance of this alert + * for the default branch or for the specified Git reference + * (if you used `ref` in the request). + */ + listAlertsForRepo: { + ( + params?: RestEndpointMethodTypes["codeScanning"]["listAlertsForRepo"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codeScanning"]["listAlertsForRepo"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Lists all instances of the specified code scanning alert. + * You must use an access token with the `security_events` scope to use this endpoint with private repos, + * the `public_repo` scope also grants permission to read security events on public repos only. + * GitHub Apps must have the `security_events` read permission to use this endpoint. + * @deprecated octokit.rest.codeScanning.listAlertsInstances() has been renamed to octokit.rest.codeScanning.listAlertInstances() (2021-04-30) + */ + listAlertsInstances: { + ( + params?: RestEndpointMethodTypes["codeScanning"]["listAlertsInstances"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codeScanning"]["listAlertsInstances"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Lists the details of all code scanning analyses for a repository, + * starting with the most recent. + * The response is paginated and you can use the `page` and `per_page` parameters + * to list the analyses you're interested in. + * By default 30 analyses are listed per page. + * + * The `rules_count` field in the response give the number of rules + * that were run in the analysis. + * For very old analyses this data is not available, + * and `0` is returned in this field. + * + * You must use an access token with the `security_events` scope to use this endpoint with private repos, + * the `public_repo` scope also grants permission to read security events on public repos only. + * GitHub Apps must have the `security_events` read permission to use this endpoint. + * + * **Deprecation notice**: + * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + */ + listRecentAnalyses: { + ( + params?: RestEndpointMethodTypes["codeScanning"]["listRecentAnalyses"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codeScanning"]["listRecentAnalyses"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. + */ + updateAlert: { + ( + params?: RestEndpointMethodTypes["codeScanning"]["updateAlert"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codeScanning"]["updateAlert"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. + * + * There are two places where you can upload code scanning results. + * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." + * - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see "[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." + * + * You must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example: + * + * ``` + * gzip -c analysis-data.sarif | base64 -w0 + * ``` + * + * SARIF upload supports a maximum of 5000 results per analysis run. Any results over this limit are ignored and any SARIF uploads with more than 25,000 results are rejected. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries. + * + * The `202 Accepted`, response includes an `id` value. + * You can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint. + * For more information, see "[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload)." + */ + uploadSarif: { + ( + params?: RestEndpointMethodTypes["codeScanning"]["uploadSarif"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codeScanning"]["uploadSarif"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + }; + codesOfConduct: { + getAllCodesOfConduct: { + ( + params?: RestEndpointMethodTypes["codesOfConduct"]["getAllCodesOfConduct"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codesOfConduct"]["getAllCodesOfConduct"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + + getConductCode: { + ( + params?: RestEndpointMethodTypes["codesOfConduct"]["getConductCode"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codesOfConduct"]["getConductCode"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + }; + codespaces: { + /** + * Adds a repository to the selected repositories for a user's codespace secret. + * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on the referenced repository to use this endpoint. + */ + addRepositoryForSecretForAuthenticatedUser: { + ( + params?: RestEndpointMethodTypes["codespaces"]["addRepositoryForSecretForAuthenticatedUser"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codespaces"]["addRepositoryForSecretForAuthenticatedUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * List the machine types a codespace can transition to use. + * + * You must authenticate using an access token with the `codespace` scope to use this endpoint. + * + * GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint. + */ + codespaceMachinesForAuthenticatedUser: { + ( + params?: RestEndpointMethodTypes["codespaces"]["codespaceMachinesForAuthenticatedUser"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codespaces"]["codespaceMachinesForAuthenticatedUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Creates a new codespace, owned by the authenticated user. + * + * This endpoint requires either a `repository_id` OR a `pull_request` but not both. + * + * You must authenticate using an access token with the `codespace` scope to use this endpoint. + * + * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + */ + createForAuthenticatedUser: { + ( + params?: RestEndpointMethodTypes["codespaces"]["createForAuthenticatedUser"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codespaces"]["createForAuthenticatedUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Creates or updates a repository secret with an encrypted value. Encrypt your secret using + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access + * token with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets` repository + * permission to use this endpoint. + * + * #### Example of encrypting a secret using Node.js + * + * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. + * + * ``` + * const sodium = require('tweetsodium'); + * + * const key = "base64-encoded-public-key"; + * const value = "plain-text-secret"; + * + * // Convert the message and key to Uint8Array's (Buffer implements that interface) + * const messageBytes = Buffer.from(value); + * const keyBytes = Buffer.from(key, 'base64'); + * + * // Encrypt using LibSodium. + * const encryptedBytes = sodium.seal(messageBytes, keyBytes); + * + * // Base64 the encrypted secret + * const encrypted = Buffer.from(encryptedBytes).toString('base64'); + * + * console.log(encrypted); + * ``` + * + * + * #### Example of encrypting a secret using Python + * + * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. + * + * ``` + * from base64 import b64encode + * from nacl import encoding, public + * + * def encrypt(public_key: str, secret_value: str) -> str: + * """Encrypt a Unicode string using the public key.""" + * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) + * sealed_box = public.SealedBox(public_key) + * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) + * return b64encode(encrypted).decode("utf-8") + * ``` + * + * #### Example of encrypting a secret using C# + * + * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + * + * ``` + * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); + * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); + * + * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); + * + * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); + * ``` + * + * #### Example of encrypting a secret using Ruby + * + * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + * + * ```ruby + * require "rbnacl" + * require "base64" + * + * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") + * public_key = RbNaCl::PublicKey.new(key) + * + * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) + * encrypted_secret = box.encrypt("my_secret") + * + * # Print the base64 encoded secret + * puts Base64.strict_encode64(encrypted_secret) + * ``` + */ + createOrUpdateRepoSecret: { + ( + params?: RestEndpointMethodTypes["codespaces"]["createOrUpdateRepoSecret"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codespaces"]["createOrUpdateRepoSecret"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). + * + * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint. + * + * GitHub Apps must have read access to the `codespaces_user_secrets` user permission and `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + * + * #### Example encrypting a secret using Node.js + * + * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. + * + * ``` + * const sodium = require('tweetsodium'); + * + * const key = "base64-encoded-public-key"; + * const value = "plain-text-secret"; + * + * // Convert the message and key to Uint8Array's (Buffer implements that interface) + * const messageBytes = Buffer.from(value); + * const keyBytes = Buffer.from(key, 'base64'); + * + * // Encrypt using LibSodium. + * const encryptedBytes = sodium.seal(messageBytes, keyBytes); + * + * // Base64 the encrypted secret + * const encrypted = Buffer.from(encryptedBytes).toString('base64'); + * + * console.log(encrypted); + * ``` + * + * + * #### Example encrypting a secret using Python + * + * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. + * + * ``` + * from base64 import b64encode + * from nacl import encoding, public + * + * def encrypt(public_key: str, secret_value: str) -> str: + * """Encrypt a Unicode string using the public key.""" + * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) + * sealed_box = public.SealedBox(public_key) + * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) + * return b64encode(encrypted).decode("utf-8") + * ``` + * + * #### Example encrypting a secret using C# + * + * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + * + * ``` + * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); + * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); + * + * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); + * + * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); + * ``` + * + * #### Example encrypting a secret using Ruby + * + * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + * + * ```ruby + * require "rbnacl" + * require "base64" + * + * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") + * public_key = RbNaCl::PublicKey.new(key) + * + * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) + * encrypted_secret = box.encrypt("my_secret") + * + * # Print the base64 encoded secret + * puts Base64.strict_encode64(encrypted_secret) + * ``` + */ + createOrUpdateSecretForAuthenticatedUser: { + ( + params?: RestEndpointMethodTypes["codespaces"]["createOrUpdateSecretForAuthenticatedUser"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codespaces"]["createOrUpdateSecretForAuthenticatedUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Creates a codespace owned by the authenticated user for the specified pull request. + * + * You must authenticate using an access token with the `codespace` scope to use this endpoint. + * + * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + */ + createWithPrForAuthenticatedUser: { + ( + params?: RestEndpointMethodTypes["codespaces"]["createWithPrForAuthenticatedUser"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codespaces"]["createWithPrForAuthenticatedUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Creates a codespace owned by the authenticated user in the specified repository. + * + * You must authenticate using an access token with the `codespace` scope to use this endpoint. + * + * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + */ + createWithRepoForAuthenticatedUser: { + ( + params?: RestEndpointMethodTypes["codespaces"]["createWithRepoForAuthenticatedUser"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codespaces"]["createWithRepoForAuthenticatedUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Deletes a user's codespace. + * + * You must authenticate using an access token with the `codespace` scope to use this endpoint. + * + * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + */ + deleteForAuthenticatedUser: { + ( + params?: RestEndpointMethodTypes["codespaces"]["deleteForAuthenticatedUser"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codespaces"]["deleteForAuthenticatedUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint. + */ + deleteRepoSecret: { + ( + params?: RestEndpointMethodTypes["codespaces"]["deleteRepoSecret"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codespaces"]["deleteRepoSecret"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Deletes a secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. + * + * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * + * GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. + */ + deleteSecretForAuthenticatedUser: { + ( + params?: RestEndpointMethodTypes["codespaces"]["deleteSecretForAuthenticatedUser"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codespaces"]["deleteSecretForAuthenticatedUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored. + * + * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. + * + * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + */ + exportForAuthenticatedUser: { + ( + params?: RestEndpointMethodTypes["codespaces"]["exportForAuthenticatedUser"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codespaces"]["exportForAuthenticatedUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Gets information about an export of a codespace. + * + * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. + * + * GitHub Apps must have read access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + */ + getExportDetailsForAuthenticatedUser: { + ( + params?: RestEndpointMethodTypes["codespaces"]["getExportDetailsForAuthenticatedUser"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codespaces"]["getExportDetailsForAuthenticatedUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Gets information about a user's codespace. + * + * You must authenticate using an access token with the `codespace` scope to use this endpoint. + * + * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. + */ + getForAuthenticatedUser: { + ( + params?: RestEndpointMethodTypes["codespaces"]["getForAuthenticatedUser"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codespaces"]["getForAuthenticatedUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. + * + * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * + * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + */ + getPublicKeyForAuthenticatedUser: { + ( + params?: RestEndpointMethodTypes["codespaces"]["getPublicKeyForAuthenticatedUser"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codespaces"]["getPublicKeyForAuthenticatedUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint. + */ + getRepoPublicKey: { + ( + params?: RestEndpointMethodTypes["codespaces"]["getRepoPublicKey"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codespaces"]["getRepoPublicKey"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint. + */ + getRepoSecret: { + ( + params?: RestEndpointMethodTypes["codespaces"]["getRepoSecret"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codespaces"]["getRepoSecret"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Gets a secret available to a user's codespaces without revealing its encrypted value. + * + * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * + * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + */ + getSecretForAuthenticatedUser: { + ( + params?: RestEndpointMethodTypes["codespaces"]["getSecretForAuthenticatedUser"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codespaces"]["getSecretForAuthenticatedUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files + * specify launchpoint configurations for codespaces created within the repository. + * + * You must authenticate using an access token with the `codespace` scope to use this endpoint. + * + * GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint. + */ + listDevcontainersInRepositoryForAuthenticatedUser: { + ( + params?: RestEndpointMethodTypes["codespaces"]["listDevcontainersInRepositoryForAuthenticatedUser"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codespaces"]["listDevcontainersInRepositoryForAuthenticatedUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Lists the authenticated user's codespaces. + * + * You must authenticate using an access token with the `codespace` scope to use this endpoint. + * + * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. + */ + listForAuthenticatedUser: { + ( + params?: RestEndpointMethodTypes["codespaces"]["listForAuthenticatedUser"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codespaces"]["listForAuthenticatedUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Lists the codespaces associated to a specified repository and the authenticated user. + * + * You must authenticate using an access token with the `codespace` scope to use this endpoint. + * + * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. + */ + listInRepositoryForAuthenticatedUser: { + ( + params?: RestEndpointMethodTypes["codespaces"]["listInRepositoryForAuthenticatedUser"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codespaces"]["listInRepositoryForAuthenticatedUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint. + */ + listRepoSecrets: { + ( + params?: RestEndpointMethodTypes["codespaces"]["listRepoSecrets"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codespaces"]["listRepoSecrets"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * List the repositories that have been granted the ability to use a user's codespace secret. + * + * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * + * GitHub Apps must have read access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + */ + listRepositoriesForSecretForAuthenticatedUser: { + ( + params?: RestEndpointMethodTypes["codespaces"]["listRepositoriesForSecretForAuthenticatedUser"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codespaces"]["listRepositoriesForSecretForAuthenticatedUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Lists all secrets available for a user's Codespaces without revealing their + * encrypted values. + * + * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * + * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + */ + listSecretsForAuthenticatedUser: { + ( + params?: RestEndpointMethodTypes["codespaces"]["listSecretsForAuthenticatedUser"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codespaces"]["listSecretsForAuthenticatedUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Removes a repository from the selected repositories for a user's codespace secret. + * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. + */ + removeRepositoryForSecretForAuthenticatedUser: { + ( + params?: RestEndpointMethodTypes["codespaces"]["removeRepositoryForSecretForAuthenticatedUser"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codespaces"]["removeRepositoryForSecretForAuthenticatedUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * List the machine types available for a given repository based on its configuration. + * + * You must authenticate using an access token with the `codespace` scope to use this endpoint. + * + * GitHub Apps must have write access to the `codespaces_metadata` repository permission to use this endpoint. + */ + repoMachinesForAuthenticatedUser: { + ( + params?: RestEndpointMethodTypes["codespaces"]["repoMachinesForAuthenticatedUser"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codespaces"]["repoMachinesForAuthenticatedUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Select the repositories that will use a user's codespace secret. + * + * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * + * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + */ + setRepositoriesForSecretForAuthenticatedUser: { + ( + params?: RestEndpointMethodTypes["codespaces"]["setRepositoriesForSecretForAuthenticatedUser"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codespaces"]["setRepositoriesForSecretForAuthenticatedUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Starts a user's codespace. + * + * You must authenticate using an access token with the `codespace` scope to use this endpoint. + * + * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + */ + startForAuthenticatedUser: { + ( + params?: RestEndpointMethodTypes["codespaces"]["startForAuthenticatedUser"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codespaces"]["startForAuthenticatedUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Stops a user's codespace. + * + * You must authenticate using an access token with the `codespace` scope to use this endpoint. + * + * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + */ + stopForAuthenticatedUser: { + ( + params?: RestEndpointMethodTypes["codespaces"]["stopForAuthenticatedUser"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codespaces"]["stopForAuthenticatedUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint. + * + * If you specify a new machine type it will be applied the next time your codespace is started. + * + * You must authenticate using an access token with the `codespace` scope to use this endpoint. + * + * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + */ + updateForAuthenticatedUser: { + ( + params?: RestEndpointMethodTypes["codespaces"]["updateForAuthenticatedUser"]["parameters"] + ): Promise< + RestEndpointMethodTypes["codespaces"]["updateForAuthenticatedUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + }; + dependabot: { + /** + * Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + */ + addSelectedRepoToOrgSecret: { + ( + params?: RestEndpointMethodTypes["dependabot"]["addSelectedRepoToOrgSecret"]["parameters"] + ): Promise< + RestEndpointMethodTypes["dependabot"]["addSelectedRepoToOrgSecret"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Creates or updates an organization secret with an encrypted value. Encrypt your secret using + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access + * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization + * permission to use this endpoint. + * + * #### Example encrypting a secret using Node.js + * + * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. + * + * ``` + * const sodium = require('tweetsodium'); + * + * const key = "base64-encoded-public-key"; + * const value = "plain-text-secret"; + * + * // Convert the message and key to Uint8Array's (Buffer implements that interface) + * const messageBytes = Buffer.from(value); + * const keyBytes = Buffer.from(key, 'base64'); + * + * // Encrypt using LibSodium. + * const encryptedBytes = sodium.seal(messageBytes, keyBytes); + * + * // Base64 the encrypted secret + * const encrypted = Buffer.from(encryptedBytes).toString('base64'); + * + * console.log(encrypted); + * ``` + * + * + * #### Example encrypting a secret using Python + * + * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. + * + * ``` + * from base64 import b64encode + * from nacl import encoding, public + * + * def encrypt(public_key: str, secret_value: str) -> str: + * """Encrypt a Unicode string using the public key.""" + * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) + * sealed_box = public.SealedBox(public_key) + * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) + * return b64encode(encrypted).decode("utf-8") + * ``` + * + * #### Example encrypting a secret using C# + * + * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + * + * ``` + * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); + * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); + * + * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); + * + * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); + * ``` + * + * #### Example encrypting a secret using Ruby + * + * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + * + * ```ruby + * require "rbnacl" + * require "base64" + * + * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") + * public_key = RbNaCl::PublicKey.new(key) + * + * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) + * encrypted_secret = box.encrypt("my_secret") + * + * # Print the base64 encoded secret + * puts Base64.strict_encode64(encrypted_secret) + * ``` + */ + createOrUpdateOrgSecret: { + ( + params?: RestEndpointMethodTypes["dependabot"]["createOrUpdateOrgSecret"]["parameters"] + ): Promise< + RestEndpointMethodTypes["dependabot"]["createOrUpdateOrgSecret"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Creates or updates a repository secret with an encrypted value. Encrypt your secret using + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access + * token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository + * permission to use this endpoint. + * + * #### Example encrypting a secret using Node.js + * + * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. + * + * ``` + * const sodium = require('tweetsodium'); + * + * const key = "base64-encoded-public-key"; + * const value = "plain-text-secret"; + * + * // Convert the message and key to Uint8Array's (Buffer implements that interface) + * const messageBytes = Buffer.from(value); + * const keyBytes = Buffer.from(key, 'base64'); + * + * // Encrypt using LibSodium. + * const encryptedBytes = sodium.seal(messageBytes, keyBytes); + * + * // Base64 the encrypted secret + * const encrypted = Buffer.from(encryptedBytes).toString('base64'); + * + * console.log(encrypted); + * ``` + * + * + * #### Example encrypting a secret using Python + * + * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. + * + * ``` + * from base64 import b64encode + * from nacl import encoding, public + * + * def encrypt(public_key: str, secret_value: str) -> str: + * """Encrypt a Unicode string using the public key.""" + * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) + * sealed_box = public.SealedBox(public_key) + * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) + * return b64encode(encrypted).decode("utf-8") + * ``` + * + * #### Example encrypting a secret using C# + * + * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + * + * ``` + * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); + * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); + * + * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); + * + * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); + * ``` + * + * #### Example encrypting a secret using Ruby + * + * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + * + * ```ruby + * require "rbnacl" + * require "base64" + * + * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") + * public_key = RbNaCl::PublicKey.new(key) + * + * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) + * encrypted_secret = box.encrypt("my_secret") + * + * # Print the base64 encoded secret + * puts Base64.strict_encode64(encrypted_secret) + * ``` + */ + createOrUpdateRepoSecret: { + ( + params?: RestEndpointMethodTypes["dependabot"]["createOrUpdateRepoSecret"]["parameters"] + ): Promise< + RestEndpointMethodTypes["dependabot"]["createOrUpdateRepoSecret"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + */ + deleteOrgSecret: { + ( + params?: RestEndpointMethodTypes["dependabot"]["deleteOrgSecret"]["parameters"] + ): Promise< + RestEndpointMethodTypes["dependabot"]["deleteOrgSecret"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + */ + deleteRepoSecret: { + ( + params?: RestEndpointMethodTypes["dependabot"]["deleteRepoSecret"]["parameters"] + ): Promise< + RestEndpointMethodTypes["dependabot"]["deleteRepoSecret"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + */ + getOrgPublicKey: { ( - params?: RestEndpointMethodTypes["codeScanning"]["getAnalysis"]["parameters"] + params?: RestEndpointMethodTypes["dependabot"]["getOrgPublicKey"]["parameters"] ): Promise< - RestEndpointMethodTypes["codeScanning"]["getAnalysis"]["response"] + RestEndpointMethodTypes["dependabot"]["getOrgPublicKey"]["response"] >; defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint. + * Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - getSarif: { + getOrgSecret: { ( - params?: RestEndpointMethodTypes["codeScanning"]["getSarif"]["parameters"] + params?: RestEndpointMethodTypes["dependabot"]["getOrgSecret"]["parameters"] ): Promise< - RestEndpointMethodTypes["codeScanning"]["getSarif"]["response"] + RestEndpointMethodTypes["dependabot"]["getOrgSecret"]["response"] >; defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists all instances of the specified code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint. + * Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - listAlertInstances: { + getRepoPublicKey: { ( - params?: RestEndpointMethodTypes["codeScanning"]["listAlertInstances"]["parameters"] + params?: RestEndpointMethodTypes["dependabot"]["getRepoPublicKey"]["parameters"] ): Promise< - RestEndpointMethodTypes["codeScanning"]["listAlertInstances"]["response"] + RestEndpointMethodTypes["dependabot"]["getRepoPublicKey"]["response"] >; defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists all open code scanning alerts for the default branch (usually `main` - * or `master`). You must use an access token with the `security_events` scope to use - * this endpoint. GitHub Apps must have the `security_events` read permission to use - * this endpoint. - * - * The response includes a `most_recent_instance` object. - * This provides details of the most recent instance of this alert - * for the default branch or for the specified Git reference - * (if you used `ref` in the request). + * Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - listAlertsForRepo: { + getRepoSecret: { ( - params?: RestEndpointMethodTypes["codeScanning"]["listAlertsForRepo"]["parameters"] + params?: RestEndpointMethodTypes["dependabot"]["getRepoSecret"]["parameters"] ): Promise< - RestEndpointMethodTypes["codeScanning"]["listAlertsForRepo"]["response"] + RestEndpointMethodTypes["dependabot"]["getRepoSecret"]["response"] >; defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists all instances of the specified code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint. - * @deprecated octokit.rest.codeScanning.listAlertsInstances() has been renamed to octokit.rest.codeScanning.listAlertInstances() (2021-04-30) + * Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - listAlertsInstances: { + listOrgSecrets: { ( - params?: RestEndpointMethodTypes["codeScanning"]["listAlertsInstances"]["parameters"] + params?: RestEndpointMethodTypes["dependabot"]["listOrgSecrets"]["parameters"] ): Promise< - RestEndpointMethodTypes["codeScanning"]["listAlertsInstances"]["response"] + RestEndpointMethodTypes["dependabot"]["listOrgSecrets"]["response"] >; defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists the details of all code scanning analyses for a repository, - * starting with the most recent. - * The response is paginated and you can use the `page` and `per_page` parameters - * to list the analyses you're interested in. - * By default 30 analyses are listed per page. - * - * The `rules_count` field in the response give the number of rules - * that were run in the analysis. - * For very old analyses this data is not available, - * and `0` is returned in this field. - * - * You must use an access token with the `security_events` scope to use this endpoint. - * GitHub Apps must have the `security_events` read permission to use this endpoint. - * - * **Deprecation notice**: - * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */ - listRecentAnalyses: { + listRepoSecrets: { ( - params?: RestEndpointMethodTypes["codeScanning"]["listRecentAnalyses"]["parameters"] + params?: RestEndpointMethodTypes["dependabot"]["listRepoSecrets"]["parameters"] ): Promise< - RestEndpointMethodTypes["codeScanning"]["listRecentAnalyses"]["response"] + RestEndpointMethodTypes["dependabot"]["listRepoSecrets"]["response"] >; defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; /** - * Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint. + * Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - updateAlert: { + listSelectedReposForOrgSecret: { ( - params?: RestEndpointMethodTypes["codeScanning"]["updateAlert"]["parameters"] + params?: RestEndpointMethodTypes["dependabot"]["listSelectedReposForOrgSecret"]["parameters"] ): Promise< - RestEndpointMethodTypes["codeScanning"]["updateAlert"]["response"] + RestEndpointMethodTypes["dependabot"]["listSelectedReposForOrgSecret"]["response"] >; defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; /** - * Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint. - * - * There are two places where you can upload code scanning results. - * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." - * - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see "[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." - * - * You must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example: - * - * ``` - * gzip -c analysis-data.sarif | base64 -w0 - * ``` - * - * SARIF upload supports a maximum of 5000 results per analysis run. Any results over this limit are ignored and any SARIF uploads with more than 25,000 results are rejected. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries. - * - * The `202 Accepted`, response includes an `id` value. - * You can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint. - * For more information, see "[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload)." + * Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ - uploadSarif: { + removeSelectedRepoFromOrgSecret: { ( - params?: RestEndpointMethodTypes["codeScanning"]["uploadSarif"]["parameters"] + params?: RestEndpointMethodTypes["dependabot"]["removeSelectedRepoFromOrgSecret"]["parameters"] ): Promise< - RestEndpointMethodTypes["codeScanning"]["uploadSarif"]["response"] + RestEndpointMethodTypes["dependabot"]["removeSelectedRepoFromOrgSecret"]["response"] >; defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - }; - codesOfConduct: { - getAllCodesOfConduct: { + /** + * Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + */ + setSelectedReposForOrgSecret: { ( - params?: RestEndpointMethodTypes["codesOfConduct"]["getAllCodesOfConduct"]["parameters"] + params?: RestEndpointMethodTypes["dependabot"]["setSelectedReposForOrgSecret"]["parameters"] ): Promise< - RestEndpointMethodTypes["codesOfConduct"]["getAllCodesOfConduct"]["response"] + RestEndpointMethodTypes["dependabot"]["setSelectedReposForOrgSecret"]["response"] >; defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - - getConductCode: { + }; + dependencyGraph: { + /** + * Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits. + */ + diffRange: { ( - params?: RestEndpointMethodTypes["codesOfConduct"]["getConductCode"]["parameters"] + params?: RestEndpointMethodTypes["dependencyGraph"]["diffRange"]["parameters"] ): Promise< - RestEndpointMethodTypes["codesOfConduct"]["getConductCode"]["response"] + RestEndpointMethodTypes["dependencyGraph"]["diffRange"]["response"] >; defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; @@ -2684,6 +4009,20 @@ export type RestEndpointMethods = { }; }; enterpriseAdmin: { + /** + * Add custom labels to a self-hosted runner configured in an enterprise. + * + * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + */ + addCustomLabelsToSelfHostedRunnerForEnterprise: { + ( + params?: RestEndpointMethodTypes["enterpriseAdmin"]["addCustomLabelsToSelfHostedRunnerForEnterprise"]["parameters"] + ): Promise< + RestEndpointMethodTypes["enterpriseAdmin"]["addCustomLabelsToSelfHostedRunnerForEnterprise"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * @@ -2713,7 +4052,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * Gets the selected actions and reusable workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ @@ -2727,7 +4066,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. + * Gets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise. * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ @@ -2740,6 +4079,40 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Returns aggregate usage metrics for your GitHub Enterprise Server 3.5+ instance for a specified time period up to 365 days. + * + * To use this endpoint, your GitHub Enterprise Server instance must be connected to GitHub Enterprise Cloud using GitHub Connect. You must enable Server Statistics, and for the API request provide your enterprise account name or organization name connected to the GitHub Enterprise Server. For more information, see "[Enabling Server Statistics for your enterprise](/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise)" in the GitHub Enterprise Server documentation. + * + * You'll need to use a personal access token: + * - If you connected your GitHub Enterprise Server to an enterprise account and enabled Server Statistics, you'll need a personal access token with the `read:enterprise` permission. + * - If you connected your GitHub Enterprise Server to an organization account and enabled Server Statistics, you'll need a personal access token with the `read:org` permission. + * + * For more information on creating a personal access token, see "[Creating a personal access token](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." + */ + getServerStatistics: { + ( + params?: RestEndpointMethodTypes["enterpriseAdmin"]["getServerStatistics"]["parameters"] + ): Promise< + RestEndpointMethodTypes["enterpriseAdmin"]["getServerStatistics"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Lists all labels for a self-hosted runner configured in an enterprise. + * + * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + */ + listLabelsForSelfHostedRunnerForEnterprise: { + ( + params?: RestEndpointMethodTypes["enterpriseAdmin"]["listLabelsForSelfHostedRunnerForEnterprise"]["parameters"] + ): Promise< + RestEndpointMethodTypes["enterpriseAdmin"]["listLabelsForSelfHostedRunnerForEnterprise"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * @@ -2755,7 +4128,40 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * Remove all custom labels from a self-hosted runner configured in an + * enterprise. Returns the remaining read-only labels from the runner. + * + * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + */ + removeAllCustomLabelsFromSelfHostedRunnerForEnterprise: { + ( + params?: RestEndpointMethodTypes["enterpriseAdmin"]["removeAllCustomLabelsFromSelfHostedRunnerForEnterprise"]["parameters"] + ): Promise< + RestEndpointMethodTypes["enterpriseAdmin"]["removeAllCustomLabelsFromSelfHostedRunnerForEnterprise"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Remove a custom label from a self-hosted runner configured + * in an enterprise. Returns the remaining labels from the runner. + * + * This endpoint returns a `404 Not Found` status if the custom label is not + * present on the runner. + * + * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + */ + removeCustomLabelFromSelfHostedRunnerForEnterprise: { + ( + params?: RestEndpointMethodTypes["enterpriseAdmin"]["removeCustomLabelFromSelfHostedRunnerForEnterprise"]["parameters"] + ): Promise< + RestEndpointMethodTypes["enterpriseAdmin"]["removeCustomLabelFromSelfHostedRunnerForEnterprise"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Sets the actions and reusable workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ @@ -2769,7 +4175,22 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. + * Remove all previous custom labels and set the new custom labels for a specific + * self-hosted runner configured in an enterprise. + * + * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + */ + setCustomLabelsForSelfHostedRunnerForEnterprise: { + ( + params?: RestEndpointMethodTypes["enterpriseAdmin"]["setCustomLabelsForSelfHostedRunnerForEnterprise"]["parameters"] + ): Promise< + RestEndpointMethodTypes["enterpriseAdmin"]["setCustomLabelsForSelfHostedRunnerForEnterprise"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Sets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise. * * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ @@ -2998,7 +4419,7 @@ export type RestEndpointMethods = { * | Name | Type | Description | * | ---- | ---- | ----------- | * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | * @@ -3118,7 +4539,7 @@ export type RestEndpointMethods = { * | Name | Type | Description | * | ---- | ---- | ----------- | * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | * @@ -3447,9 +4868,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. + * Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. * - * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ create: { ( @@ -3459,7 +4880,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ createComment: { ( @@ -3518,7 +4939,7 @@ export type RestEndpointMethods = { }; /** * The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was - * [transferred](https://help.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If + * [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read * access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe @@ -3587,7 +5008,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists the [available assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. + * Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. */ listAssignees: { ( @@ -3890,7 +5311,7 @@ export type RestEndpointMethods = { }; meta: { /** - * Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://help.github.com/articles/about-github-s-ip-addresses/)." + * Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/)." * * **Note:** The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses. */ @@ -4196,7 +5617,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.github.com). You can learn more about our LFS feature and working with large files [on our help site](https://help.github.com/articles/versioning-large-files/). + * You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.github.com). You can learn more about our LFS feature and working with large files [on our help site](https://docs.github.com/articles/versioning-large-files/). */ setLfsPreference: { ( @@ -4270,6 +5691,10 @@ export type RestEndpointMethods = { /** * An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API * request. If no parameters are provided, the import will be restarted. + * + * Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will + * have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. + * You can select the project to import by providing one of the objects in the `project_choices` array in the update request. */ updateImport: { ( @@ -4336,7 +5761,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://help.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". + * When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */ convertMemberToOutsideCollaborator: { ( @@ -4380,7 +5805,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + * To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). * * GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below." */ @@ -4485,6 +5910,21 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * List the custom repository roles available in this organization. In order to see custom + * repository roles in an organization, the authenticated user must be an organization owner. + * + * For more information on custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". + */ + listCustomRoles: { + ( + params?: RestEndpointMethodTypes["orgs"]["listCustomRoles"]["parameters"] + ): Promise< + RestEndpointMethodTypes["orgs"]["listCustomRoles"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure. */ @@ -4514,7 +5954,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * List [public organization memberships](https://help.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user. + * List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user. * * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead. */ @@ -5453,7 +6893,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. * @@ -5501,7 +6941,7 @@ export type RestEndpointMethods = { /** * Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff. * - * You can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see the [`comfort-fade` preview notice](https://docs.github.com/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices). + * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. * * **Note:** The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. * @@ -5549,7 +6989,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists details of a pull request by providing its number. * @@ -5559,9 +6999,9 @@ export type RestEndpointMethods = { * * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: * - * * If merged as a [merge commit](https://help.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. - * * If merged via a [squash](https://help.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. - * * If [rebased](https://help.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. + * * If merged as a [merge commit](https://docs.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. + * * If merged via a [squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. + * * If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. * * Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. */ @@ -5593,7 +7033,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ list: { ( @@ -5719,7 +7159,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. */ @@ -5922,6 +7362,20 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. + * + * Delete a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). + */ + deleteForRelease: { + ( + params?: RestEndpointMethodTypes["reactions"]["deleteForRelease"]["parameters"] + ): Promise< + RestEndpointMethodTypes["reactions"]["deleteForRelease"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * @@ -5998,6 +7452,18 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * List the reactions to a [release](https://docs.github.com/rest/reference/repos#releases). + */ + listForRelease: { + ( + params?: RestEndpointMethodTypes["reactions"]["listForRelease"]["parameters"] + ): Promise< + RestEndpointMethodTypes["reactions"]["listForRelease"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -6051,7 +7517,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Grants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. * @@ -6069,14 +7535,24 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. * - * For more information the permission levels, see "[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". + * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." + * + * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: + * + * ``` + * Cannot assign {member} permission of {role name} + * ``` * * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." * * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/rest/reference/repos#invitations). * + * **Updating an existing collaborator's permission level** + * + * The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed. + * * **Rate limits** * * You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository. @@ -6091,7 +7567,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ addStatusCheckContexts: { ( @@ -6103,7 +7579,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Grants the specified teams push access for this branch. You can also give push access to child teams. * @@ -6121,7 +7597,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Grants the specified people push access for this branch. * @@ -6142,6 +7618,10 @@ export type RestEndpointMethods = { * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. * * Team members will include the members of child teams. + * + * You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this + * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this + * endpoint. */ checkCollaborator: { ( @@ -6153,7 +7633,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". + * Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ checkVulnerabilityAlerts: { ( @@ -6164,6 +7644,22 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * List any syntax errors that are detected in the CODEOWNERS + * file. + * + * For more information about the correct CODEOWNERS syntax, + * see "[About code owners](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." + */ + codeownersErrors: { + ( + params?: RestEndpointMethodTypes["repos"]["codeownersErrors"]["parameters"] + ): Promise< + RestEndpointMethodTypes["repos"]["codeownersErrors"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * **Deprecated**: Use `repos.compareCommitsWithBasehead()` (`GET /repos/{owner}/{repo}/compare/{basehead}`) instead. Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`. * @@ -6293,7 +7789,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. */ @@ -6347,7 +7843,7 @@ export type RestEndpointMethods = { * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will * return a failure response. * - * By default, [commit statuses](https://docs.github.com/rest/reference/repos#statuses) for every submitted context must be in a `success` + * By default, [commit statuses](https://docs.github.com/rest/commits/statuses) for every submitted context must be in a `success` * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do * not require any contexts or create any commit statuses, the deployment will always succeed. @@ -6409,7 +7905,7 @@ export type RestEndpointMethods = { * * This endpoint requires write access to the repository by providing either: * - * - Personal access tokens with `repo` scope. For more information, see "[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation. + * - Personal access tokens with `repo` scope. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation. * - GitHub Apps with both `metadata:read` and `contents:read&write` permissions. * * This input example shows how you can use the `client_payload` as a test to debug your workflow. @@ -6525,6 +8021,19 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * This creates a tag protection state for a repository. + * This endpoint is only available to repository administrators. + */ + createTagProtection: { + ( + params?: RestEndpointMethodTypes["repos"]["createTagProtection"]["parameters"] + ): Promise< + RestEndpointMethodTypes["repos"]["createTagProtection"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. * @@ -6591,7 +8100,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Disables the ability to restrict who can push to this branch. */ @@ -6605,7 +8114,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ @@ -6645,7 +8154,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ deleteBranchProtection: { ( @@ -6667,7 +8176,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. */ @@ -6693,7 +8202,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * To ensure there can always be an active deployment, you can only delete an _inactive_ deployment. Anyone with `repo` or `repo_deployment` scopes can delete an inactive deployment. + * If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment. * * To set a deployment as inactive, you must: * @@ -6748,7 +8257,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ deletePullRequestReviewProtection: { ( @@ -6779,6 +8288,19 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * This deletes a tag protection state for a repository. + * This endpoint is only available to repository administrators. + */ + deleteTagProtection: { + ( + params?: RestEndpointMethodTypes["repos"]["deleteTagProtection"]["parameters"] + ): Promise< + RestEndpointMethodTypes["repos"]["deleteTagProtection"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; deleteWebhook: { ( @@ -6788,7 +8310,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://help.github.com/en/articles/configuring-automated-security-fixes)". + * Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)". */ disableAutomatedSecurityFixes: { ( @@ -6799,9 +8321,7 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - /** - * **Note:** The Git LFS API endpoints are currently in beta and are subject to change. - */ + disableLfsForRepo: { ( params?: RestEndpointMethodTypes["repos"]["disableLfsForRepo"]["parameters"] @@ -6812,7 +8332,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". + * Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ disableVulnerabilityAlerts: { ( @@ -6870,7 +8390,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://help.github.com/en/articles/configuring-automated-security-fixes)". + * Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)". */ enableAutomatedSecurityFixes: { ( @@ -6881,9 +8401,7 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - /** - * **Note:** The Git LFS API endpoints are currently in beta and are subject to change. - */ + enableLfsForRepo: { ( params?: RestEndpointMethodTypes["repos"]["enableLfsForRepo"]["parameters"] @@ -6894,7 +8412,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". + * Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ enableVulnerabilityAlerts: { ( @@ -6928,7 +8446,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists who has access to this protected branch. * @@ -6944,7 +8462,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ getAdminBranchProtection: { ( @@ -6970,7 +8488,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ getAllStatusCheckContexts: { ( @@ -6990,7 +8508,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. */ @@ -7024,7 +8542,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ getBranchProtection: { ( @@ -7072,7 +8590,6 @@ export type RestEndpointMethods = { /** * Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. * - * The most recent status for each context is returned, up to 100. This field [paginates](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination) if there are over 100 contexts. * * Additionally, a combined `state` is returned. The `state` is one of: * @@ -7157,9 +8674,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://help.github.com/articles/signing-commits-with-gpg) in GitHub Help. + * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help. * * **Note**: You must enable branch protection to require signed commits. */ @@ -7208,7 +8725,12 @@ export type RestEndpointMethods = { * * To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/reference/git#trees). * * This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees * API](https://docs.github.com/rest/reference/git#get-a-tree). - * * This API supports files up to 1 megabyte in size. + * + * #### Size limits + * If the requested file's size is: + * * 1 MB or smaller: All features of this endpoint are supported. + * * Between 1-100 MB: Only the `raw` or `object` [custom media types](https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents) are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. + * * Greater than 100 MB: This endpoint is not supported. * * #### If the content is a directory * The response will be an array of objects, one object for each item in the directory. @@ -7364,7 +8886,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ getPullRequestReviewProtection: { ( @@ -7454,7 +8976,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ getStatusChecksProtection: { ( @@ -7466,7 +8988,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the teams who have push access to this branch. The list includes child teams. */ @@ -7502,7 +9024,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the people who have push access to this branch. */ @@ -7582,7 +9104,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. */ @@ -7597,8 +9119,13 @@ export type RestEndpointMethods = { }; /** * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. + * Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. * * Team members will include the members of child teams. + * + * You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this + * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this + * endpoint. */ listCollaborators: { ( @@ -7835,7 +9362,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests) endpoint. + * Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. */ listPullRequestsAssociatedWithCommit: { ( @@ -7868,6 +9395,20 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * This returns the tag protection states of a repository. + * + * This information is only available to repository administrators. + */ + listTagProtection: { + ( + params?: RestEndpointMethodTypes["repos"]["listTagProtection"]["parameters"] + ): Promise< + RestEndpointMethodTypes["repos"]["listTagProtection"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; listTags: { ( @@ -7913,8 +9454,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * **Note:** This endpoint is currently in beta and subject to change. - * * Sync a branch of a forked repository to keep it up-to-date with the upstream repository. */ mergeUpstream: { @@ -7947,7 +9486,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removes the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. * @@ -7975,7 +9514,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ removeStatusCheckContexts: { ( @@ -7987,7 +9526,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ removeStatusCheckProtection: { ( @@ -7999,7 +9538,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removes the ability of a team to push to this branch. You can also remove push access for child teams. * @@ -8017,7 +9556,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removes the ability of a user to push to this branch. * @@ -8083,7 +9622,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ @@ -8097,7 +9636,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. * @@ -8115,7 +9654,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ setStatusCheckContexts: { ( @@ -8127,7 +9666,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams. * @@ -8145,7 +9684,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people. * @@ -8177,7 +9716,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://help.github.com/articles/about-repository-transfers/). + * A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). */ transfer: { ( @@ -8197,7 +9736,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Protecting a branch requires admin or owner permissions to the repository. * @@ -8247,7 +9786,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. * @@ -8285,7 +9824,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. * @deprecated octokit.rest.repos.updateStatusCheckPotection() has been renamed to octokit.rest.repos.updateStatusCheckProtection() (2020-09-17) @@ -8300,7 +9839,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. */ @@ -8463,10 +10002,6 @@ export type RestEndpointMethods = { * `q=tetris+language:assembly&sort=stars&order=desc` * * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. - * - * When you include the `mercy` preview header, you can also search for multiple topics by adding more `topic:` instances. For example, your query might look like this: - * - * `q=topic:ruby+topic:rails` */ repos: { ( @@ -8476,7 +10011,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://help.github.com/articles/searching-topics/)" for a detailed list of qualifiers. + * Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. * * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). * @@ -8514,7 +10049,9 @@ export type RestEndpointMethods = { }; secretScanning: { /** - * Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. + * Gets a single secret scanning alert detected in an eligible repository. + * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. + * For public repositories, you may instead use the `public_repo` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ @@ -8528,8 +10065,22 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists all secret scanning alerts for all eligible repositories in an organization, from newest to oldest. - * To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. + * Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. + * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). + */ + listAlertsForEnterprise: { + ( + params?: RestEndpointMethodTypes["secretScanning"]["listAlertsForEnterprise"]["parameters"] + ): Promise< + RestEndpointMethodTypes["secretScanning"]["listAlertsForEnterprise"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. + * To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. + * For public repositories, you may instead use the `public_repo` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ @@ -8543,7 +10094,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists all secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. + * Lists secret scanning alerts for an eligible repository, from newest to oldest. + * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. + * For public repositories, you may instead use the `public_repo` scope. * * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ @@ -8557,7 +10110,25 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. + * Lists all locations for a given secret scanning alert for an eligible repository. + * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. + * For public repositories, you may instead use the `public_repo` scope. + * + * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + */ + listLocationsForAlert: { + ( + params?: RestEndpointMethodTypes["secretScanning"]["listLocationsForAlert"]["parameters"] + ): Promise< + RestEndpointMethodTypes["secretScanning"]["listLocationsForAlert"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Updates the status of a secret scanning alert in an eligible repository. + * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. + * For public repositories, you may instead use the `public_repo` scope. * * GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. */ @@ -8573,11 +10144,11 @@ export type RestEndpointMethods = { }; teams: { /** - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. * @@ -8613,7 +10184,7 @@ export type RestEndpointMethods = { * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. * - * For more information about the permission levels, see "[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". + * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ addOrUpdateRepoPermissionsInOrg: { ( @@ -8657,9 +10228,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://help.github.com/en/articles/setting-team-creation-permissions-in-your-organization)." + * To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/en/articles/setting-team-creation-permissions-in-your-organization)." * - * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)". + * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)". */ create: { ( @@ -8924,11 +10495,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ diff --git a/src/generated/parameters-and-response-types.ts b/src/generated/parameters-and-response-types.ts index d42c221c5..97cb6859d 100644 --- a/src/generated/parameters-and-response-types.ts +++ b/src/generated/parameters-and-response-types.ts @@ -2,6 +2,22 @@ import { Endpoints, RequestParameters } from "@octokit/types"; export type RestEndpointMethodTypes = { actions: { + addCustomLabelsToSelfHostedRunnerForOrg: { + parameters: RequestParameters & + Omit< + Endpoints["POST /orgs/{org}/actions/runners/{runner_id}/labels"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["POST /orgs/{org}/actions/runners/{runner_id}/labels"]["response"]; + }; + addCustomLabelsToSelfHostedRunnerForRepo: { + parameters: RequestParameters & + Omit< + Endpoints["POST /repos/{owner}/{repo}/actions/runners/{runner_id}/labels"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["POST /repos/{owner}/{repo}/actions/runners/{runner_id}/labels"]["response"]; + }; addSelectedRepoToOrgSecret: { parameters: RequestParameters & Omit< @@ -218,6 +234,38 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable"]["response"]; }; + getActionsCacheUsage: { + parameters: RequestParameters & + Omit< + Endpoints["GET /repos/{owner}/{repo}/actions/cache/usage"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /repos/{owner}/{repo}/actions/cache/usage"]["response"]; + }; + getActionsCacheUsageByRepoForOrg: { + parameters: RequestParameters & + Omit< + Endpoints["GET /orgs/{org}/actions/cache/usage-by-repository"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /orgs/{org}/actions/cache/usage-by-repository"]["response"]; + }; + getActionsCacheUsageForEnterprise: { + parameters: RequestParameters & + Omit< + Endpoints["GET /enterprises/{enterprise}/actions/cache/usage"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /enterprises/{enterprise}/actions/cache/usage"]["response"]; + }; + getActionsCacheUsageForOrg: { + parameters: RequestParameters & + Omit< + Endpoints["GET /orgs/{org}/actions/cache/usage"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /orgs/{org}/actions/cache/usage"]["response"]; + }; getAllowedActionsOrganization: { parameters: RequestParameters & Omit< @@ -258,6 +306,30 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}"]["response"]; }; + getGithubActionsDefaultWorkflowPermissionsEnterprise: { + parameters: RequestParameters & + Omit< + Endpoints["GET /enterprises/{enterprise}/actions/permissions/workflow"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /enterprises/{enterprise}/actions/permissions/workflow"]["response"]; + }; + getGithubActionsDefaultWorkflowPermissionsOrganization: { + parameters: RequestParameters & + Omit< + Endpoints["GET /orgs/{org}/actions/permissions/workflow"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /orgs/{org}/actions/permissions/workflow"]["response"]; + }; + getGithubActionsDefaultWorkflowPermissionsRepository: { + parameters: RequestParameters & + Omit< + Endpoints["GET /repos/{owner}/{repo}/actions/permissions/workflow"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /repos/{owner}/{repo}/actions/permissions/workflow"]["response"]; + }; getGithubActionsPermissionsOrganization: { parameters: RequestParameters & Omit< @@ -362,6 +434,14 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}"]["response"]; }; + getWorkflowAccessToRepository: { + parameters: RequestParameters & + Omit< + Endpoints["GET /repos/{owner}/{repo}/actions/permissions/access"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /repos/{owner}/{repo}/actions/permissions/access"]["response"]; + }; getWorkflowRun: { parameters: RequestParameters & Omit< @@ -426,6 +506,22 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs"]["response"]; }; + listLabelsForSelfHostedRunnerForOrg: { + parameters: RequestParameters & + Omit< + Endpoints["GET /orgs/{org}/actions/runners/{runner_id}/labels"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /orgs/{org}/actions/runners/{runner_id}/labels"]["response"]; + }; + listLabelsForSelfHostedRunnerForRepo: { + parameters: RequestParameters & + Omit< + Endpoints["GET /repos/{owner}/{repo}/actions/runners/{runner_id}/labels"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runners/{runner_id}/labels"]["response"]; + }; listOrgSecrets: { parameters: RequestParameters & Omit< @@ -522,6 +618,62 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /repos/{owner}/{repo}/actions/runs"]["response"]; }; + reRunJobForWorkflowRun: { + parameters: RequestParameters & + Omit< + Endpoints["POST /repos/{owner}/{repo}/actions/jobs/{job_id}/rerun"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["POST /repos/{owner}/{repo}/actions/jobs/{job_id}/rerun"]["response"]; + }; + reRunWorkflow: { + parameters: RequestParameters & + Omit< + Endpoints["POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun"]["response"]; + }; + reRunWorkflowFailedJobs: { + parameters: RequestParameters & + Omit< + Endpoints["POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs"]["response"]; + }; + removeAllCustomLabelsFromSelfHostedRunnerForOrg: { + parameters: RequestParameters & + Omit< + Endpoints["DELETE /orgs/{org}/actions/runners/{runner_id}/labels"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["DELETE /orgs/{org}/actions/runners/{runner_id}/labels"]["response"]; + }; + removeAllCustomLabelsFromSelfHostedRunnerForRepo: { + parameters: RequestParameters & + Omit< + Endpoints["DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}/labels"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}/labels"]["response"]; + }; + removeCustomLabelFromSelfHostedRunnerForOrg: { + parameters: RequestParameters & + Omit< + Endpoints["DELETE /orgs/{org}/actions/runners/{runner_id}/labels/{name}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["DELETE /orgs/{org}/actions/runners/{runner_id}/labels/{name}"]["response"]; + }; + removeCustomLabelFromSelfHostedRunnerForRepo: { + parameters: RequestParameters & + Omit< + Endpoints["DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}"]["response"]; + }; removeSelectedRepoFromOrgSecret: { parameters: RequestParameters & Omit< @@ -554,6 +706,46 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["PUT /repos/{owner}/{repo}/actions/permissions/selected-actions"]["response"]; }; + setCustomLabelsForSelfHostedRunnerForOrg: { + parameters: RequestParameters & + Omit< + Endpoints["PUT /orgs/{org}/actions/runners/{runner_id}/labels"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PUT /orgs/{org}/actions/runners/{runner_id}/labels"]["response"]; + }; + setCustomLabelsForSelfHostedRunnerForRepo: { + parameters: RequestParameters & + Omit< + Endpoints["PUT /repos/{owner}/{repo}/actions/runners/{runner_id}/labels"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PUT /repos/{owner}/{repo}/actions/runners/{runner_id}/labels"]["response"]; + }; + setGithubActionsDefaultWorkflowPermissionsEnterprise: { + parameters: RequestParameters & + Omit< + Endpoints["PUT /enterprises/{enterprise}/actions/permissions/workflow"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PUT /enterprises/{enterprise}/actions/permissions/workflow"]["response"]; + }; + setGithubActionsDefaultWorkflowPermissionsOrganization: { + parameters: RequestParameters & + Omit< + Endpoints["PUT /orgs/{org}/actions/permissions/workflow"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PUT /orgs/{org}/actions/permissions/workflow"]["response"]; + }; + setGithubActionsDefaultWorkflowPermissionsRepository: { + parameters: RequestParameters & + Omit< + Endpoints["PUT /repos/{owner}/{repo}/actions/permissions/workflow"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PUT /repos/{owner}/{repo}/actions/permissions/workflow"]["response"]; + }; setGithubActionsPermissionsOrganization: { parameters: RequestParameters & Omit< @@ -586,6 +778,14 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["PUT /orgs/{org}/actions/permissions/repositories"]["response"]; }; + setWorkflowAccessToRepository: { + parameters: RequestParameters & + Omit< + Endpoints["PUT /repos/{owner}/{repo}/actions/permissions/access"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PUT /repos/{owner}/{repo}/actions/permissions/access"]["response"]; + }; }; activity: { checkRepoIsStarredByAuthenticatedUser: { @@ -862,22 +1062,6 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["POST /applications/{client_id}/token"]["response"]; }; - createContentAttachment: { - parameters: RequestParameters & - Omit< - Endpoints["POST /content_references/{content_reference_id}/attachments"]["parameters"], - "baseUrl" | "headers" | "mediaType" - >; - response: Endpoints["POST /content_references/{content_reference_id}/attachments"]["response"]; - }; - createContentAttachmentForRepo: { - parameters: RequestParameters & - Omit< - Endpoints["POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments"]["parameters"], - "baseUrl" | "headers" | "mediaType" - >; - response: Endpoints["POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments"]["response"]; - }; createFromManifest: { parameters: RequestParameters & Omit< @@ -1176,6 +1360,22 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /users/{username}/settings/billing/actions"]["response"]; }; + getGithubAdvancedSecurityBillingGhe: { + parameters: RequestParameters & + Omit< + Endpoints["GET /enterprises/{enterprise}/settings/billing/advanced-security"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /enterprises/{enterprise}/settings/billing/advanced-security"]["response"]; + }; + getGithubAdvancedSecurityBillingOrg: { + parameters: RequestParameters & + Omit< + Endpoints["GET /orgs/{org}/settings/billing/advanced-security"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /orgs/{org}/settings/billing/advanced-security"]["response"]; + }; getGithubPackagesBillingOrg: { parameters: RequestParameters & Omit< @@ -1348,6 +1548,14 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances"]["response"]; }; + listAlertsForOrg: { + parameters: RequestParameters & + Omit< + Endpoints["GET /orgs/{org}/code-scanning/alerts"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /orgs/{org}/code-scanning/alerts"]["response"]; + }; listAlertsForRepo: { parameters: RequestParameters & Omit< @@ -1407,6 +1615,364 @@ export type RestEndpointMethodTypes = { response: Endpoints["GET /codes_of_conduct/{key}"]["response"]; }; }; + codespaces: { + addRepositoryForSecretForAuthenticatedUser: { + parameters: RequestParameters & + Omit< + Endpoints["PUT /user/codespaces/secrets/{secret_name}/repositories/{repository_id}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PUT /user/codespaces/secrets/{secret_name}/repositories/{repository_id}"]["response"]; + }; + codespaceMachinesForAuthenticatedUser: { + parameters: RequestParameters & + Omit< + Endpoints["GET /user/codespaces/{codespace_name}/machines"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /user/codespaces/{codespace_name}/machines"]["response"]; + }; + createForAuthenticatedUser: { + parameters: RequestParameters & + Omit< + Endpoints["POST /user/codespaces"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["POST /user/codespaces"]["response"]; + }; + createOrUpdateRepoSecret: { + parameters: RequestParameters & + Omit< + Endpoints["PUT /repos/{owner}/{repo}/codespaces/secrets/{secret_name}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PUT /repos/{owner}/{repo}/codespaces/secrets/{secret_name}"]["response"]; + }; + createOrUpdateSecretForAuthenticatedUser: { + parameters: RequestParameters & + Omit< + Endpoints["PUT /user/codespaces/secrets/{secret_name}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PUT /user/codespaces/secrets/{secret_name}"]["response"]; + }; + createWithPrForAuthenticatedUser: { + parameters: RequestParameters & + Omit< + Endpoints["POST /repos/{owner}/{repo}/pulls/{pull_number}/codespaces"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["POST /repos/{owner}/{repo}/pulls/{pull_number}/codespaces"]["response"]; + }; + createWithRepoForAuthenticatedUser: { + parameters: RequestParameters & + Omit< + Endpoints["POST /repos/{owner}/{repo}/codespaces"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["POST /repos/{owner}/{repo}/codespaces"]["response"]; + }; + deleteForAuthenticatedUser: { + parameters: RequestParameters & + Omit< + Endpoints["DELETE /user/codespaces/{codespace_name}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["DELETE /user/codespaces/{codespace_name}"]["response"]; + }; + deleteRepoSecret: { + parameters: RequestParameters & + Omit< + Endpoints["DELETE /repos/{owner}/{repo}/codespaces/secrets/{secret_name}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["DELETE /repos/{owner}/{repo}/codespaces/secrets/{secret_name}"]["response"]; + }; + deleteSecretForAuthenticatedUser: { + parameters: RequestParameters & + Omit< + Endpoints["DELETE /user/codespaces/secrets/{secret_name}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["DELETE /user/codespaces/secrets/{secret_name}"]["response"]; + }; + exportForAuthenticatedUser: { + parameters: RequestParameters & + Omit< + Endpoints["POST /user/codespaces/{codespace_name}/exports"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["POST /user/codespaces/{codespace_name}/exports"]["response"]; + }; + getExportDetailsForAuthenticatedUser: { + parameters: RequestParameters & + Omit< + Endpoints["GET /user/codespaces/{codespace_name}/exports/{export_id}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /user/codespaces/{codespace_name}/exports/{export_id}"]["response"]; + }; + getForAuthenticatedUser: { + parameters: RequestParameters & + Omit< + Endpoints["GET /user/codespaces/{codespace_name}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /user/codespaces/{codespace_name}"]["response"]; + }; + getPublicKeyForAuthenticatedUser: { + parameters: RequestParameters & + Omit< + Endpoints["GET /user/codespaces/secrets/public-key"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /user/codespaces/secrets/public-key"]["response"]; + }; + getRepoPublicKey: { + parameters: RequestParameters & + Omit< + Endpoints["GET /repos/{owner}/{repo}/codespaces/secrets/public-key"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /repos/{owner}/{repo}/codespaces/secrets/public-key"]["response"]; + }; + getRepoSecret: { + parameters: RequestParameters & + Omit< + Endpoints["GET /repos/{owner}/{repo}/codespaces/secrets/{secret_name}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /repos/{owner}/{repo}/codespaces/secrets/{secret_name}"]["response"]; + }; + getSecretForAuthenticatedUser: { + parameters: RequestParameters & + Omit< + Endpoints["GET /user/codespaces/secrets/{secret_name}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /user/codespaces/secrets/{secret_name}"]["response"]; + }; + listDevcontainersInRepositoryForAuthenticatedUser: { + parameters: RequestParameters & + Omit< + Endpoints["GET /repos/{owner}/{repo}/codespaces/devcontainers"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /repos/{owner}/{repo}/codespaces/devcontainers"]["response"]; + }; + listForAuthenticatedUser: { + parameters: RequestParameters & + Omit< + Endpoints["GET /user/codespaces"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /user/codespaces"]["response"]; + }; + listInRepositoryForAuthenticatedUser: { + parameters: RequestParameters & + Omit< + Endpoints["GET /repos/{owner}/{repo}/codespaces"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /repos/{owner}/{repo}/codespaces"]["response"]; + }; + listRepoSecrets: { + parameters: RequestParameters & + Omit< + Endpoints["GET /repos/{owner}/{repo}/codespaces/secrets"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /repos/{owner}/{repo}/codespaces/secrets"]["response"]; + }; + listRepositoriesForSecretForAuthenticatedUser: { + parameters: RequestParameters & + Omit< + Endpoints["GET /user/codespaces/secrets/{secret_name}/repositories"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /user/codespaces/secrets/{secret_name}/repositories"]["response"]; + }; + listSecretsForAuthenticatedUser: { + parameters: RequestParameters & + Omit< + Endpoints["GET /user/codespaces/secrets"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /user/codespaces/secrets"]["response"]; + }; + removeRepositoryForSecretForAuthenticatedUser: { + parameters: RequestParameters & + Omit< + Endpoints["DELETE /user/codespaces/secrets/{secret_name}/repositories/{repository_id}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["DELETE /user/codespaces/secrets/{secret_name}/repositories/{repository_id}"]["response"]; + }; + repoMachinesForAuthenticatedUser: { + parameters: RequestParameters & + Omit< + Endpoints["GET /repos/{owner}/{repo}/codespaces/machines"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /repos/{owner}/{repo}/codespaces/machines"]["response"]; + }; + setRepositoriesForSecretForAuthenticatedUser: { + parameters: RequestParameters & + Omit< + Endpoints["PUT /user/codespaces/secrets/{secret_name}/repositories"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PUT /user/codespaces/secrets/{secret_name}/repositories"]["response"]; + }; + startForAuthenticatedUser: { + parameters: RequestParameters & + Omit< + Endpoints["POST /user/codespaces/{codespace_name}/start"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["POST /user/codespaces/{codespace_name}/start"]["response"]; + }; + stopForAuthenticatedUser: { + parameters: RequestParameters & + Omit< + Endpoints["POST /user/codespaces/{codespace_name}/stop"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["POST /user/codespaces/{codespace_name}/stop"]["response"]; + }; + updateForAuthenticatedUser: { + parameters: RequestParameters & + Omit< + Endpoints["PATCH /user/codespaces/{codespace_name}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PATCH /user/codespaces/{codespace_name}"]["response"]; + }; + }; + dependabot: { + addSelectedRepoToOrgSecret: { + parameters: RequestParameters & + Omit< + Endpoints["PUT /orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PUT /orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}"]["response"]; + }; + createOrUpdateOrgSecret: { + parameters: RequestParameters & + Omit< + Endpoints["PUT /orgs/{org}/dependabot/secrets/{secret_name}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PUT /orgs/{org}/dependabot/secrets/{secret_name}"]["response"]; + }; + createOrUpdateRepoSecret: { + parameters: RequestParameters & + Omit< + Endpoints["PUT /repos/{owner}/{repo}/dependabot/secrets/{secret_name}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PUT /repos/{owner}/{repo}/dependabot/secrets/{secret_name}"]["response"]; + }; + deleteOrgSecret: { + parameters: RequestParameters & + Omit< + Endpoints["DELETE /orgs/{org}/dependabot/secrets/{secret_name}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["DELETE /orgs/{org}/dependabot/secrets/{secret_name}"]["response"]; + }; + deleteRepoSecret: { + parameters: RequestParameters & + Omit< + Endpoints["DELETE /repos/{owner}/{repo}/dependabot/secrets/{secret_name}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["DELETE /repos/{owner}/{repo}/dependabot/secrets/{secret_name}"]["response"]; + }; + getOrgPublicKey: { + parameters: RequestParameters & + Omit< + Endpoints["GET /orgs/{org}/dependabot/secrets/public-key"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /orgs/{org}/dependabot/secrets/public-key"]["response"]; + }; + getOrgSecret: { + parameters: RequestParameters & + Omit< + Endpoints["GET /orgs/{org}/dependabot/secrets/{secret_name}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /orgs/{org}/dependabot/secrets/{secret_name}"]["response"]; + }; + getRepoPublicKey: { + parameters: RequestParameters & + Omit< + Endpoints["GET /repos/{owner}/{repo}/dependabot/secrets/public-key"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /repos/{owner}/{repo}/dependabot/secrets/public-key"]["response"]; + }; + getRepoSecret: { + parameters: RequestParameters & + Omit< + Endpoints["GET /repos/{owner}/{repo}/dependabot/secrets/{secret_name}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /repos/{owner}/{repo}/dependabot/secrets/{secret_name}"]["response"]; + }; + listOrgSecrets: { + parameters: RequestParameters & + Omit< + Endpoints["GET /orgs/{org}/dependabot/secrets"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /orgs/{org}/dependabot/secrets"]["response"]; + }; + listRepoSecrets: { + parameters: RequestParameters & + Omit< + Endpoints["GET /repos/{owner}/{repo}/dependabot/secrets"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /repos/{owner}/{repo}/dependabot/secrets"]["response"]; + }; + listSelectedReposForOrgSecret: { + parameters: RequestParameters & + Omit< + Endpoints["GET /orgs/{org}/dependabot/secrets/{secret_name}/repositories"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /orgs/{org}/dependabot/secrets/{secret_name}/repositories"]["response"]; + }; + removeSelectedRepoFromOrgSecret: { + parameters: RequestParameters & + Omit< + Endpoints["DELETE /orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["DELETE /orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}"]["response"]; + }; + setSelectedReposForOrgSecret: { + parameters: RequestParameters & + Omit< + Endpoints["PUT /orgs/{org}/dependabot/secrets/{secret_name}/repositories"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PUT /orgs/{org}/dependabot/secrets/{secret_name}/repositories"]["response"]; + }; + }; + dependencyGraph: { + diffRange: { + parameters: RequestParameters & + Omit< + Endpoints["GET /repos/{owner}/{repo}/dependency-graph/compare/{basehead}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /repos/{owner}/{repo}/dependency-graph/compare/{basehead}"]["response"]; + }; + }; emojis: { get: { parameters: RequestParameters & @@ -1418,6 +1984,14 @@ export type RestEndpointMethodTypes = { }; }; enterpriseAdmin: { + addCustomLabelsToSelfHostedRunnerForEnterprise: { + parameters: RequestParameters & + Omit< + Endpoints["POST /enterprises/{enterprise}/actions/runners/{runner_id}/labels"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["POST /enterprises/{enterprise}/actions/runners/{runner_id}/labels"]["response"]; + }; disableSelectedOrganizationGithubActionsEnterprise: { parameters: RequestParameters & Omit< @@ -1450,6 +2024,22 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /enterprises/{enterprise}/actions/permissions"]["response"]; }; + getServerStatistics: { + parameters: RequestParameters & + Omit< + Endpoints["GET /enterprise-installation/{enterprise_or_org}/server-statistics"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /enterprise-installation/{enterprise_or_org}/server-statistics"]["response"]; + }; + listLabelsForSelfHostedRunnerForEnterprise: { + parameters: RequestParameters & + Omit< + Endpoints["GET /enterprises/{enterprise}/actions/runners/{runner_id}/labels"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /enterprises/{enterprise}/actions/runners/{runner_id}/labels"]["response"]; + }; listSelectedOrganizationsEnabledGithubActionsEnterprise: { parameters: RequestParameters & Omit< @@ -1458,6 +2048,22 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /enterprises/{enterprise}/actions/permissions/organizations"]["response"]; }; + removeAllCustomLabelsFromSelfHostedRunnerForEnterprise: { + parameters: RequestParameters & + Omit< + Endpoints["DELETE /enterprises/{enterprise}/actions/runners/{runner_id}/labels"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["DELETE /enterprises/{enterprise}/actions/runners/{runner_id}/labels"]["response"]; + }; + removeCustomLabelFromSelfHostedRunnerForEnterprise: { + parameters: RequestParameters & + Omit< + Endpoints["DELETE /enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["DELETE /enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}"]["response"]; + }; setAllowedActionsEnterprise: { parameters: RequestParameters & Omit< @@ -1466,6 +2072,14 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["PUT /enterprises/{enterprise}/actions/permissions/selected-actions"]["response"]; }; + setCustomLabelsForSelfHostedRunnerForEnterprise: { + parameters: RequestParameters & + Omit< + Endpoints["PUT /enterprises/{enterprise}/actions/runners/{runner_id}/labels"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PUT /enterprises/{enterprise}/actions/runners/{runner_id}/labels"]["response"]; + }; setGithubActionsPermissionsEnterprise: { parameters: RequestParameters & Omit< @@ -2590,6 +3204,14 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /orgs/{org}/blocks"]["response"]; }; + listCustomRoles: { + parameters: RequestParameters & + Omit< + Endpoints["GET /organizations/{organization_id}/custom_roles"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /organizations/{organization_id}/custom_roles"]["response"]; + }; listFailedInvitations: { parameters: RequestParameters & Omit< @@ -3512,6 +4134,14 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}"]["response"]; }; + deleteForRelease: { + parameters: RequestParameters & + Omit< + Endpoints["DELETE /repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["DELETE /repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}"]["response"]; + }; deleteForTeamDiscussion: { parameters: RequestParameters & Omit< @@ -3560,6 +4190,14 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions"]["response"]; }; + listForRelease: { + parameters: RequestParameters & + Omit< + Endpoints["GET /repos/{owner}/{repo}/releases/{release_id}/reactions"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /repos/{owner}/{repo}/releases/{release_id}/reactions"]["response"]; + }; listForTeamDiscussionCommentInOrg: { parameters: RequestParameters & Omit< @@ -3650,6 +4288,14 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /repos/{owner}/{repo}/vulnerability-alerts"]["response"]; }; + codeownersErrors: { + parameters: RequestParameters & + Omit< + Endpoints["GET /repos/{owner}/{repo}/codeowners/errors"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /repos/{owner}/{repo}/codeowners/errors"]["response"]; + }; compareCommits: { parameters: RequestParameters & Omit< @@ -3786,6 +4432,14 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["POST /repos/{owner}/{repo}/releases"]["response"]; }; + createTagProtection: { + parameters: RequestParameters & + Omit< + Endpoints["POST /repos/{owner}/{repo}/tags/protection"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["POST /repos/{owner}/{repo}/tags/protection"]["response"]; + }; createUsingTemplate: { parameters: RequestParameters & Omit< @@ -3946,6 +4600,14 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["DELETE /repos/{owner}/{repo}/releases/assets/{asset_id}"]["response"]; }; + deleteTagProtection: { + parameters: RequestParameters & + Omit< + Endpoints["DELETE /repos/{owner}/{repo}/tags/protection/{tag_protection_id}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["DELETE /repos/{owner}/{repo}/tags/protection/{tag_protection_id}"]["response"]; + }; deleteWebhook: { parameters: RequestParameters & Omit< @@ -4602,6 +5264,14 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /repos/{owner}/{repo}/releases"]["response"]; }; + listTagProtection: { + parameters: RequestParameters & + Omit< + Endpoints["GET /repos/{owner}/{repo}/tags/protection"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /repos/{owner}/{repo}/tags/protection"]["response"]; + }; listTags: { parameters: RequestParameters & Omit< @@ -4966,6 +5636,14 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}"]["response"]; }; + listAlertsForEnterprise: { + parameters: RequestParameters & + Omit< + Endpoints["GET /enterprises/{enterprise}/secret-scanning/alerts"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /enterprises/{enterprise}/secret-scanning/alerts"]["response"]; + }; listAlertsForOrg: { parameters: RequestParameters & Omit< @@ -4982,6 +5660,14 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /repos/{owner}/{repo}/secret-scanning/alerts"]["response"]; }; + listLocationsForAlert: { + parameters: RequestParameters & + Omit< + Endpoints["GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations"]["response"]; + }; updateAlert: { parameters: RequestParameters & Omit<