diff --git a/docs/actions/addCustomLabelsToSelfHostedRunnerForRepo.md b/docs/actions/addCustomLabelsToSelfHostedRunnerForRepo.md index ad9141c4d..e147b2ebb 100644 --- a/docs/actions/addCustomLabelsToSelfHostedRunnerForRepo.md +++ b/docs/actions/addCustomLabelsToSelfHostedRunnerForRepo.md @@ -11,7 +11,6 @@ type: API method 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. -If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. diff --git a/docs/actions/cancelWorkflowRun.md b/docs/actions/cancelWorkflowRun.md index 5adaf5ffb..aa70c1030 100644 --- a/docs/actions/cancelWorkflowRun.md +++ b/docs/actions/cancelWorkflowRun.md @@ -11,7 +11,6 @@ type: API method Cancels a workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use this endpoint. ```js diff --git a/docs/actions/createEnvironmentVariable.md b/docs/actions/createEnvironmentVariable.md index 7fc653630..3b1521973 100644 --- a/docs/actions/createEnvironmentVariable.md +++ b/docs/actions/createEnvironmentVariable.md @@ -11,7 +11,6 @@ type: API method Create an environment variable that you can reference in a GitHub Actions workflow. You must authenticate using an access token with the `repo` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `environment:write` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. diff --git a/docs/actions/createRegistrationTokenForRepo.md b/docs/actions/createRegistrationTokenForRepo.md index 8f159a3aa..35c6b82ad 100644 --- a/docs/actions/createRegistrationTokenForRepo.md +++ b/docs/actions/createRegistrationTokenForRepo.md @@ -12,7 +12,6 @@ Returns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate using an access token with the `repo` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. diff --git a/docs/actions/createRemoveTokenForRepo.md b/docs/actions/createRemoveTokenForRepo.md index 9e2fa22fe..ee66f55d9 100644 --- a/docs/actions/createRemoveTokenForRepo.md +++ b/docs/actions/createRemoveTokenForRepo.md @@ -12,7 +12,6 @@ Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. You must authenticate using an access token with the `repo` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. diff --git a/docs/actions/createRepoVariable.md b/docs/actions/createRepoVariable.md index ccb6f6b60..36277f0e3 100644 --- a/docs/actions/createRepoVariable.md +++ b/docs/actions/createRepoVariable.md @@ -11,7 +11,6 @@ type: API method Creates a repository variable that you can reference in a GitHub Actions workflow. You must authenticate using an access token with the `repo` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. diff --git a/docs/actions/deleteEnvironmentVariable.md b/docs/actions/deleteEnvironmentVariable.md index abc159cc4..6f7e3a0dc 100644 --- a/docs/actions/deleteEnvironmentVariable.md +++ b/docs/actions/deleteEnvironmentVariable.md @@ -11,7 +11,6 @@ type: API method Deletes an environment variable using the variable name. You must authenticate using an access token with the `repo` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `environment:write` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. diff --git a/docs/actions/deleteRepoVariable.md b/docs/actions/deleteRepoVariable.md index 974c4f10a..7d8369227 100644 --- a/docs/actions/deleteRepoVariable.md +++ b/docs/actions/deleteRepoVariable.md @@ -11,7 +11,6 @@ type: API method Deletes a repository variable using the variable name. You must authenticate using an access token with the `repo` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. diff --git a/docs/actions/deleteSelfHostedRunnerFromRepo.md b/docs/actions/deleteSelfHostedRunnerFromRepo.md index c10b6bfa7..eca9d3dfa 100644 --- a/docs/actions/deleteSelfHostedRunnerFromRepo.md +++ b/docs/actions/deleteSelfHostedRunnerFromRepo.md @@ -11,7 +11,6 @@ type: API method Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. You must authenticate using an access token with the `repo` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. diff --git a/docs/actions/forceCancelWorkflowRun.md b/docs/actions/forceCancelWorkflowRun.md new file mode 100644 index 000000000..5d3647924 --- /dev/null +++ b/docs/actions/forceCancelWorkflowRun.md @@ -0,0 +1,54 @@ +--- +name: Force cancel a workflow run +example: octokit.rest.actions.forceCancelWorkflowRun({ owner, repo, run_id }) +route: POST /repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel +scope: actions +type: API method +--- + +# Force cancel a workflow run + +Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job. +You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-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.forceCancelWorkflowRun({ + 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 without the `.git` extension. The name is not case sensitive. + +
run_idyes + +The unique identifier of the workflow run. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run). diff --git a/docs/actions/generateRunnerJitconfigForRepo.md b/docs/actions/generateRunnerJitconfigForRepo.md index 52f59cf64..43a2d9874 100644 --- a/docs/actions/generateRunnerJitconfigForRepo.md +++ b/docs/actions/generateRunnerJitconfigForRepo.md @@ -11,7 +11,6 @@ type: API method Generates a configuration that can be passed to the runner application at startup. You must authenticate using an access token with the `repo` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. diff --git a/docs/actions/getEnvironmentVariable.md b/docs/actions/getEnvironmentVariable.md index 58fc08a2a..f82d83796 100644 --- a/docs/actions/getEnvironmentVariable.md +++ b/docs/actions/getEnvironmentVariable.md @@ -11,7 +11,6 @@ type: API method Gets a specific variable in an environment. You must authenticate using an access token with the `repo` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `environments:read` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. diff --git a/docs/actions/getRepoVariable.md b/docs/actions/getRepoVariable.md index d64710ca5..b729b89c9 100644 --- a/docs/actions/getRepoVariable.md +++ b/docs/actions/getRepoVariable.md @@ -11,7 +11,6 @@ type: API method Gets a specific variable in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. diff --git a/docs/actions/getSelfHostedRunnerForRepo.md b/docs/actions/getSelfHostedRunnerForRepo.md index 02926142d..1c732c53a 100644 --- a/docs/actions/getSelfHostedRunnerForRepo.md +++ b/docs/actions/getSelfHostedRunnerForRepo.md @@ -11,7 +11,6 @@ type: API method Gets a specific self-hosted runner configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. diff --git a/docs/actions/listEnvironmentVariables.md b/docs/actions/listEnvironmentVariables.md index 3e1536db8..07633ec4f 100644 --- a/docs/actions/listEnvironmentVariables.md +++ b/docs/actions/listEnvironmentVariables.md @@ -11,7 +11,6 @@ type: API method Lists all environment variables. You must authenticate using an access token with the `repo` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `environments:read` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. diff --git a/docs/actions/listLabelsForSelfHostedRunnerForRepo.md b/docs/actions/listLabelsForSelfHostedRunnerForRepo.md index 27ad3b69b..fd60c97b5 100644 --- a/docs/actions/listLabelsForSelfHostedRunnerForRepo.md +++ b/docs/actions/listLabelsForSelfHostedRunnerForRepo.md @@ -11,7 +11,6 @@ type: API method 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. -If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. diff --git a/docs/actions/listRepoOrganizationVariables.md b/docs/actions/listRepoOrganizationVariables.md index 1a1f61230..c4bde519d 100644 --- a/docs/actions/listRepoOrganizationVariables.md +++ b/docs/actions/listRepoOrganizationVariables.md @@ -11,7 +11,6 @@ type: API method Lists all organiation variables shared with a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. diff --git a/docs/actions/listRepoVariables.md b/docs/actions/listRepoVariables.md index e5b9691f0..27e07dd48 100644 --- a/docs/actions/listRepoVariables.md +++ b/docs/actions/listRepoVariables.md @@ -10,7 +10,6 @@ type: API method Lists all repository variables. You must authenticate using an access token with the `repo` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. diff --git a/docs/actions/listRunnerApplicationsForRepo.md b/docs/actions/listRunnerApplicationsForRepo.md index ef5f95bd7..4fabecfc9 100644 --- a/docs/actions/listRunnerApplicationsForRepo.md +++ b/docs/actions/listRunnerApplicationsForRepo.md @@ -11,7 +11,6 @@ type: API method Lists binaries for the runner application that you can download and run. You must authenticate using an access token with the `repo` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. diff --git a/docs/actions/listSelfHostedRunnersForRepo.md b/docs/actions/listSelfHostedRunnersForRepo.md index 4999d0daa..0b5e58f2a 100644 --- a/docs/actions/listSelfHostedRunnersForRepo.md +++ b/docs/actions/listSelfHostedRunnersForRepo.md @@ -11,7 +11,6 @@ type: API method Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. diff --git a/docs/actions/reRunJobForWorkflowRun.md b/docs/actions/reRunJobForWorkflowRun.md index fe4407ce7..be06aa2b3 100644 --- a/docs/actions/reRunJobForWorkflowRun.md +++ b/docs/actions/reRunJobForWorkflowRun.md @@ -11,7 +11,6 @@ type: API method 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. -If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use this endpoint. ```js diff --git a/docs/actions/removeAllCustomLabelsFromSelfHostedRunnerForRepo.md b/docs/actions/removeAllCustomLabelsFromSelfHostedRunnerForRepo.md index bffc4245d..4eac16911 100644 --- a/docs/actions/removeAllCustomLabelsFromSelfHostedRunnerForRepo.md +++ b/docs/actions/removeAllCustomLabelsFromSelfHostedRunnerForRepo.md @@ -12,7 +12,6 @@ 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. -If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. diff --git a/docs/actions/removeCustomLabelFromSelfHostedRunnerForRepo.md b/docs/actions/removeCustomLabelFromSelfHostedRunnerForRepo.md index 0b41ba67e..964e6e75b 100644 --- a/docs/actions/removeCustomLabelFromSelfHostedRunnerForRepo.md +++ b/docs/actions/removeCustomLabelFromSelfHostedRunnerForRepo.md @@ -15,7 +15,6 @@ 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. -If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. diff --git a/docs/actions/setCustomLabelsForSelfHostedRunnerForRepo.md b/docs/actions/setCustomLabelsForSelfHostedRunnerForRepo.md index 4f313c686..d54edc1c8 100644 --- a/docs/actions/setCustomLabelsForSelfHostedRunnerForRepo.md +++ b/docs/actions/setCustomLabelsForSelfHostedRunnerForRepo.md @@ -12,7 +12,6 @@ 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. -If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. diff --git a/docs/actions/updateEnvironmentVariable.md b/docs/actions/updateEnvironmentVariable.md index 84e0e55ea..a326b5326 100644 --- a/docs/actions/updateEnvironmentVariable.md +++ b/docs/actions/updateEnvironmentVariable.md @@ -11,7 +11,6 @@ type: API method Updates an environment variable that you can reference in a GitHub Actions workflow. You must authenticate using an access token with the `repo` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `environment:write` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. diff --git a/docs/actions/updateRepoVariable.md b/docs/actions/updateRepoVariable.md index 49a0b4211..e72aeca7c 100644 --- a/docs/actions/updateRepoVariable.md +++ b/docs/actions/updateRepoVariable.md @@ -11,7 +11,6 @@ type: API method Updates a repository variable that you can reference in a GitHub Actions workflow. You must authenticate using an access token with the `repo` scope to use this endpoint. -If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. diff --git a/docs/checks/listForRef.md b/docs/checks/listForRef.md index d95f4f953..027329ff4 100644 --- a/docs/checks/listForRef.md +++ b/docs/checks/listForRef.md @@ -8,10 +8,12 @@ type: API method # List check runs for a Git reference -**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. +**Note:** The endpoints to manage checks only look 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. + +If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. + ```js octokit.rest.checks.listForRef({ owner, diff --git a/docs/checks/listForSuite.md b/docs/checks/listForSuite.md index ce2366487..954f236d9 100644 --- a/docs/checks/listForSuite.md +++ b/docs/checks/listForSuite.md @@ -8,10 +8,10 @@ type: API method # List check runs in a check suite -**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. +**Note:** The endpoints to manage checks only look 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. + ```js octokit.rest.checks.listForSuite({ owner, diff --git a/docs/checks/listSuitesForRef.md b/docs/checks/listSuitesForRef.md index 457e62edd..09c920501 100644 --- a/docs/checks/listSuitesForRef.md +++ b/docs/checks/listSuitesForRef.md @@ -8,10 +8,10 @@ type: API method # List check suites for a Git reference -**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. +**Note:** The endpoints to manage checks only look 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`. + ```js octokit.rest.checks.listSuitesForRef({ owner, diff --git a/docs/checks/update.md b/docs/checks/update.md index a080d5e52..e2e2c3979 100644 --- a/docs/checks/update.md +++ b/docs/checks/update.md @@ -8,10 +8,10 @@ type: API method # Update a check run -**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. +**Note:** The endpoints to manage checks only look 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. + ```js octokit.rest.checks.update({ owner, diff --git a/docs/codeScanning/updateDefaultSetup.md b/docs/codeScanning/updateDefaultSetup.md index b5e0da851..cd94ec368 100644 --- a/docs/codeScanning/updateDefaultSetup.md +++ b/docs/codeScanning/updateDefaultSetup.md @@ -53,7 +53,7 @@ CodeQL query suite to be used. languagesno -CodeQL languages to be analyzed. Supported values are: `c-cpp`, `csharp`, `go`, `java-kotlin`, `javascript-typescript`, `python`, `ruby`, and `swift`. +CodeQL languages to be analyzed. diff --git a/docs/codespaces/checkPermissionsForDevcontainer.md b/docs/codespaces/checkPermissionsForDevcontainer.md new file mode 100644 index 000000000..acfd05092 --- /dev/null +++ b/docs/codespaces/checkPermissionsForDevcontainer.md @@ -0,0 +1,60 @@ +--- +name: Check if permissions defined by a devcontainer have been accepted by the authenticated user +example: octokit.rest.codespaces.checkPermissionsForDevcontainer({ owner, repo, ref, devcontainer_path }) +route: GET /repos/{owner}/{repo}/codespaces/permissions_check +scope: codespaces +type: API method +--- + +# Check if permissions defined by a devcontainer have been accepted by the authenticated user + +Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user. + +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.checkPermissionsForDevcontainer({ + owner, + repo, + ref, + devcontainer_path, +}); +``` + +## Parameters + + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository without the `.git` extension. The name is not case sensitive. + +
refyes + +The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically be a branch name (`heads/BRANCH_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + +
devcontainer_pathyes + +Path to the devcontainer.json configuration to use for the permission check. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user). diff --git a/docs/copilot/getCopilotSeatAssignmentDetailsForUser.md b/docs/copilot/getCopilotSeatDetailsForUser.md similarity index 89% rename from docs/copilot/getCopilotSeatAssignmentDetailsForUser.md rename to docs/copilot/getCopilotSeatDetailsForUser.md index 56ca2b90b..1b42d5ac7 100644 --- a/docs/copilot/getCopilotSeatAssignmentDetailsForUser.md +++ b/docs/copilot/getCopilotSeatDetailsForUser.md @@ -1,6 +1,6 @@ --- name: Get Copilot for Business seat assignment details for a user -example: octokit.rest.copilot.getCopilotSeatAssignmentDetailsForUser({ org, username }) +example: octokit.rest.copilot.getCopilotSeatDetailsForUser({ org, username }) route: GET /orgs/{org}/members/{username}/copilot scope: copilot type: API method @@ -15,7 +15,7 @@ Gets the GitHub Copilot for Business seat assignment details for a member of an Organization owners and members with admin permissions can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. ```js -octokit.rest.copilot.getCopilotSeatAssignmentDetailsForUser({ +octokit.rest.copilot.getCopilotSeatDetailsForUser({ org, username, }); diff --git a/docs/migrations/cancelImport.md b/docs/migrations/cancelImport.md index add051909..6a5cb5856 100644 --- a/docs/migrations/cancelImport.md +++ b/docs/migrations/cancelImport.md @@ -8,11 +8,11 @@ type: API method # Cancel an import +**This method is deprecated.** + Stop an import for a repository. -**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end -on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update -these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. +**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). ```js octokit.rest.migrations.cancelImport({ diff --git a/docs/migrations/getCommitAuthors.md b/docs/migrations/getCommitAuthors.md index b4adedead..3f893b0b4 100644 --- a/docs/migrations/getCommitAuthors.md +++ b/docs/migrations/getCommitAuthors.md @@ -8,13 +8,13 @@ type: API method # Get commit authors +**This method is deprecated.** + Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. -**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end -on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update -these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. +**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). ```js octokit.rest.migrations.getCommitAuthors({ diff --git a/docs/migrations/getImportStatus.md b/docs/migrations/getImportStatus.md index b88e4e529..68473d712 100644 --- a/docs/migrations/getImportStatus.md +++ b/docs/migrations/getImportStatus.md @@ -8,11 +8,11 @@ type: API method # Get an import status +**This method is deprecated.** + View the progress of an import. -**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end -on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update -these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. +**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). **Import status** diff --git a/docs/migrations/getLargeFiles.md b/docs/migrations/getLargeFiles.md index ff67fcff2..176358619 100644 --- a/docs/migrations/getLargeFiles.md +++ b/docs/migrations/getLargeFiles.md @@ -8,11 +8,11 @@ type: API method # Get large files +**This method is deprecated.** + List files larger than 100MB found during the import -**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end -on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update -these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. +**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). ```js octokit.rest.migrations.getLargeFiles({ diff --git a/docs/migrations/mapCommitAuthor.md b/docs/migrations/mapCommitAuthor.md index 96da75a8d..095a17822 100644 --- a/docs/migrations/mapCommitAuthor.md +++ b/docs/migrations/mapCommitAuthor.md @@ -8,12 +8,12 @@ type: API method # Map a commit author +**This method is deprecated.** + Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository. -**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end -on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update -these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. +**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). ```js octokit.rest.migrations.mapCommitAuthor({ diff --git a/docs/migrations/setLfsPreference.md b/docs/migrations/setLfsPreference.md index aff7033ef..3f4736795 100644 --- a/docs/migrations/setLfsPreference.md +++ b/docs/migrations/setLfsPreference.md @@ -8,15 +8,15 @@ type: API method # Update Git LFS preference +**This method is deprecated.** + 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.com). You can learn more about our LFS feature and working with large files [on our help site](https://docs.github.com/repositories/working-with-files/managing-large-files). -**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end -on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update -these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. +**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). ```js octokit.rest.migrations.setLfsPreference({ diff --git a/docs/migrations/startForOrg.md b/docs/migrations/startForOrg.md index 9c745edfe..619cefc27 100644 --- a/docs/migrations/startForOrg.md +++ b/docs/migrations/startForOrg.md @@ -75,7 +75,7 @@ Indicates whether this should only include organization metadata (repositories a excludeno -Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`. +Exclude related items from being returned in the response in order to improve performance of the request. diff --git a/docs/migrations/startImport.md b/docs/migrations/startImport.md index 4a72d0d86..12b87d515 100644 --- a/docs/migrations/startImport.md +++ b/docs/migrations/startImport.md @@ -8,8 +8,13 @@ type: API method # Start an import -Start a source import to a GitHub repository using GitHub Importer. Importing into a GitHub repository with GitHub Actions enabled is not supported and will return a status `422 Unprocessable Entity` response. -**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. +**This method is deprecated.** + +Start a source import to a GitHub repository using GitHub Importer. +Importing into a GitHub repository with GitHub Actions enabled is not supported and will +return a status `422 Unprocessable Entity` response. + +**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). ```js octokit.rest.migrations.startImport({ diff --git a/docs/migrations/updateImport.md b/docs/migrations/updateImport.md index 3adf79b60..9b8ec26ca 100644 --- a/docs/migrations/updateImport.md +++ b/docs/migrations/updateImport.md @@ -8,6 +8,8 @@ type: API method # Update an import +**This method is deprecated.** + 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. @@ -15,9 +17,7 @@ Some servers (e.g. TFS servers) can have several projects at a single URL. In th 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. -**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end -on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update -these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. +**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). ```js octokit.rest.migrations.updateImport({ diff --git a/docs/orgs/createOrUpdateCustomProperties.md b/docs/orgs/createOrUpdateCustomProperties.md new file mode 100644 index 000000000..a604c7f82 --- /dev/null +++ b/docs/orgs/createOrUpdateCustomProperties.md @@ -0,0 +1,77 @@ +--- +name: Create or update custom properties for an organization +example: octokit.rest.orgs.createOrUpdateCustomProperties({ org, properties, properties[].property_name, properties[].value_type }) +route: PATCH /orgs/{org}/properties/schema +scope: orgs +type: API method +--- + +# Create or update custom properties for an organization + +Creates new or updates existing custom properties defined for an organization in a batch. +Only organization owners (or users with the proper permissions granted by them) can update these properties + +```js +octokit.rest.orgs.createOrUpdateCustomProperties({ + org, +properties, +properties[].property_name, +properties[].value_type + }) +``` + +## Parameters + + + + + + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
propertiesyes + +The array of custom properties to create or update. + +
properties[].property_nameyes + +The name of the property + +
properties[].value_typeyes + +The type of the value for the property + +
properties[].requiredno + +Whether the property is required. + +
properties[].default_valueno + +Default value of the property + +
properties[].descriptionno + +Short description of the property + +
properties[].allowed_valuesno + +Ordered list of allowed values of the property + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/properties#create-or-update-custom-properties-for-an-organization). diff --git a/docs/orgs/createOrUpdateCustomPropertiesValuesForRepos.md b/docs/orgs/createOrUpdateCustomPropertiesValuesForRepos.md new file mode 100644 index 000000000..aba91ce37 --- /dev/null +++ b/docs/orgs/createOrUpdateCustomPropertiesValuesForRepos.md @@ -0,0 +1,69 @@ +--- +name: Create or update custom property values for organization repositories +example: octokit.rest.orgs.createOrUpdateCustomPropertiesValuesForRepos({ org, repository_names, properties, properties[].property_name, properties[].value }) +route: PATCH /orgs/{org}/properties/values +scope: orgs +type: API method +--- + +# Create or update custom property values for organization repositories + +Create new or update existing custom property values for repositories in a batch that belong to an organization. +Each target repository will have its custom property values updated to match the values provided in the request. + +A maximum of 30 repositories can be updated in a single request. + +Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + +Only organization owners (or users with the proper permissions granted by them) can update these properties + +```js +octokit.rest.orgs.createOrUpdateCustomPropertiesValuesForRepos({ + org, +repository_names, +properties, +properties[].property_name, +properties[].value + }) +``` + +## Parameters + + + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
repository_namesyes + +The names of repositories that the custom property values will be applied to. + +
propertiesyes + +List of custom property names and associated values to apply to the repositories. + +
properties[].property_nameyes + +The name of the property + +
properties[].valueyes + +The value assigned to the property + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/properties#create-or-update-custom-property-values-for-organization-repositories). diff --git a/docs/orgs/createOrUpdateCustomProperty.md b/docs/orgs/createOrUpdateCustomProperty.md new file mode 100644 index 000000000..bf5044c62 --- /dev/null +++ b/docs/orgs/createOrUpdateCustomProperty.md @@ -0,0 +1,71 @@ +--- +name: Create or update a custom property for an organization +example: octokit.rest.orgs.createOrUpdateCustomProperty({ org, custom_property_name, value_type }) +route: PUT /orgs/{org}/properties/schema/{custom_property_name} +scope: orgs +type: API method +--- + +# Create or update a custom property for an organization + +Creates a new or updates an existing custom property that is defined for an organization. +You must be an organization owner to use this endpoint. + +```js +octokit.rest.orgs.createOrUpdateCustomProperty({ + org, + custom_property_name, + value_type, +}); +``` + +## Parameters + + + + + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
custom_property_nameyes + +The custom property name. The name is case sensitive. + +
value_typeyes + +The type of the value for the property + +
requiredno + +Whether the property is required. + +
default_valueno + +Default value of the property + +
descriptionno + +Short description of the property + +
allowed_valuesno + +Ordered list of allowed values of the property + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/properties#create-or-update-a-custom-property-for-an-organization). diff --git a/docs/orgs/deleteWebhook.md b/docs/orgs/deleteWebhook.md index 5f9be7584..c56aed367 100644 --- a/docs/orgs/deleteWebhook.md +++ b/docs/orgs/deleteWebhook.md @@ -33,7 +33,7 @@ The organization name. The name is not case sensitive. hook_idyes -The unique identifier of the hook. +The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. diff --git a/docs/orgs/getAllCustomProperties.md b/docs/orgs/getAllCustomProperties.md new file mode 100644 index 000000000..1fbf36578 --- /dev/null +++ b/docs/orgs/getAllCustomProperties.md @@ -0,0 +1,39 @@ +--- +name: Get all custom properties for an organization +example: octokit.rest.orgs.getAllCustomProperties({ org }) +route: GET /orgs/{org}/properties/schema +scope: orgs +type: API method +--- + +# Get all custom properties for an organization + +Gets all custom properties defined for an organization. +You must be an organization owner to use this endpoint. + +```js +octokit.rest.orgs.getAllCustomProperties({ + org, +}); +``` + +## Parameters + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/properties#get-all-custom-properties-for-an-organization). diff --git a/docs/orgs/getCustomProperty.md b/docs/orgs/getCustomProperty.md new file mode 100644 index 000000000..ff3783fdb --- /dev/null +++ b/docs/orgs/getCustomProperty.md @@ -0,0 +1,45 @@ +--- +name: Get a custom property for an organization +example: octokit.rest.orgs.getCustomProperty({ org, custom_property_name }) +route: GET /orgs/{org}/properties/schema/{custom_property_name} +scope: orgs +type: API method +--- + +# Get a custom property for an organization + +Gets a custom property that is defined for an organization. +You must be an organization owner to use this endpoint. + +```js +octokit.rest.orgs.getCustomProperty({ + org, + custom_property_name, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
custom_property_nameyes + +The custom property name. The name is case sensitive. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/properties#get-a-custom-property-for-an-organization). diff --git a/docs/orgs/getWebhook.md b/docs/orgs/getWebhook.md index bdb7d469d..0336facf5 100644 --- a/docs/orgs/getWebhook.md +++ b/docs/orgs/getWebhook.md @@ -35,7 +35,7 @@ The organization name. The name is not case sensitive. hook_idyes -The unique identifier of the hook. +The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. diff --git a/docs/orgs/getWebhookConfigForOrg.md b/docs/orgs/getWebhookConfigForOrg.md index 859fd4870..f1907d8b7 100644 --- a/docs/orgs/getWebhookConfigForOrg.md +++ b/docs/orgs/getWebhookConfigForOrg.md @@ -37,7 +37,7 @@ The organization name. The name is not case sensitive. hook_idyes -The unique identifier of the hook. +The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. diff --git a/docs/orgs/getWebhookDelivery.md b/docs/orgs/getWebhookDelivery.md index c04a69cfe..f121ee110 100644 --- a/docs/orgs/getWebhookDelivery.md +++ b/docs/orgs/getWebhookDelivery.md @@ -36,7 +36,7 @@ The organization name. The name is not case sensitive. hook_idyes -The unique identifier of the hook. +The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. delivery_idyes diff --git a/docs/orgs/listCustomPropertiesValuesForRepos.md b/docs/orgs/listCustomPropertiesValuesForRepos.md new file mode 100644 index 000000000..c4297bd6a --- /dev/null +++ b/docs/orgs/listCustomPropertiesValuesForRepos.md @@ -0,0 +1,49 @@ +--- +name: List custom property values for organization repositories +example: octokit.rest.orgs.listCustomPropertiesValuesForRepos({ org }) +route: GET /orgs/{org}/properties/values +scope: orgs +type: API method +--- + +# List custom property values for organization repositories + +Lists organization repositories with all of their custom property values. +Organization members can read these properties. + +```js +octokit.rest.orgs.listCustomPropertiesValuesForRepos({ + 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/orgs/properties#list-custom-property-values-for-organization-repositories). diff --git a/docs/orgs/listWebhookDeliveries.md b/docs/orgs/listWebhookDeliveries.md index 217f7ac22..9c93aba5c 100644 --- a/docs/orgs/listWebhookDeliveries.md +++ b/docs/orgs/listWebhookDeliveries.md @@ -35,7 +35,7 @@ The organization name. The name is not case sensitive. hook_idyes -The unique identifier of the hook. +The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. per_pageno diff --git a/docs/orgs/pingWebhook.md b/docs/orgs/pingWebhook.md index 7794d63ec..e8b2bfd7c 100644 --- a/docs/orgs/pingWebhook.md +++ b/docs/orgs/pingWebhook.md @@ -35,7 +35,7 @@ The organization name. The name is not case sensitive. hook_idyes -The unique identifier of the hook. +The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. diff --git a/docs/orgs/redeliverWebhookDelivery.md b/docs/orgs/redeliverWebhookDelivery.md index 69b410810..e3e0daac6 100644 --- a/docs/orgs/redeliverWebhookDelivery.md +++ b/docs/orgs/redeliverWebhookDelivery.md @@ -36,7 +36,7 @@ The organization name. The name is not case sensitive. hook_idyes -The unique identifier of the hook. +The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. delivery_idyes diff --git a/docs/orgs/removeCustomProperty.md b/docs/orgs/removeCustomProperty.md new file mode 100644 index 000000000..b3a131bfe --- /dev/null +++ b/docs/orgs/removeCustomProperty.md @@ -0,0 +1,45 @@ +--- +name: Remove a custom property for an organization +example: octokit.rest.orgs.removeCustomProperty({ org, custom_property_name }) +route: DELETE /orgs/{org}/properties/schema/{custom_property_name} +scope: orgs +type: API method +--- + +# Remove a custom property for an organization + +Removes a custom property that is defined for an organization. +You must be an organization owner to use this endpoint. + +```js +octokit.rest.orgs.removeCustomProperty({ + org, + custom_property_name, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
custom_property_nameyes + +The custom property name. The name is case sensitive. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/properties#remove-a-custom-property-for-an-organization). diff --git a/docs/orgs/updateWebhook.md b/docs/orgs/updateWebhook.md index 6b966400c..bde099155 100644 --- a/docs/orgs/updateWebhook.md +++ b/docs/orgs/updateWebhook.md @@ -36,7 +36,7 @@ The organization name. The name is not case sensitive. hook_idyes -The unique identifier of the hook. +The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. configno diff --git a/docs/orgs/updateWebhookConfigForOrg.md b/docs/orgs/updateWebhookConfigForOrg.md index ad8099f72..a6163290d 100644 --- a/docs/orgs/updateWebhookConfigForOrg.md +++ b/docs/orgs/updateWebhookConfigForOrg.md @@ -37,7 +37,7 @@ The organization name. The name is not case sensitive. hook_idyes -The unique identifier of the hook. +The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. urlno diff --git a/docs/reactions/listForPullRequestReviewComment.md b/docs/reactions/listForPullRequestReviewComment.md index 1a7f3d95f..a38feacbd 100644 --- a/docs/reactions/listForPullRequestReviewComment.md +++ b/docs/reactions/listForPullRequestReviewComment.md @@ -8,7 +8,7 @@ type: API method # List reactions for a pull request review comment -List the reactions to a [pull request review comment](https://docs.github.com/pulls/comments#get-a-review-comment-for-a-pull-request). +List the reactions to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). ```js octokit.rest.reactions.listForPullRequestReviewComment({ diff --git a/docs/repos/createDeploymentBranchPolicy.md b/docs/repos/createDeploymentBranchPolicy.md index d016cb045..eb91c2d62 100644 --- a/docs/repos/createDeploymentBranchPolicy.md +++ b/docs/repos/createDeploymentBranchPolicy.md @@ -8,7 +8,7 @@ type: API method # Create a deployment branch policy -Creates a deployment branch policy for an environment. +Creates a deployment branch or tag policy for an environment. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. @@ -49,11 +49,16 @@ The name of the environment. nameyes -The name pattern that branches must match in order to deploy to the environment. +The name pattern that branches or tags must match in order to deploy to the environment. Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`. For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). + +typeno + +Whether this rule targets a branch or tag + diff --git a/docs/repos/createOrUpdateEnvironment.md b/docs/repos/createOrUpdateEnvironment.md index 4120c751d..0ce752014 100644 --- a/docs/repos/createOrUpdateEnvironment.md +++ b/docs/repos/createOrUpdateEnvironment.md @@ -56,6 +56,11 @@ The name of the environment. The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days). + +prevent_self_reviewno + +Whether or not a user who created the job is prevented from approving their own job. + reviewersno diff --git a/docs/repos/createOrgRuleset.md b/docs/repos/createOrgRuleset.md index eaff17362..f4aeea597 100644 --- a/docs/repos/createOrgRuleset.md +++ b/docs/repos/createOrgRuleset.md @@ -1,6 +1,6 @@ --- name: Create an organization repository ruleset -example: octokit.rest.repos.createOrgRuleset({ org, name, enforcement, bypass_actors[].actor_id, bypass_actors[].actor_type, bypass_actors[].bypass_mode, rules[].type, rules[].parameters.update_allows_fetch_and_merge, rules[].parameters.required_deployment_environments, rules[].parameters.dismiss_stale_reviews_on_push, rules[].parameters.require_code_owner_review, rules[].parameters.require_last_push_approval, rules[].parameters.required_approving_review_count, rules[].parameters.required_review_thread_resolution, rules[].parameters.required_status_checks, rules[].parameters.required_status_checks[].context, rules[].parameters.strict_required_status_checks_policy, rules[].parameters.operator, rules[].parameters.pattern }) +example: octokit.rest.repos.createOrgRuleset({ org, name, enforcement, bypass_actors[].actor_id, bypass_actors[].actor_type, bypass_actors[].bypass_mode, rules[].type, rules[].parameters.update_allows_fetch_and_merge, rules[].parameters.required_deployment_environments, rules[].parameters.dismiss_stale_reviews_on_push, rules[].parameters.require_code_owner_review, rules[].parameters.require_last_push_approval, rules[].parameters.required_approving_review_count, rules[].parameters.required_review_thread_resolution, rules[].parameters.required_status_checks, rules[].parameters.required_status_checks[].context, rules[].parameters.strict_required_status_checks_policy, rules[].parameters.operator, rules[].parameters.pattern, rules[].parameters.workflows, rules[].parameters.workflows[].path, rules[].parameters.workflows[].repository_id }) route: POST /orgs/{org}/rulesets scope: repos type: API method @@ -30,7 +30,10 @@ rules[].parameters.required_status_checks, rules[].parameters.required_status_checks[].context, rules[].parameters.strict_required_status_checks_policy, rules[].parameters.operator, -rules[].parameters.pattern +rules[].parameters.pattern, +rules[].parameters.workflows, +rules[].parameters.workflows[].path, +rules[].parameters.workflows[].repository_id }) ``` @@ -72,7 +75,7 @@ The actors that can bypass the rules in this ruleset bypass_actors[].actor_idyes -The ID of the actor that can bypass a ruleset +The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. bypass_actors[].actor_typeyes @@ -175,6 +178,31 @@ The operator to use for matching. The pattern to match with. + +rules[].parameters.workflowsyes + +Workflows that must pass for this rule to pass. + + +rules[].parameters.workflows[].pathyes + +The path to the workflow file + + +rules[].parameters.workflows[].refno + +The ref (branch or tag) of the workflow file to use + + +rules[].parameters.workflows[].repository_idyes + +The ID of the repository where the workflow is defined + + +rules[].parameters.workflows[].shano + +The commit SHA of the workflow file to use + diff --git a/docs/repos/createRepoRuleset.md b/docs/repos/createRepoRuleset.md index f8779551c..539b13ac4 100644 --- a/docs/repos/createRepoRuleset.md +++ b/docs/repos/createRepoRuleset.md @@ -1,6 +1,6 @@ --- name: Create a repository ruleset -example: octokit.rest.repos.createRepoRuleset({ owner, repo, name, enforcement, bypass_actors[].actor_id, bypass_actors[].actor_type, bypass_actors[].bypass_mode, rules[].type, rules[].parameters.update_allows_fetch_and_merge, rules[].parameters.required_deployment_environments, rules[].parameters.dismiss_stale_reviews_on_push, rules[].parameters.require_code_owner_review, rules[].parameters.require_last_push_approval, rules[].parameters.required_approving_review_count, rules[].parameters.required_review_thread_resolution, rules[].parameters.required_status_checks, rules[].parameters.required_status_checks[].context, rules[].parameters.strict_required_status_checks_policy, rules[].parameters.operator, rules[].parameters.pattern }) +example: octokit.rest.repos.createRepoRuleset({ owner, repo, name, enforcement, bypass_actors[].actor_id, bypass_actors[].actor_type, bypass_actors[].bypass_mode, rules[].type, rules[].parameters.update_allows_fetch_and_merge, rules[].parameters.required_deployment_environments, rules[].parameters.dismiss_stale_reviews_on_push, rules[].parameters.require_code_owner_review, rules[].parameters.require_last_push_approval, rules[].parameters.required_approving_review_count, rules[].parameters.required_review_thread_resolution, rules[].parameters.required_status_checks, rules[].parameters.required_status_checks[].context, rules[].parameters.strict_required_status_checks_policy, rules[].parameters.operator, rules[].parameters.pattern, rules[].parameters.workflows, rules[].parameters.workflows[].path, rules[].parameters.workflows[].repository_id }) route: POST /repos/{owner}/{repo}/rulesets scope: repos type: API method @@ -31,7 +31,10 @@ rules[].parameters.required_status_checks, rules[].parameters.required_status_checks[].context, rules[].parameters.strict_required_status_checks_policy, rules[].parameters.operator, -rules[].parameters.pattern +rules[].parameters.pattern, +rules[].parameters.workflows, +rules[].parameters.workflows[].path, +rules[].parameters.workflows[].repository_id }) ``` @@ -78,7 +81,7 @@ The actors that can bypass the rules in this ruleset bypass_actors[].actor_idyes -The ID of the actor that can bypass a ruleset +The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. bypass_actors[].actor_typeyes @@ -194,6 +197,31 @@ The operator to use for matching. The pattern to match with. + +rules[].parameters.workflowsyes + +Workflows that must pass for this rule to pass. + + +rules[].parameters.workflows[].pathyes + +The path to the workflow file + + +rules[].parameters.workflows[].refno + +The ref (branch or tag) of the workflow file to use + + +rules[].parameters.workflows[].repository_idyes + +The ID of the repository where the workflow is defined + + +rules[].parameters.workflows[].shano + +The commit SHA of the workflow file to use + diff --git a/docs/repos/deleteDeploymentBranchPolicy.md b/docs/repos/deleteDeploymentBranchPolicy.md index a7c7eae89..4b60a6de4 100644 --- a/docs/repos/deleteDeploymentBranchPolicy.md +++ b/docs/repos/deleteDeploymentBranchPolicy.md @@ -8,7 +8,7 @@ type: API method # Delete a deployment branch policy -Deletes a deployment branch policy for an environment. +Deletes a deployment branch or tag policy for an environment. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. diff --git a/docs/repos/deleteWebhook.md b/docs/repos/deleteWebhook.md index 9aa663568..399a0a6a5 100644 --- a/docs/repos/deleteWebhook.md +++ b/docs/repos/deleteWebhook.md @@ -39,7 +39,7 @@ The name of the repository without the `.git` extension. The name is not case se hook_idyes -The unique identifier of the hook. +The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. diff --git a/docs/repos/getCommunityProfileMetrics.md b/docs/repos/getCommunityProfileMetrics.md index 40ef4ad8d..bc0299e22 100644 --- a/docs/repos/getCommunityProfileMetrics.md +++ b/docs/repos/getCommunityProfileMetrics.md @@ -15,10 +15,8 @@ detected code of conduct, the detected license, and the presence of ISSUE_TEMPLA README, and CONTRIBUTING files. The `health_percentage` score is defined as a percentage of how many of -these four documents are present: README, CONTRIBUTING, LICENSE, and -CODE_OF_CONDUCT. For example, if all four documents are present, then -the `health_percentage` is `100`. If only one is present, then the -`health_percentage` is `25`. +the recommended community health files are present. For more information, see +"[About community profiles for public repositories](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)." `content_reports_enabled` is only returned for organization-owned repositories. diff --git a/docs/repos/getCustomPropertiesValues.md b/docs/repos/getCustomPropertiesValues.md new file mode 100644 index 000000000..2b483ddc8 --- /dev/null +++ b/docs/repos/getCustomPropertiesValues.md @@ -0,0 +1,45 @@ +--- +name: Get all custom property values for a repository +example: octokit.rest.repos.getCustomPropertiesValues({ owner, repo }) +route: GET /repos/{owner}/{repo}/properties/values +scope: repos +type: API method +--- + +# Get all custom property values for a repository + +Gets all custom property values that are set for a repository. +Users with admin access to the repository can use this endpoint. + +```js +octokit.rest.repos.getCustomPropertiesValues({ + owner, + repo, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository without the `.git` extension. The name is not case sensitive. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/properties#get-all-custom-property-values-for-a-repository). diff --git a/docs/repos/getDeploymentBranchPolicy.md b/docs/repos/getDeploymentBranchPolicy.md index 9f9e6104d..80dbf48ae 100644 --- a/docs/repos/getDeploymentBranchPolicy.md +++ b/docs/repos/getDeploymentBranchPolicy.md @@ -8,7 +8,7 @@ type: API method # Get a deployment branch policy -Gets a deployment branch policy for an environment. +Gets a deployment branch or tag policy for an environment. 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. diff --git a/docs/repos/getOrgRuleSuite.md b/docs/repos/getOrgRuleSuite.md new file mode 100644 index 000000000..a7ffcfeb9 --- /dev/null +++ b/docs/repos/getOrgRuleSuite.md @@ -0,0 +1,48 @@ +--- +name: Get an organization rule suite +example: octokit.rest.repos.getOrgRuleSuite({ org, rule_suite_id }) +route: GET /orgs/{org}/rulesets/rule-suites/{rule_suite_id} +scope: repos +type: API method +--- + +# Get an organization rule suite + +Gets information about a suite of rule evaluations from within an organization. +For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." + +```js +octokit.rest.repos.getOrgRuleSuite({ + org, + rule_suite_id, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
rule_suite_idyes + +The unique identifier of the rule suite result. +To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites) +for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites) +for organizations. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite). diff --git a/docs/repos/getOrgRuleSuites.md b/docs/repos/getOrgRuleSuites.md new file mode 100644 index 000000000..0d4c5ff97 --- /dev/null +++ b/docs/repos/getOrgRuleSuites.md @@ -0,0 +1,71 @@ +--- +name: List organization rule suites +example: octokit.rest.repos.getOrgRuleSuites({ org }) +route: GET /orgs/{org}/rulesets/rule-suites +scope: repos +type: API method +--- + +# List organization rule suites + +Lists suites of rule evaluations at the organization level. +For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." + +```js +octokit.rest.repos.getOrgRuleSuites({ + org, +}); +``` + +## Parameters + + + + + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
repository_nameno + +The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. + +
time_periodno + +The time period to filter by. + +For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). + +
actor_nameno + +The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. + +
rule_suite_resultno + +The rule results to filter on. When specified, only suites with this result will be returned. + +
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/orgs/rule-suites#list-organization-rule-suites). diff --git a/docs/repos/getRepoRuleSuite.md b/docs/repos/getRepoRuleSuite.md new file mode 100644 index 000000000..d104986eb --- /dev/null +++ b/docs/repos/getRepoRuleSuite.md @@ -0,0 +1,54 @@ +--- +name: Get a repository rule suite +example: octokit.rest.repos.getRepoRuleSuite({ owner, repo, rule_suite_id }) +route: GET /repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id} +scope: repos +type: API method +--- + +# Get a repository rule suite + +Gets information about a suite of rule evaluations from within a repository. +For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." + +```js +octokit.rest.repos.getRepoRuleSuite({ + owner, + repo, + rule_suite_id, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository without the `.git` extension. The name is not case sensitive. + +
rule_suite_idyes + +The unique identifier of the rule suite result. +To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites) +for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites) +for organizations. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite). diff --git a/docs/repos/getRepoRuleSuites.md b/docs/repos/getRepoRuleSuites.md new file mode 100644 index 000000000..aeeda89cc --- /dev/null +++ b/docs/repos/getRepoRuleSuites.md @@ -0,0 +1,77 @@ +--- +name: List repository rule suites +example: octokit.rest.repos.getRepoRuleSuites({ owner, repo }) +route: GET /repos/{owner}/{repo}/rulesets/rule-suites +scope: repos +type: API method +--- + +# List repository rule suites + +Lists suites of rule evaluations at the repository level. +For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." + +```js +octokit.rest.repos.getRepoRuleSuites({ + owner, + repo, +}); +``` + +## Parameters + + + + + + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository without the `.git` extension. The name is not case sensitive. + +
refno + +The name of the ref. Cannot contain wildcard characters. When specified, only rule evaluations triggered for this ref will be returned. + +
time_periodno + +The time period to filter by. + +For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). + +
actor_nameno + +The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. + +
rule_suite_resultno + +The rule results to filter on. When specified, only suites with this result will be returned. + +
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/repos/rule-suites#list-repository-rule-suites). diff --git a/docs/repos/getWebhook.md b/docs/repos/getWebhook.md index f3ea7b1ce..00507beb1 100644 --- a/docs/repos/getWebhook.md +++ b/docs/repos/getWebhook.md @@ -41,7 +41,7 @@ The name of the repository without the `.git` extension. The name is not case se hook_idyes -The unique identifier of the hook. +The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. diff --git a/docs/repos/getWebhookConfigForRepo.md b/docs/repos/getWebhookConfigForRepo.md index f976ab858..f6b727c4d 100644 --- a/docs/repos/getWebhookConfigForRepo.md +++ b/docs/repos/getWebhookConfigForRepo.md @@ -43,7 +43,7 @@ The name of the repository without the `.git` extension. The name is not case se hook_idyes -The unique identifier of the hook. +The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. diff --git a/docs/repos/getWebhookDelivery.md b/docs/repos/getWebhookDelivery.md index ef0099b60..e416d0fc3 100644 --- a/docs/repos/getWebhookDelivery.md +++ b/docs/repos/getWebhookDelivery.md @@ -42,7 +42,7 @@ The name of the repository without the `.git` extension. The name is not case se hook_idyes -The unique identifier of the hook. +The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. delivery_idyes diff --git a/docs/repos/listActivities.md b/docs/repos/listActivities.md index 7289a2a66..66a19fbfa 100644 --- a/docs/repos/listActivities.md +++ b/docs/repos/listActivities.md @@ -11,7 +11,7 @@ type: API method Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users. For more information about viewing repository activity, -see "[Viewing repository activity](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/viewing-repository-activity)." +see "[Viewing activity and data for your repository](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository)." ```js octokit.rest.repos.listActivities({ diff --git a/docs/repos/listWebhookDeliveries.md b/docs/repos/listWebhookDeliveries.md index d028505bd..b890be834 100644 --- a/docs/repos/listWebhookDeliveries.md +++ b/docs/repos/listWebhookDeliveries.md @@ -41,7 +41,7 @@ The name of the repository without the `.git` extension. The name is not case se hook_idyes -The unique identifier of the hook. +The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. per_pageno diff --git a/docs/repos/pingWebhook.md b/docs/repos/pingWebhook.md index eba78b9dc..5319ee50b 100644 --- a/docs/repos/pingWebhook.md +++ b/docs/repos/pingWebhook.md @@ -41,7 +41,7 @@ The name of the repository without the `.git` extension. The name is not case se hook_idyes -The unique identifier of the hook. +The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. diff --git a/docs/repos/redeliverWebhookDelivery.md b/docs/repos/redeliverWebhookDelivery.md index 04cacfa04..dc292b9c5 100644 --- a/docs/repos/redeliverWebhookDelivery.md +++ b/docs/repos/redeliverWebhookDelivery.md @@ -42,7 +42,7 @@ The name of the repository without the `.git` extension. The name is not case se hook_idyes -The unique identifier of the hook. +The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. delivery_idyes diff --git a/docs/repos/testPushWebhook.md b/docs/repos/testPushWebhook.md index 54eaf1ce4..0d052a431 100644 --- a/docs/repos/testPushWebhook.md +++ b/docs/repos/testPushWebhook.md @@ -43,7 +43,7 @@ The name of the repository without the `.git` extension. The name is not case se hook_idyes -The unique identifier of the hook. +The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. diff --git a/docs/repos/updateDeploymentBranchPolicy.md b/docs/repos/updateDeploymentBranchPolicy.md index c5a8096af..9752a066c 100644 --- a/docs/repos/updateDeploymentBranchPolicy.md +++ b/docs/repos/updateDeploymentBranchPolicy.md @@ -8,7 +8,7 @@ type: API method # Update a deployment branch policy -Updates a deployment branch policy for an environment. +Updates a deployment branch or tag policy for an environment. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. diff --git a/docs/repos/updateOrgRuleset.md b/docs/repos/updateOrgRuleset.md index 8272b9838..cddc3f6cd 100644 --- a/docs/repos/updateOrgRuleset.md +++ b/docs/repos/updateOrgRuleset.md @@ -1,6 +1,6 @@ --- name: Update an organization repository ruleset -example: octokit.rest.repos.updateOrgRuleset({ org, ruleset_id, bypass_actors[].actor_id, bypass_actors[].actor_type, bypass_actors[].bypass_mode, rules[].type, rules[].parameters.update_allows_fetch_and_merge, rules[].parameters.required_deployment_environments, rules[].parameters.dismiss_stale_reviews_on_push, rules[].parameters.require_code_owner_review, rules[].parameters.require_last_push_approval, rules[].parameters.required_approving_review_count, rules[].parameters.required_review_thread_resolution, rules[].parameters.required_status_checks, rules[].parameters.required_status_checks[].context, rules[].parameters.strict_required_status_checks_policy, rules[].parameters.operator, rules[].parameters.pattern }) +example: octokit.rest.repos.updateOrgRuleset({ org, ruleset_id, bypass_actors[].actor_id, bypass_actors[].actor_type, bypass_actors[].bypass_mode, rules[].type, rules[].parameters.update_allows_fetch_and_merge, rules[].parameters.required_deployment_environments, rules[].parameters.dismiss_stale_reviews_on_push, rules[].parameters.require_code_owner_review, rules[].parameters.require_last_push_approval, rules[].parameters.required_approving_review_count, rules[].parameters.required_review_thread_resolution, rules[].parameters.required_status_checks, rules[].parameters.required_status_checks[].context, rules[].parameters.strict_required_status_checks_policy, rules[].parameters.operator, rules[].parameters.pattern, rules[].parameters.workflows, rules[].parameters.workflows[].path, rules[].parameters.workflows[].repository_id }) route: PUT /orgs/{org}/rulesets/{ruleset_id} scope: repos type: API method @@ -29,7 +29,10 @@ rules[].parameters.required_status_checks, rules[].parameters.required_status_checks[].context, rules[].parameters.strict_required_status_checks_policy, rules[].parameters.operator, -rules[].parameters.pattern +rules[].parameters.pattern, +rules[].parameters.workflows, +rules[].parameters.workflows[].path, +rules[].parameters.workflows[].repository_id }) ``` @@ -76,7 +79,7 @@ The actors that can bypass the rules in this ruleset bypass_actors[].actor_idyes -The ID of the actor that can bypass a ruleset +The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. bypass_actors[].actor_typeyes @@ -179,6 +182,31 @@ The operator to use for matching. The pattern to match with. + +rules[].parameters.workflowsyes + +Workflows that must pass for this rule to pass. + + +rules[].parameters.workflows[].pathyes + +The path to the workflow file + + +rules[].parameters.workflows[].refno + +The ref (branch or tag) of the workflow file to use + + +rules[].parameters.workflows[].repository_idyes + +The ID of the repository where the workflow is defined + + +rules[].parameters.workflows[].shano + +The commit SHA of the workflow file to use + diff --git a/docs/repos/updateRepoRuleset.md b/docs/repos/updateRepoRuleset.md index 8de9b887e..f25dda192 100644 --- a/docs/repos/updateRepoRuleset.md +++ b/docs/repos/updateRepoRuleset.md @@ -1,6 +1,6 @@ --- name: Update a repository ruleset -example: octokit.rest.repos.updateRepoRuleset({ owner, repo, ruleset_id, bypass_actors[].actor_id, bypass_actors[].actor_type, bypass_actors[].bypass_mode, rules[].type, rules[].parameters.update_allows_fetch_and_merge, rules[].parameters.required_deployment_environments, rules[].parameters.dismiss_stale_reviews_on_push, rules[].parameters.require_code_owner_review, rules[].parameters.require_last_push_approval, rules[].parameters.required_approving_review_count, rules[].parameters.required_review_thread_resolution, rules[].parameters.required_status_checks, rules[].parameters.required_status_checks[].context, rules[].parameters.strict_required_status_checks_policy, rules[].parameters.operator, rules[].parameters.pattern }) +example: octokit.rest.repos.updateRepoRuleset({ owner, repo, ruleset_id, bypass_actors[].actor_id, bypass_actors[].actor_type, bypass_actors[].bypass_mode, rules[].type, rules[].parameters.update_allows_fetch_and_merge, rules[].parameters.required_deployment_environments, rules[].parameters.dismiss_stale_reviews_on_push, rules[].parameters.require_code_owner_review, rules[].parameters.require_last_push_approval, rules[].parameters.required_approving_review_count, rules[].parameters.required_review_thread_resolution, rules[].parameters.required_status_checks, rules[].parameters.required_status_checks[].context, rules[].parameters.strict_required_status_checks_policy, rules[].parameters.operator, rules[].parameters.pattern, rules[].parameters.workflows, rules[].parameters.workflows[].path, rules[].parameters.workflows[].repository_id }) route: PUT /repos/{owner}/{repo}/rulesets/{ruleset_id} scope: repos type: API method @@ -30,7 +30,10 @@ rules[].parameters.required_status_checks, rules[].parameters.required_status_checks[].context, rules[].parameters.strict_required_status_checks_policy, rules[].parameters.operator, -rules[].parameters.pattern +rules[].parameters.pattern, +rules[].parameters.workflows, +rules[].parameters.workflows[].path, +rules[].parameters.workflows[].repository_id }) ``` @@ -82,7 +85,7 @@ The actors that can bypass the rules in this ruleset bypass_actors[].actor_idyes -The ID of the actor that can bypass a ruleset +The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. bypass_actors[].actor_typeyes @@ -198,6 +201,31 @@ The operator to use for matching. The pattern to match with. + +rules[].parameters.workflowsyes + +Workflows that must pass for this rule to pass. + + +rules[].parameters.workflows[].pathyes + +The path to the workflow file + + +rules[].parameters.workflows[].refno + +The ref (branch or tag) of the workflow file to use + + +rules[].parameters.workflows[].repository_idyes + +The ID of the repository where the workflow is defined + + +rules[].parameters.workflows[].shano + +The commit SHA of the workflow file to use + diff --git a/docs/repos/updateWebhook.md b/docs/repos/updateWebhook.md index 54a8df5ba..8e4db07b7 100644 --- a/docs/repos/updateWebhook.md +++ b/docs/repos/updateWebhook.md @@ -42,7 +42,7 @@ The name of the repository without the `.git` extension. The name is not case se hook_idyes -The unique identifier of the hook. +The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. configno diff --git a/docs/repos/updateWebhookConfigForRepo.md b/docs/repos/updateWebhookConfigForRepo.md index d1c0c0894..eb1535526 100644 --- a/docs/repos/updateWebhookConfigForRepo.md +++ b/docs/repos/updateWebhookConfigForRepo.md @@ -43,7 +43,7 @@ The name of the repository without the `.git` extension. The name is not case se hook_idyes -The unique identifier of the hook. +The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. urlno diff --git a/package-lock.json b/package-lock.json index aadc6d5cc..408abfe93 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,7 +9,7 @@ "version": "0.0.0-development", "license": "MIT", "dependencies": { - "@octokit/types": "^12.0.0" + "@octokit/types": "^12.1.0" }, "devDependencies": { "@octokit/core": "^5.0.0", @@ -1590,9 +1590,9 @@ } }, "node_modules/@octokit/openapi-types": { - "version": "19.0.0", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-19.0.0.tgz", - "integrity": "sha512-PclQ6JGMTE9iUStpzMkwLCISFn/wDeRjkZFIKALpvJQNBGwDoYYi2fFvuHwssoQ1rXI5mfh6jgTgWuddeUzfWw==" + "version": "19.0.1", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-19.0.1.tgz", + "integrity": "sha512-zC+73r2HIoRb9rWW5S3Y759hrpadlD5pNnya/QfZv0JZE7mvMu+FUa7nxHqTadi2hZc4BPZjJ8veDTuJnh8+8g==" }, "node_modules/@octokit/request": { "version": "8.0.4", @@ -1660,11 +1660,11 @@ "license": "MIT" }, "node_modules/@octokit/types": { - "version": "12.0.0", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-12.0.0.tgz", - "integrity": "sha512-EzD434aHTFifGudYAygnFlS1Tl6KhbTynEWELQXIbTY8Msvb5nEqTZIm7sbPEt4mQYLZwu3zPKVdeIrw0g7ovg==", + "version": "12.1.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-12.1.0.tgz", + "integrity": "sha512-JmjQr5ZbOnpnOLX5drI2O2I1N9suOYZAgINHXTlVVg4lRtUifMv2JssT+RhmNxQwXH153Pc8HaCMdTRkqI1oVQ==", "dependencies": { - "@octokit/openapi-types": "^19.0.0" + "@octokit/openapi-types": "^19.0.1" } }, "node_modules/@pkgjs/parseargs": { diff --git a/package.json b/package.json index a2ff48e8c..8fe998d19 100644 --- a/package.json +++ b/package.json @@ -24,7 +24,7 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "dependencies": { - "@octokit/types": "^12.0.0" + "@octokit/types": "^12.1.0" }, "devDependencies": { "@octokit/core": "^5.0.0", diff --git a/scripts/update-endpoints/generated/endpoints.json b/scripts/update-endpoints/generated/endpoints.json index 078989dd2..38c3281b0 100644 --- a/scripts/update-endpoints/generated/endpoints.json +++ b/scripts/update-endpoints/generated/endpoints.json @@ -81,7 +81,7 @@ "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 endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "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 endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository", "previews": [], "headers": [], @@ -364,7 +364,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Cancels a workflow run using its `id`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", + "description": "Cancels a workflow run using its `id`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run", "previews": [], "headers": [], @@ -428,7 +428,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "documentationUrl": "https://docs.github.com/rest/actions/variables#create-an-environment-variable", "previews": [], "headers": [], @@ -929,7 +929,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Returns a token that you can pass to the `config` script. The token\nexpires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using registration token: \n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided\nby this endpoint.\n\n```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN```", + "description": "Returns a token that you can pass to the `config` script. The token\nexpires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using registration token:\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided\nby this endpoint.\n\n```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN```", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository", "previews": [], "headers": [], @@ -1024,7 +1024,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using remove token:\n\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.\n\n```config.sh remove --token TOKEN```", + "description": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using remove token:\n\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.\n\n```config.sh remove --token TOKEN```", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository", "previews": [], "headers": [], @@ -1078,7 +1078,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Creates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "documentationUrl": "https://docs.github.com/rest/actions/variables#create-a-repository-variable", "previews": [], "headers": [], @@ -1503,7 +1503,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes an environment variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Deletes an environment variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "documentationUrl": "https://docs.github.com/rest/actions/variables#delete-an-environment-variable", "previews": [], "headers": [], @@ -1705,7 +1705,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes a repository variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Deletes a repository variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "documentationUrl": "https://docs.github.com/rest/actions/variables#delete-a-repository-variable", "previews": [], "headers": [], @@ -1806,7 +1806,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository", "previews": [], "headers": [], @@ -2431,6 +2431,70 @@ "responses": [{ "code": 204, "description": "Response", "examples": null }], "renamed": null }, + { + "name": "Force cancel a workflow run", + "scope": "actions", + "id": "forceCancelWorkflowRun", + "method": "POST", + "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job.\nYou should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run).\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-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 without the `.git` extension. 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 + } + ], + "responses": [ + { + "code": 202, + "description": "Response", + "examples": [{ "data": "null" }] + }, + { "code": 409, "description": "Conflict", "examples": null } + ], + "renamed": null + }, { "name": "Create configuration for a just-in-time runner for an organization", "scope": "actions", @@ -2539,7 +2603,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Generates a configuration that can be passed to the runner application at startup.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Generates a configuration that can be passed to the runner application at startup.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository", "previews": [], "headers": [], @@ -3228,7 +3292,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specific variable in an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Gets a specific variable in an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "documentationUrl": "https://docs.github.com/rest/actions/variables#get-an-environment-variable", "previews": [], "headers": [], @@ -3536,7 +3600,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@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\",\"workflow_name\":\"CI\",\"head_branch\":\"main\"}" + "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/29679449/jobs/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\",\"workflow_name\":\"CI\",\"head_branch\":\"main\"}" } ] } @@ -3951,7 +4015,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specific variable in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Gets a specific variable in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "documentationUrl": "https://docs.github.com/rest/actions/variables#get-a-repository-variable", "previews": [], "headers": [], @@ -4139,7 +4203,7 @@ "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 endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "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 endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository", "previews": [], "headers": [], @@ -4803,7 +4867,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all environment variables.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Lists all environment variables.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "documentationUrl": "https://docs.github.com/rest/actions/variables#list-environment-variables", "previews": [], "headers": [], @@ -4973,7 +5037,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@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\",\"workflow_name\":\"CI\",\"head_branch\":\"main\"}]}" + "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/29679449/jobs/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\",\"workflow_name\":\"CI\",\"head_branch\":\"main\"}]}" } ] } @@ -5079,7 +5143,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@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\",\"workflow_name\":\"CI\",\"head_branch\":\"main\"}]}" + "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/29679449/jobs/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\",\"workflow_name\":\"CI\",\"head_branch\":\"main\"}]}" } ] }, @@ -5151,7 +5215,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "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 endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "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 endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository", "previews": [], "headers": [], @@ -5433,7 +5497,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all organiation variables shared with a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Lists all organiation variables shared with a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "documentationUrl": "https://docs.github.com/rest/actions/variables#list-repository-organization-variables", "previews": [], "headers": [], @@ -5593,7 +5657,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all repository variables.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Lists all repository variables.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "documentationUrl": "https://docs.github.com/rest/actions/variables#list-repository-variables", "previews": [], "headers": [], @@ -5794,7 +5858,7 @@ "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.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "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.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository", "previews": [], "headers": [], @@ -6160,7 +6224,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all self-hosted runners configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Lists all self-hosted runners configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository", "previews": [], "headers": [], @@ -6770,7 +6834,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Re-run a job and its dependent jobs in a workflow run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", + "description": "Re-run a job and its dependent jobs in a workflow run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run", "previews": [], "headers": [], @@ -7054,7 +7118,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "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 endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "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 endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository", "previews": [], "headers": [], @@ -7195,7 +7259,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "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 endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "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 endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository", "previews": [], "headers": [], @@ -7802,7 +7866,7 @@ "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 a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "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 endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository", "previews": [], "headers": [], @@ -8373,7 +8437,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "documentationUrl": "https://docs.github.com/rest/actions/variables#update-an-environment-variable", "previews": [], "headers": [], @@ -8526,7 +8590,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Updates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Updates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "documentationUrl": "https://docs.github.com/rest/actions/variables#update-a-repository-variable", "previews": [], "headers": [], @@ -14830,7 +14894,7 @@ "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.", + "description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.\n\n**Note:** The endpoints to manage checks only look 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\nIf there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.", "documentationUrl": "https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference", "previews": [], "headers": [], @@ -14975,7 +15039,7 @@ "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.", + "description": "Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.\n\n**Note:** The endpoints to manage checks only look 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.", "documentationUrl": "https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite", "previews": [], "headers": [], @@ -15107,7 +15171,7 @@ "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.", + "description": "Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository.\n\n**Note:** The endpoints to manage checks only look 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`.", "documentationUrl": "https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference", "previews": [], "headers": [], @@ -15456,7 +15520,7 @@ "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.", + "description": "Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.\n\n**Note:** The endpoints to manage checks only look 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.", "documentationUrl": "https://docs.github.com/rest/checks/runs#update-a-check-run", "previews": [], "headers": [], @@ -16220,7 +16284,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":1,\"name\":\"database.zip\",\"language\":\"java\",\"uploader\":{\"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_type\":\"application/zip\",\"size\":1024,\"created_at\":\"2022-09-12T12:14:32Z\",\"updated_at\":\"2022-09-12T12:14:32Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java\"}" + "data": "{\"id\":1,\"name\":\"database.zip\",\"language\":\"java\",\"uploader\":{\"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_type\":\"application/zip\",\"size\":1024,\"created_at\":\"2022-09-12T12:14:32Z\",\"updated_at\":\"2022-09-12T12:14:32Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java\",\"commit_oid\":\"1927de39fefa25a9d0e64e3f540ff824a72f538c\"}" } ] }, @@ -16999,7 +17063,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1,\"name\":\"database.zip\",\"language\":\"java\",\"uploader\":{\"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_type\":\"application/zip\",\"size\":1024,\"created_at\":\"2022-09-12T12:14:32Z\",\"updated_at\":\"2022-09-12T12:14:32Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java\"},{\"id\":2,\"name\":\"database.zip\",\"language\":\"ruby\",\"uploader\":{\"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_type\":\"application/zip\",\"size\":1024,\"created_at\":\"2022-09-12T12:14:32Z\",\"updated_at\":\"2022-09-12T12:14:32Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby\"}]" + "data": "[{\"id\":1,\"name\":\"database.zip\",\"language\":\"java\",\"uploader\":{\"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_type\":\"application/zip\",\"size\":1024,\"created_at\":\"2022-09-12T12:14:32Z\",\"updated_at\":\"2022-09-12T12:14:32Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java\",\"commit_oid\":\"1927de39fefa25a9d0e64e3f540ff824a72f538c\"},{\"id\":2,\"name\":\"database.zip\",\"language\":\"ruby\",\"uploader\":{\"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_type\":\"application/zip\",\"size\":1024,\"created_at\":\"2022-09-12T12:14:32Z\",\"updated_at\":\"2022-09-12T12:14:32Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby\",\"commit_oid\":\"1927de39fefa25a9d0e64e3f540ff824a72f538c\"}]" } ] }, @@ -17359,7 +17423,7 @@ }, { "name": "languages", - "description": "CodeQL languages to be analyzed. Supported values are: `c-cpp`, `csharp`, `go`, `java-kotlin`, `javascript-typescript`, `python`, `ruby`, and `swift`.", + "description": "CodeQL languages to be analyzed.", "in": "BODY", "type": "string[]", "required": false, @@ -17388,7 +17452,7 @@ }, { "code": 403, - "description": "Response if GitHub Advanced Security is not enabled for this repository", + "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 }, @@ -17766,6 +17830,95 @@ ], "renamed": null }, + { + "name": "Check if permissions defined by a devcontainer have been accepted by the authenticated user", + "scope": "codespaces", + "id": "checkPermissionsForDevcontainer", + "method": "GET", + "url": "/repos/{owner}/{repo}/codespaces/permissions_check", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user.\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/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-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": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. 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": "The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically be a branch name (`heads/BRANCH_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", + "in": "QUERY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "devcontainer_path", + "description": "Path to the devcontainer.json configuration to use for the permission check.", + "in": "QUERY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response when the permission check is successful", + "examples": [{ "data": "{\"accepted\":true}" }] + }, + { + "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, or the endpoint has been spammed.", + "examples": null + }, + { "code": 503, "description": "Service unavailable", "examples": null } + ], + "renamed": null + }, { "name": "List machine types for a codespace", "scope": "codespaces", @@ -21539,7 +21692,7 @@ { "name": "Get Copilot for Business seat assignment details for a user", "scope": "copilot", - "id": "getCopilotSeatAssignmentDetailsForUser", + "id": "getCopilotSeatDetailsForUser", "method": "GET", "url": "/orgs/{org}/members/{username}/copilot", "isDeprecated": false, @@ -31652,10 +31805,10 @@ "id": "cancelImport", "method": "DELETE", "url": "/repos/{owner}/{repo}/import", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Stop an import for a repository.\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.\n", + "isDeprecated": true, + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12", + "description": "Stop an import for a repository.\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n", "documentationUrl": "https://docs.github.com/rest/migrations/source-imports#cancel-an-import", "previews": [], "headers": [], @@ -31878,10 +32031,10 @@ "id": "getCommitAuthors", "method": "GET", "url": "/repos/{owner}/{repo}/import/authors", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `.\n\nThis endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information.\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.", + "isDeprecated": true, + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12", + "description": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `.\n\nThis endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information.\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", "documentationUrl": "https://docs.github.com/rest/migrations/source-imports#get-commit-authors", "previews": [], "headers": [], @@ -31951,10 +32104,10 @@ "id": "getImportStatus", "method": "GET", "url": "/repos/{owner}/{repo}/import", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "View the progress of an import.\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.\n\n**Import status**\n\nThis section includes details about the possible values of the `status` field of the Import Progress response.\n\nAn import that does not have errors will progress through these steps:\n\n* `detecting` - the \"detection\" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.\n* `importing` - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).\n* `mapping` - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.\n* `pushing` - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is \"Writing objects\".\n* `complete` - the import is complete, and the repository is ready on GitHub.\n\nIf there are problems, you will see one of these in the `status` field:\n\n* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.\n* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/rest/migrations/source-imports#start-an-import) with the correct URL.\n* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n\n**The project_choices field**\n\nWhen multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.\n\n**Git LFS related fields**\n\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.\n\n* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.\n* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.\n* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.\n* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.", + "isDeprecated": true, + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12", + "description": "View the progress of an import.\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n\n**Import status**\n\nThis section includes details about the possible values of the `status` field of the Import Progress response.\n\nAn import that does not have errors will progress through these steps:\n\n* `detecting` - the \"detection\" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.\n* `importing` - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).\n* `mapping` - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.\n* `pushing` - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is \"Writing objects\".\n* `complete` - the import is complete, and the repository is ready on GitHub.\n\nIf there are problems, you will see one of these in the `status` field:\n\n* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.\n* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/rest/migrations/source-imports#start-an-import) with the correct URL.\n* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n\n**The project_choices field**\n\nWhen multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.\n\n**Git LFS related fields**\n\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.\n\n* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.\n* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.\n* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.\n* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.", "documentationUrl": "https://docs.github.com/rest/migrations/source-imports#get-an-import-status", "previews": [], "headers": [], @@ -32011,10 +32164,10 @@ "id": "getLargeFiles", "method": "GET", "url": "/repos/{owner}/{repo}/import/large_files", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "List files larger than 100MB found during the import\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.\n", + "isDeprecated": true, + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12", + "description": "List files larger than 100MB found during the import\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n", "documentationUrl": "https://docs.github.com/rest/migrations/source-imports#get-large-files", "previews": [], "headers": [], @@ -32563,10 +32716,10 @@ "id": "mapCommitAuthor", "method": "PATCH", "url": "/repos/{owner}/{repo}/import/authors/{author_id}", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Update an author's identity for the import. Your application can continue updating authors any time before you push\nnew commits to the repository.\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.\n", + "isDeprecated": true, + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12", + "description": "Update an author's identity for the import. Your application can continue updating authors any time before you push\nnew commits to the repository.\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n", "documentationUrl": "https://docs.github.com/rest/migrations/source-imports#map-a-commit-author", "previews": [], "headers": [], @@ -32667,10 +32820,10 @@ "id": "setLfsPreference", "method": "PATCH", "url": "/repos/{owner}/{repo}/import/lfs", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by [Git LFS](https://git-lfs.com).\n\nYou can learn more about our LFS feature and working with large files [on our help\nsite](https://docs.github.com/repositories/working-with-files/managing-large-files).\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.\n", + "isDeprecated": true, + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12", + "description": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by [Git LFS](https://git-lfs.com).\n\nYou can learn more about our LFS feature and working with large files [on our help\nsite](https://docs.github.com/repositories/working-with-files/managing-large-files).\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n", "documentationUrl": "https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference", "previews": [], "headers": [], @@ -33028,7 +33181,7 @@ }, { "name": "exclude", - "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.", + "description": "Exclude related items from being returned in the response in order to improve performance of the request.", "in": "BODY", "type": "string[]", "required": false, @@ -33065,10 +33218,10 @@ "id": "startImport", "method": "PUT", "url": "/repos/{owner}/{repo}/import", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Start a source import to a GitHub repository using GitHub Importer. Importing into a GitHub repository with GitHub Actions enabled is not supported and will return a status `422 Unprocessable Entity` response.\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update these docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.", + "isDeprecated": true, + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12", + "description": "Start a source import to a GitHub repository using GitHub Importer.\nImporting into a GitHub repository with GitHub Actions enabled is not supported and will\nreturn a status `422 Unprocessable Entity` response.\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n", "documentationUrl": "https://docs.github.com/rest/migrations/source-imports#start-an-import", "previews": [], "headers": [], @@ -33309,10 +33462,10 @@ "id": "updateImport", "method": "PATCH", "url": "/repos/{owner}/{repo}/import", - "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.\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.\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.", + "isDeprecated": true, + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12", + "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.\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", "documentationUrl": "https://docs.github.com/rest/migrations/source-imports#update-an-import", "previews": [], "headers": [], @@ -33913,6 +34066,356 @@ ], "renamed": null }, + { + "name": "Create or update custom properties for an organization", + "scope": "orgs", + "id": "createOrUpdateCustomProperties", + "method": "PATCH", + "url": "/orgs/{org}/properties/schema", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Creates new or updates existing custom properties defined for an organization in a batch.\nOnly organization owners (or users with the proper permissions granted by them) can update these properties", + "documentationUrl": "https://docs.github.com/rest/orgs/properties#create-or-update-custom-properties-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": "properties", + "description": "The array of custom properties to create or update.", + "in": "BODY", + "type": "object[]", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "properties[].property_name", + "description": "The name of the property", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "properties[].value_type", + "description": "The type of the value for the property", + "in": "BODY", + "type": "string", + "required": true, + "enum": ["string", "single_select"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "properties[].required", + "description": "Whether the property is required.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "properties[].default_value", + "description": "Default value of the property", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "properties[].description", + "description": "Short description of the property", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "properties[].allowed_values", + "description": "Ordered list of allowed values of the property", + "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"property_name\":\"environment\",\"value_type\":\"single_select\",\"required\":true,\"default_value\":\"production\",\"description\":\"Prod or dev environment\",\"allowed_values\":[\"production\",\"development\"]},{\"property_name\":\"service\",\"value_type\":\"string\"},{\"property_name\":\"team\",\"value_type\":\"string\",\"description\":\"Team owning the repository\"}]" + } + ] + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "Create or update custom property values for organization repositories", + "scope": "orgs", + "id": "createOrUpdateCustomPropertiesValuesForRepos", + "method": "PATCH", + "url": "/orgs/{org}/properties/values", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Create new or update existing custom property values for repositories in a batch that belong to an organization.\nEach target repository will have its custom property values updated to match the values provided in the request.\n\nA maximum of 30 repositories can be updated in a single request.\n\nUsing a value of `null` for a custom property will remove or 'unset' the property value from the repository.\n\nOnly organization owners (or users with the proper permissions granted by them) can update these properties", + "documentationUrl": "https://docs.github.com/rest/orgs/properties#create-or-update-custom-property-values-for-organization-repositories", + "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": "repository_names", + "description": "The names of repositories that the custom property values will be applied to.", + "in": "BODY", + "type": "string[]", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "properties", + "description": "List of custom property names and associated values to apply to the repositories.", + "in": "BODY", + "type": "object[]", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "properties[].property_name", + "description": "The name of the property", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "properties[].value", + "description": "The value assigned to the property", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"repository_id\":1296269,\"repository_name\":\"Hello-World\",\"repository_full_name\":\"octocat/Hello-World\",\"properties\":[{\"property_name\":\"environment\",\"value\":\"production\"},{\"property_name\":\"service\",\"value\":\"web\"},{\"property_name\":\"team\",\"value\":\"octocat\"}]}]" + } + ] + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "Create or update a custom property for an organization", + "scope": "orgs", + "id": "createOrUpdateCustomProperty", + "method": "PUT", + "url": "/orgs/{org}/properties/schema/{custom_property_name}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Creates a new or updates an existing custom property that is defined for an organization.\nYou must be an organization owner to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/orgs/properties#create-or-update-a-custom-property-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": "custom_property_name", + "description": "The custom property name. The name is case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "value_type", + "description": "The type of the value for the property", + "in": "BODY", + "type": "string", + "required": true, + "enum": ["string", "single_select"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "required", + "description": "Whether the property is required.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "default_value", + "description": "Default value of the property", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "description", + "description": "Short description of the property", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "allowed_values", + "description": "Ordered list of allowed values of the property", + "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"property_name\":\"environment\",\"value_type\":\"single_select\",\"required\":true,\"default_value\":\"production\",\"description\":\"Prod or dev environment\",\"allowed_values\":[\"production\",\"development\"]}" + } + ] + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, { "name": "Create an organization webhook", "scope": "orgs", @@ -34158,7 +34661,7 @@ }, { "name": "hook_id", - "description": "The unique identifier of the hook.", + "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", "in": "PATH", "type": "integer", "required": true, @@ -34303,6 +34806,105 @@ ], "renamed": null }, + { + "name": "Get all custom properties for an organization", + "scope": "orgs", + "id": "getAllCustomProperties", + "method": "GET", + "url": "/orgs/{org}/properties/schema", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Gets all custom properties defined for an organization.\nYou must be an organization owner to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/orgs/properties#get-all-custom-properties-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": "[{\"property_name\":\"environment\",\"value_type\":\"single_select\",\"required\":true,\"default_value\":\"production\",\"description\":\"Prod or dev environment\",\"allowed_values\":[\"production\",\"development\"]},{\"property_name\":\"service\",\"value_type\":\"string\"},{\"property_name\":\"team\",\"value_type\":\"string\",\"description\":\"Team owning the repository\"}]" + } + ] + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "Get a custom property for an organization", + "scope": "orgs", + "id": "getCustomProperty", + "method": "GET", + "url": "/orgs/{org}/properties/schema/{custom_property_name}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Gets a custom property that is defined for an organization.\nYou must be an organization owner to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/orgs/properties#get-a-custom-property-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": "custom_property_name", + "description": "The custom property name. The name is 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": "{\"property_name\":\"environment\",\"value_type\":\"single_select\",\"required\":true,\"default_value\":\"production\",\"description\":\"Prod or dev environment\",\"allowed_values\":[\"production\",\"development\"]}" + } + ] + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, { "name": "Get an organization membership for the authenticated user", "scope": "orgs", @@ -34431,7 +35033,7 @@ }, { "name": "hook_id", - "description": "The unique identifier of the hook.", + "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", "in": "PATH", "type": "integer", "required": true, @@ -34486,7 +35088,7 @@ }, { "name": "hook_id", - "description": "The unique identifier of the hook.", + "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", "in": "PATH", "type": "integer", "required": true, @@ -34540,7 +35142,7 @@ }, { "name": "hook_id", - "description": "The unique identifier of the hook.", + "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", "in": "PATH", "type": "integer", "required": true, @@ -34774,6 +35376,75 @@ ], "renamed": null }, + { + "name": "List custom property values for organization repositories", + "scope": "orgs", + "id": "listCustomPropertiesValuesForRepos", + "method": "GET", + "url": "/orgs/{org}/properties/values", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists organization repositories with all of their custom property values.\nOrganization members can read these properties.", + "documentationUrl": "https://docs.github.com/rest/orgs/properties#list-custom-property-values-for-organization-repositories", + "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": "[{\"repository_id\":1296269,\"repository_name\":\"Hello-World\",\"repository_full_name\":\"octocat/Hello-World\",\"properties\":[{\"property_name\":\"environment\",\"value\":\"production\"},{\"property_name\":\"service\",\"value\":\"web\"},{\"property_name\":\"team\",\"value\":\"octocat\"}]}]" + } + ] + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, { "name": "List failed organization invitations", "scope": "orgs", @@ -35625,7 +36296,173 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":25381,\"reason\":\"I need to access the GitHub API\",\"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_selection\":\"all\",\"repositories_url\":\"https://api.github.com/organizations/652551/personal-access-token-requests/25381/repositories\",\"permissions\":{\"organization\":{\"members\":\"read\"},\"repository\":{\"metadata\":\"read\"}},\"created_at\":\"2023-05-16T08:47:09.000-07:00\",\"token_expired\":false,\"token_expires_at\":\"2023-11-16T08:47:09.000-07:00\",\"token_last_used_at\":null}]" + "data": "[{\"id\":25381,\"reason\":\"I need to access the GitHub API\",\"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_selection\":\"all\",\"repositories_url\":\"https://api.github.com/organizations/652551/personal-access-token-requests/25381/repositories\",\"permissions\":{\"organization\":{\"members\":\"read\"},\"repository\":{\"metadata\":\"read\"}},\"created_at\":\"2023-05-16T08:47:09.000-07:00\",\"token_expired\":false,\"token_expires_at\":\"2023-11-16T08:47:09.000-07:00\",\"token_last_used_at\":null}]" + } + ] + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { + "code": 422, + "description": "Validation failed, or the endpoint has been spammed.", + "examples": null + }, + { "code": 500, "description": "Internal Error", "examples": null } + ], + "renamed": null + }, + { + "name": "List fine-grained personal access tokens with access to organization resources", + "scope": "orgs", + "id": "listPatGrants", + "method": "GET", + "url": "/orgs/{org}/personal-access-tokens", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. Only GitHub Apps can call this API,\nusing the `organization_personal_access_tokens: read` permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", + "documentationUrl": "https://docs.github.com/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources", + "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 + }, + { + "name": "sort", + "description": "The property by which to sort the results.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["created_at"], + "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": "owner", + "description": "A list of owner usernames to use to filter the results.", + "in": "QUERY", + "type": "array", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repository", + "description": "The name of the repository to use to filter the results.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permission", + "description": "The permission to use to filter the results.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "last_used_before", + "description": "Only show fine-grained personal access tokens used 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": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "last_used_after", + "description": "Only show fine-grained personal access tokens used 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 + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"id\":25381,\"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_selection\":\"all\",\"repositories_url\":\"https://api.github.com/organizations/652551/personal-access-tokens/25381/repositories\",\"permissions\":{\"organization\":{\"members\":\"read\"},\"repository\":{\"metadata\":\"read\"}},\"access_granted_at\":\"2023-05-16T08:47:09.000-07:00\",\"token_expired\":false,\"token_expires_at\":\"2023-11-16T08:47:09.000-07:00\",\"token_last_used_at\":null}]" } ] }, @@ -35641,16 +36478,16 @@ "renamed": null }, { - "name": "List fine-grained personal access tokens with access to organization resources", + "name": "List pending organization invitations", "scope": "orgs", - "id": "listPatGrants", + "id": "listPendingInvitations", "method": "GET", - "url": "/orgs/{org}/personal-access-tokens", + "url": "/orgs/{org}/invitations", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. Only GitHub Apps can call this API,\nusing the `organization_personal_access_tokens: read` permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", - "documentationUrl": "https://docs.github.com/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources", + "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, or `hiring_manager`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.", + "documentationUrl": "https://docs.github.com/rest/orgs/members#list-pending-organization-invitations", "previews": [], "headers": [], "parameters": [ @@ -35694,12 +36531,18 @@ "deprecated": null }, { - "name": "sort", - "description": "The property by which to sort the results.", + "name": "role", + "description": "Filter invitations by their member role.", "in": "QUERY", "type": "string", "required": false, - "enum": ["created_at"], + "enum": [ + "all", + "admin", + "direct_member", + "billing_manager", + "hiring_manager" + ], "allowNull": false, "mapToData": null, "validation": null, @@ -35707,37 +36550,53 @@ "deprecated": null }, { - "name": "direction", - "description": "The direction to sort the results by.", + "name": "invitation_source", + "description": "Filter invitations by their invitation source.", "in": "QUERY", "type": "string", "required": false, - "enum": ["asc", "desc"], + "enum": ["all", "member", "scim"], "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "owner", - "description": "A list of owner usernames to use to filter the results.", - "in": "QUERY", - "type": "array", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"id\":1,\"login\":\"monalisa\",\"node_id\":\"MDQ6VXNlcjE=\",\"email\":\"octocat@github.com\",\"role\":\"direct_member\",\"created_at\":\"2016-11-30T06:46:10-08:00\",\"failed_at\":\"\",\"failed_reason\":\"\",\"inviter\":{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false},\"team_count\":2,\"invitation_teams_url\":\"https://api.github.com/organizations/2/invitations/1/teams\",\"invitation_source\":\"member\"}]" + } + ] }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "List public organization members", + "scope": "orgs", + "id": "listPublicMembers", + "method": "GET", + "url": "/orgs/{org}/public_members", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Members of an organization can choose to have their membership publicized or not.", + "documentationUrl": "https://docs.github.com/rest/orgs/members#list-public-organization-members", + "previews": [], + "headers": [], + "parameters": [ { - "name": "repository", - "description": "The name of the repository to use to filter the results.", - "in": "QUERY", + "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, @@ -35746,10 +36605,10 @@ "deprecated": null }, { - "name": "permission", - "description": "The permission to use to filter the results.", + "name": "per_page", + "description": "The number of results per page (max 100).", "in": "QUERY", - "type": "string", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -35759,10 +36618,10 @@ "deprecated": null }, { - "name": "last_used_before", - "description": "Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "name": "page", + "description": "Page number of the results to fetch.", "in": "QUERY", - "type": "string", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -35770,13 +36629,41 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "last_used_after", - "description": "Only show fine-grained personal access tokens used 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", + "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}]" + } + ] + } + ], + "renamed": null + }, + { + "name": "List security manager teams", + "scope": "orgs", + "id": "listSecurityManagerTeams", + "method": "GET", + "url": "/orgs/{org}/security-managers", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists teams that are security managers for an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nTo use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `read:org` scope.\n\nGitHub Apps must have the `administration` organization read permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams", + "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, @@ -35791,32 +36678,24 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":25381,\"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_selection\":\"all\",\"repositories_url\":\"https://api.github.com/organizations/652551/personal-access-tokens/25381/repositories\",\"permissions\":{\"organization\":{\"members\":\"read\"},\"repository\":{\"metadata\":\"read\"}},\"access_granted_at\":\"2023-05-16T08:47:09.000-07:00\",\"token_expired\":false,\"token_expires_at\":\"2023-11-16T08:47:09.000-07:00\",\"token_last_used_at\":null}]" + "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\",\"notification_setting\":\"notifications_enabled\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" } ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - }, - { "code": 500, "description": "Internal Error", "examples": null } + } ], "renamed": null }, { - "name": "List pending organization invitations", + "name": "List deliveries for an organization webhook", "scope": "orgs", - "id": "listPendingInvitations", + "id": "listWebhookDeliveries", "method": "GET", - "url": "/orgs/{org}/invitations", + "url": "/orgs/{org}/hooks/{hook_id}/deliveries", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, or `hiring_manager`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.", - "documentationUrl": "https://docs.github.com/rest/orgs/members#list-pending-organization-invitations", + "description": "Returns a list of webhook deliveries for a webhook configured in an organization.", + "documentationUrl": "https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook", "previews": [], "headers": [], "parameters": [ @@ -35834,11 +36713,11 @@ "deprecated": null }, { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", + "name": "hook_id", + "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", + "in": "PATH", "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -35847,8 +36726,8 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", + "name": "per_page", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -35860,18 +36739,12 @@ "deprecated": null }, { - "name": "role", - "description": "Filter invitations by their member role.", + "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": [ - "all", - "admin", - "direct_member", - "billing_manager", - "hiring_manager" - ], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -35879,12 +36752,12 @@ "deprecated": null }, { - "name": "invitation_source", - "description": "Filter invitations by their invitation source.", + "name": "redelivery", + "description": "", "in": "QUERY", - "type": "string", + "type": "boolean", "required": false, - "enum": ["all", "member", "scim"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -35898,25 +36771,31 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1,\"login\":\"monalisa\",\"node_id\":\"MDQ6VXNlcjE=\",\"email\":\"octocat@github.com\",\"role\":\"direct_member\",\"created_at\":\"2016-11-30T06:46:10-08:00\",\"failed_at\":\"\",\"failed_reason\":\"\",\"inviter\":{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false},\"team_count\":2,\"invitation_teams_url\":\"https://api.github.com/organizations/2/invitations/1/teams\",\"invitation_source\":\"member\"}]" + "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": 404, "description": "Resource not found", "examples": null } + { "code": 400, "description": "Bad Request", "examples": null }, + { "code": 400, "description": "Bad Request", "examples": null }, + { + "code": 422, + "description": "Validation failed, or the endpoint has been spammed.", + "examples": null + } ], "renamed": null }, { - "name": "List public organization members", + "name": "List organization webhooks", "scope": "orgs", - "id": "listPublicMembers", + "id": "listWebhooks", "method": "GET", - "url": "/orgs/{org}/public_members", + "url": "/orgs/{org}/hooks", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Members of an organization can choose to have their membership publicized or not.", - "documentationUrl": "https://docs.github.com/rest/orgs/members#list-public-organization-members", + "description": "", + "documentationUrl": "https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks", "previews": [], "headers": [], "parameters": [ @@ -35966,65 +36845,25 @@ "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}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List security manager teams", - "scope": "orgs", - "id": "listSecurityManagerTeams", - "method": "GET", - "url": "/orgs/{org}/security-managers", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Lists teams that are security managers for an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nTo use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `read:org` scope.\n\nGitHub Apps must have the `administration` organization read permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams", - "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": "[{\"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\",\"notification_setting\":\"notifications_enabled\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" + "data": "[{\"id\":1,\"url\":\"https://api.github.com/orgs/octocat/hooks/1\",\"ping_url\":\"https://api.github.com/orgs/octocat/hooks/1/pings\",\"deliveries_url\":\"https://api.github.com/orgs/octocat/hooks/1/deliveries\",\"name\":\"web\",\"events\":[\"push\",\"pull_request\"],\"active\":true,\"config\":{\"url\":\"http://example.com\",\"content_type\":\"json\"},\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"type\":\"Organization\"}]" } ] - } + }, + { "code": 404, "description": "Resource not found", "examples": null } ], "renamed": null }, { - "name": "List deliveries for an organization webhook", + "name": "Ping an organization webhook", "scope": "orgs", - "id": "listWebhookDeliveries", - "method": "GET", - "url": "/orgs/{org}/hooks/{hook_id}/deliveries", + "id": "pingWebhook", + "method": "POST", + "url": "/orgs/{org}/hooks/{hook_id}/pings", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Returns a list of webhook deliveries for a webhook configured in an organization.", - "documentationUrl": "https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook", + "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.", + "documentationUrl": "https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook", "previews": [], "headers": [], "parameters": [ @@ -36043,7 +36882,7 @@ }, { "name": "hook_id", - "description": "The unique identifier of the hook.", + "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", "in": "PATH", "type": "integer", "required": true, @@ -36053,78 +36892,25 @@ "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": "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 - }, - { - "name": "redelivery", - "description": "", - "in": "QUERY", - "type": "boolean", - "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, or the endpoint has been spammed.", - "examples": null - } + { "code": 204, "description": "Response", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } ], "renamed": null }, { - "name": "List organization webhooks", + "name": "Redeliver a delivery for an organization webhook", "scope": "orgs", - "id": "listWebhooks", - "method": "GET", - "url": "/orgs/{org}/hooks", + "id": "redeliverWebhookDelivery", + "method": "POST", + "url": "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks", + "description": "Redeliver a delivery for a webhook configured in an organization.", + "documentationUrl": "https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook", "previews": [], "headers": [], "parameters": [ @@ -36142,11 +36928,11 @@ "deprecated": null }, { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", + "name": "hook_id", + "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", + "in": "PATH", "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -36155,11 +36941,11 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", + "name": "delivery_id", + "description": "", + "in": "PATH", "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -36170,76 +36956,31 @@ ], "responses": [ { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"url\":\"https://api.github.com/orgs/octocat/hooks/1\",\"ping_url\":\"https://api.github.com/orgs/octocat/hooks/1/pings\",\"deliveries_url\":\"https://api.github.com/orgs/octocat/hooks/1/deliveries\",\"name\":\"web\",\"events\":[\"push\",\"pull_request\"],\"active\":true,\"config\":{\"url\":\"http://example.com\",\"content_type\":\"json\"},\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"type\":\"Organization\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Ping an organization webhook", - "scope": "orgs", - "id": "pingWebhook", - "method": "POST", - "url": "/orgs/{org}/hooks/{hook_id}/pings", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.", - "documentationUrl": "https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook", - "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 + "code": 202, + "description": "Accepted", + "examples": [{ "data": "null" }] }, + { "code": 400, "description": "Bad Request", "examples": null }, + { "code": 400, "description": "Bad Request", "examples": null }, { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null + "code": 422, + "description": "Validation failed, or the endpoint has been spammed.", + "examples": null } ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], "renamed": null }, { - "name": "Redeliver a delivery for an organization webhook", + "name": "Remove a custom property for an organization", "scope": "orgs", - "id": "redeliverWebhookDelivery", - "method": "POST", - "url": "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts", + "id": "removeCustomProperty", + "method": "DELETE", + "url": "/orgs/{org}/properties/schema/{custom_property_name}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Redeliver a delivery for a webhook configured in an organization.", - "documentationUrl": "https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook", + "description": "Removes a custom property that is defined for an organization.\nYou must be an organization owner to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/orgs/properties#remove-a-custom-property-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -36257,23 +36998,10 @@ "deprecated": null }, { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "delivery_id", - "description": "", + "name": "custom_property_name", + "description": "The custom property name. The name is case sensitive.", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -36285,17 +37013,12 @@ ], "responses": [ { - "code": 202, - "description": "Accepted", - "examples": [{ "data": "null" }] - }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", + "code": 204, + "description": "A header with no content is returned.", "examples": null - } + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } ], "renamed": null }, @@ -37521,7 +38244,7 @@ }, { "name": "hook_id", - "description": "The unique identifier of the hook.", + "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", "in": "PATH", "type": "integer", "required": true, @@ -37685,7 +38408,7 @@ }, { "name": "hook_id", - "description": "The unique identifier of the hook.", + "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", "in": "PATH", "type": "integer", "required": true, @@ -46473,7 +47196,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "List the reactions to a [pull request review comment](https://docs.github.com/pulls/comments#get-a-review-comment-for-a-pull-request).", + "description": "List the reactions to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request).", "documentationUrl": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment", "previews": [], "headers": [], @@ -48819,7 +49542,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", + "description": "Creates a deployment branch or tag policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy", "previews": [], "headers": [], @@ -48865,7 +49588,7 @@ }, { "name": "name", - "description": "The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).", + "description": "The name pattern that branches or tags must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).", "in": "BODY", "type": "string", "required": true, @@ -48875,6 +49598,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "type", + "description": "Whether this rule targets a branch or tag", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["branch", "tag"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -48887,6 +49623,9 @@ }, { "data": "{\"id\":364663,\"node_id\":\"MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=\",\"name\":\"main\"}" + }, + { + "data": "{\"id\":364663,\"node_id\":\"MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=\",\"name\":\"v1\",\"type\":\"tag\"}" } ] }, @@ -50113,6 +50852,19 @@ "alias": null, "deprecated": null }, + { + "name": "prevent_self_review", + "description": "Whether or not a user who created the job is prevented from approving their own job.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "reviewers", "description": "The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", @@ -50198,7 +50950,7 @@ "description": "Response", "examples": [ { - "data": "{\"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\",\"protection_rules\":[{\"id\":3736,\"node_id\":\"MDQ6R2F0ZTM3MzY=\",\"type\":\"wait_timer\",\"wait_timer\":30},{\"id\":3755,\"node_id\":\"MDQ6R2F0ZTM3NTU=\",\"type\":\"required_reviewers\",\"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\",\"notification_setting\":\"notifications_enabled\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}}]},{\"id\":3756,\"node_id\":\"MDQ6R2F0ZTM3NTY=\",\"type\":\"branch_policy\"}],\"deployment_branch_policy\":{\"protected_branches\":false,\"custom_branch_policies\":true}}" + "data": "{\"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\",\"protection_rules\":[{\"id\":3736,\"node_id\":\"MDQ6R2F0ZTM3MzY=\",\"type\":\"wait_timer\",\"wait_timer\":30},{\"id\":3755,\"node_id\":\"MDQ6R2F0ZTM3NTU=\",\"prevent_self_review\":false,\"type\":\"required_reviewers\",\"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\",\"notification_setting\":\"notifications_enabled\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}}]},{\"id\":3756,\"node_id\":\"MDQ6R2F0ZTM3NTY=\",\"type\":\"branch_policy\"}],\"deployment_branch_policy\":{\"protected_branches\":false,\"custom_branch_policies\":true}}" } ] }, @@ -50530,7 +51282,7 @@ }, { "name": "bypass_actors[].actor_id", - "description": "The ID of the actor that can bypass a ruleset", + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`.", "in": "BODY", "type": "integer", "required": true, @@ -50599,7 +51351,7 @@ "in": "BODY", "type": "string", "required": true, - "enum": ["tag_name_pattern"], + "enum": ["workflows"], "allowNull": false, "mapToData": null, "validation": null, @@ -50813,6 +51565,71 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "rules[].parameters.workflows", + "description": "Workflows that must pass for this rule to pass.", + "in": "BODY", + "type": "object[]", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "rules[].parameters.workflows[].path", + "description": "The path to the workflow file", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "rules[].parameters.workflows[].ref", + "description": "The ref (branch or tag) of the workflow file to use", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "rules[].parameters.workflows[].repository_id", + "description": "The ID of the repository where the workflow is defined", + "in": "BODY", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "rules[].parameters.workflows[].sha", + "description": "The commit SHA of the workflow file to use", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -51331,7 +52148,7 @@ }, { "name": "bypass_actors[].actor_id", - "description": "The ID of the actor that can bypass a ruleset", + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`.", "in": "BODY", "type": "integer", "required": true, @@ -51439,7 +52256,7 @@ "in": "BODY", "type": "string", "required": true, - "enum": ["tag_name_pattern"], + "enum": ["workflows"], "allowNull": false, "mapToData": null, "validation": null, @@ -51653,6 +52470,71 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "rules[].parameters.workflows", + "description": "Workflows that must pass for this rule to pass.", + "in": "BODY", + "type": "object[]", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "rules[].parameters.workflows[].path", + "description": "The path to the workflow file", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "rules[].parameters.workflows[].ref", + "description": "The ref (branch or tag) of the workflow file to use", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "rules[].parameters.workflows[].repository_id", + "description": "The ID of the repository where the workflow is defined", + "in": "BODY", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "rules[].parameters.workflows[].sha", + "description": "The commit SHA of the workflow file to use", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -52731,7 +53613,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", + "description": "Deletes a deployment branch or tag policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy", "previews": [], "headers": [], @@ -53480,7 +54362,7 @@ }, { "name": "hook_id", - "description": "The unique identifier of the hook.", + "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", "in": "PATH", "type": "integer", "required": true, @@ -54525,7 +55407,7 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":1,\"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\",\"protection_rules\":[{\"id\":3736,\"node_id\":\"MDQ6R2F0ZTM3MzY=\",\"type\":\"wait_timer\",\"wait_timer\":30},{\"id\":3755,\"node_id\":\"MDQ6R2F0ZTM3NTU=\",\"type\":\"required_reviewers\",\"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\",\"notification_setting\":\"notifications_enabled\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}}]},{\"id\":3756,\"node_id\":\"MDQ6R2F0ZTM3NTY=\",\"type\":\"branch_policy\"}],\"deployment_branch_policy\":{\"protected_branches\":false,\"custom_branch_policies\":true}}]}" + "data": "{\"total_count\":1,\"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\",\"protection_rules\":[{\"id\":3736,\"node_id\":\"MDQ6R2F0ZTM3MzY=\",\"type\":\"wait_timer\",\"wait_timer\":30},{\"id\":3755,\"node_id\":\"MDQ6R2F0ZTM3NTU=\",\"prevent_self_review\":false,\"type\":\"required_reviewers\",\"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\",\"notification_setting\":\"notifications_enabled\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}}]},{\"id\":3756,\"node_id\":\"MDQ6R2F0ZTM3NTY=\",\"type\":\"branch_policy\"}],\"deployment_branch_policy\":{\"protected_branches\":false,\"custom_branch_policies\":true}}]}" } ] } @@ -55641,7 +56523,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Returns all community profile metrics for a repository. The repository cannot be a fork.\n\nThe returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE\\_TEMPLATE, PULL\\_REQUEST\\_TEMPLATE,\nREADME, and CONTRIBUTING files.\n\nThe `health_percentage` score is defined as a percentage of how many of\nthese four documents are present: README, CONTRIBUTING, LICENSE, and\nCODE_OF_CONDUCT. For example, if all four documents are present, then\nthe `health_percentage` is `100`. If only one is present, then the\n`health_percentage` is `25`.\n\n`content_reports_enabled` is only returned for organization-owned repositories.", + "description": "Returns all community profile metrics for a repository. The repository cannot be a fork.\n\nThe returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE\\_TEMPLATE, PULL\\_REQUEST\\_TEMPLATE,\nREADME, and CONTRIBUTING files.\n\nThe `health_percentage` score is defined as a percentage of how many of\nthe recommended community health files are present. For more information, see\n\"[About community profiles for public repositories](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories).\"\n\n`content_reports_enabled` is only returned for organization-owned repositories.", "documentationUrl": "https://docs.github.com/rest/metrics/community#get-community-profile-metrics", "previews": [], "headers": [], @@ -55934,6 +56816,62 @@ ], "renamed": null }, + { + "name": "Get all custom property values for a repository", + "scope": "repos", + "id": "getCustomPropertiesValues", + "method": "GET", + "url": "/repos/{owner}/{repo}/properties/values", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Gets all custom property values that are set for a repository.\nUsers with admin access to the repository can use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/repos/properties#get-all-custom-property-values-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 without the `.git` extension. 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": "[{\"property_name\":\"environment\",\"value\":\"production\"},{\"property_name\":\"service\",\"value\":\"web\"},{\"property_name\":\"team\",\"value\":\"octocat\"}]" + } + ] + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, { "name": "Get a deploy key", "scope": "repos", @@ -56079,7 +57017,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a deployment branch policy for an environment.\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.", + "description": "Gets a deployment branch or tag policy for an environment.\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/deployments/branch-policies#get-a-deployment-branch-policy", "previews": [], "headers": [], @@ -56291,7 +57229,7 @@ "description": "Response", "examples": [ { - "data": "{\"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\",\"protection_rules\":[{\"id\":3736,\"node_id\":\"MDQ6R2F0ZTM3MzY=\",\"type\":\"wait_timer\",\"wait_timer\":30},{\"id\":3755,\"node_id\":\"MDQ6R2F0ZTM3NTU=\",\"type\":\"required_reviewers\",\"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\",\"notification_setting\":\"notifications_enabled\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}}]},{\"id\":3756,\"node_id\":\"MDQ6R2F0ZTM3NTY=\",\"type\":\"branch_policy\"}],\"deployment_branch_policy\":{\"protected_branches\":false,\"custom_branch_policies\":true}}" + "data": "{\"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\",\"protection_rules\":[{\"id\":3736,\"node_id\":\"MDQ6R2F0ZTM3MzY=\",\"type\":\"wait_timer\",\"wait_timer\":30},{\"id\":3755,\"node_id\":\"MDQ6R2F0ZTM3NTU=\",\"prevent_self_review\":false,\"type\":\"required_reviewers\",\"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\",\"notification_setting\":\"notifications_enabled\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}}]},{\"id\":3756,\"node_id\":\"MDQ6R2F0ZTM3NTY=\",\"type\":\"branch_policy\"}],\"deployment_branch_policy\":{\"protected_branches\":false,\"custom_branch_policies\":true}}" } ] } @@ -56406,6 +57344,183 @@ ], "renamed": null }, + { + "name": "Get an organization rule suite", + "scope": "repos", + "id": "getOrgRuleSuite", + "method": "GET", + "url": "/orgs/{org}/rulesets/rule-suites/{rule_suite_id}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Gets information about a suite of rule evaluations from within an organization.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"", + "documentationUrl": "https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite", + "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": "rule_suite_id", + "description": "The unique identifier of the rule suite result.\nTo get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites)\nfor repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites)\nfor organizations.", + "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\":21,\"actor_id\":12,\"username\":\"octocat\",\"before_sha\":\"893f768e172fb1bc9c5d6f3dd48557e45f14e01d\",\"after_sha\":\"dedd88641a362b6b4ea872da4847d6131a164d01\",\"ref\":\"refs/heads/i-see-everything\",\"repository_id\":404,\"repository_name\":\"octo-repo\",\"pushed_at\":\"2023-07-06T08:43:03Z\",\"result\":\"bypass\",\"evaluation_result\":\"fail\",\"rule_evaluations\":[{\"rule_source\":{\"type\":\"ruleset\",\"id\":2,\"name\":\"Author email must be a GitHub email address\"},\"enforcement\":\"active\",\"result\":\"pass\",\"rule_type\":\"commit_author_email_pattern\"},{\"rule_source\":{\"type\":\"protected_branch\"},\"enforcement\":\"active\",\"result\":\"fail\",\"rule_type\":\"pull_request\",\"details\":\"Changes must be made through a pull request.\"},{\"rule_source\":{\"type\":\"ruleset\",\"id\":3,\"name\":\"Evaluate commit message pattern\"},\"enforcement\":\"evaluate\",\"result\":\"fail\",\"rule_type\":\"commit_message_pattern\"}]}" + } + ] + }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 500, "description": "Internal Error", "examples": null } + ], + "renamed": null + }, + { + "name": "List organization rule suites", + "scope": "repos", + "id": "getOrgRuleSuites", + "method": "GET", + "url": "/orgs/{org}/rulesets/rule-suites", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists suites of rule evaluations at the organization level.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"", + "documentationUrl": "https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites", + "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": "repository_name", + "description": "The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "time_period", + "description": "The time period to filter by.\n\nFor example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours).", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["hour", "day", "week", "month"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "actor_name", + "description": "The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "rule_suite_result", + "description": "The rule results to filter on. When specified, only suites with this result will be returned.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["pass", "fail", "bypass", "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": "[{\"id\":21,\"actor_id\":12,\"username\":\"octocat\",\"before_sha\":\"893f768e172fb1bc9c5d6f3dd48557e45f14e01d\",\"after_sha\":\"dedd88641a362b6b4ea872da4847d6131a164d01\",\"ref\":\"refs/heads/i-see-everything\",\"repository_id\":404,\"repository_name\":\"octo-repo\",\"pushed_at\":\"2023-07-06T08:43:03Z\",\"result\":\"bypass\"},{\"id\":25,\"actor_id\":11,\"username\":\"not-octocat\",\"before_sha\":\"48994e4e01ccc943624c6231f172702b82b233cc\",\"after_sha\":\"ecfd5a1025fa271a33ca5608d089476a2df3c9a1\",\"ref\":\"refs/heads/i-am-everything\",\"repository_id\":404,\"repository_name\":\"octo-repo\",\"pushed_at\":\"2023-07-07T08:43:03Z\",\"result\":\"pass\",\"evaluation_result\":\"fail\"}]" + } + ] + }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 500, "description": "Internal Error", "examples": null } + ], + "renamed": null + }, { "name": "Get an organization repository ruleset", "scope": "repos", @@ -57014,10 +58129,301 @@ "deprecated": null }, { - "name": "dir", - "description": "The alternate path to look for a README file", + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch.", + "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": "{\"type\":\"file\",\"encoding\":\"base64\",\"size\":5362,\"name\":\"README.md\",\"path\":\"README.md\",\"content\":\"encoded content ...\",\"sha\":\"3d21ec53a331a6f037a91c368710b99387d012c1\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\"}}" + } + ] + }, + { "code": 404, "description": "Resource not found", "examples": null }, + { + "code": 422, + "description": "Validation failed, or the endpoint has been spammed.", + "examples": null + } + ], + "renamed": null + }, + { + "name": "Get a release", + "scope": "repos", + "id": "getRelease", + "method": "GET", + "url": "/repos/{owner}/{repo}/releases/{release_id}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia).", + "documentationUrl": "https://docs.github.com/rest/releases/releases#get-a-release", + "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 without the `.git` extension. 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": "release_id", + "description": "The unique identifier of the release.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia).", + "examples": [ + { + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"discussion_url\":\"https://github.com/octocat/Hello-World/discussions/90\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"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},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"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": 401, "description": "Unauthorized", "examples": null } + ], + "renamed": null + }, + { + "name": "Get a release asset", + "scope": "repos", + "id": "getReleaseAsset", + "method": "GET", + "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", + "documentationUrl": "https://docs.github.com/rest/releases/assets#get-a-release-asset", + "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 without the `.git` extension. 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": "asset_id", + "description": "The unique identifier of the asset.", + "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": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"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": 302, "description": "Found", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "Get a release by tag name", + "scope": "repos", + "id": "getReleaseByTag", + "method": "GET", + "url": "/repos/{owner}/{repo}/releases/tags/{tag}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Get a published release with the specified tag.", + "documentationUrl": "https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name", + "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 without the `.git` extension. 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", + "description": "tag parameter", + "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/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"discussion_url\":\"https://github.com/octocat/Hello-World/discussions/90\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"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},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"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 } + ], + "renamed": null + }, + { + "name": "Get a repository rule suite", + "scope": "repos", + "id": "getRepoRuleSuite", + "method": "GET", + "url": "/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Gets information about a suite of rule evaluations from within a repository.\nFor more information, see \"[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets).\"", + "documentationUrl": "https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-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 without the `.git` extension. 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": "rule_suite_id", + "description": "The unique identifier of the rule suite result.\nTo get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites)\nfor repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites)\nfor organizations.", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -57025,19 +58431,6 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null } ], "responses": [ @@ -57046,30 +58439,26 @@ "description": "Response", "examples": [ { - "data": "{\"type\":\"file\",\"encoding\":\"base64\",\"size\":5362,\"name\":\"README.md\",\"path\":\"README.md\",\"content\":\"encoded content ...\",\"sha\":\"3d21ec53a331a6f037a91c368710b99387d012c1\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\"}}" + "data": "{\"id\":21,\"actor_id\":12,\"username\":\"octocat\",\"before_sha\":\"893f768e172fb1bc9c5d6f3dd48557e45f14e01d\",\"after_sha\":\"dedd88641a362b6b4ea872da4847d6131a164d01\",\"ref\":\"refs/heads/i-see-everything\",\"repository_id\":404,\"repository_name\":\"octo-repo\",\"pushed_at\":\"2023-07-06T08:43:03Z\",\"result\":\"bypass\",\"evaluation_result\":\"fail\",\"rule_evaluations\":[{\"rule_source\":{\"type\":\"ruleset\",\"id\":2,\"name\":\"Author email must be a GitHub email address\"},\"enforcement\":\"active\",\"result\":\"pass\",\"rule_type\":\"commit_author_email_pattern\"},{\"rule_source\":{\"type\":\"protected_branch\"},\"enforcement\":\"active\",\"result\":\"fail\",\"rule_type\":\"pull_request\",\"details\":\"Changes must be made through a pull request.\"},{\"rule_source\":{\"type\":\"ruleset\",\"id\":3,\"name\":\"Evaluate commit message pattern\"},\"enforcement\":\"evaluate\",\"result\":\"fail\",\"rule_type\":\"commit_message_pattern\"}]}" } ] }, { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } + { "code": 500, "description": "Internal Error", "examples": null } ], "renamed": null }, { - "name": "Get a release", + "name": "List repository rule suites", "scope": "repos", - "id": "getRelease", + "id": "getRepoRuleSuites", "method": "GET", - "url": "/repos/{owner}/{repo}/releases/{release_id}", + "url": "/repos/{owner}/{repo}/rulesets/rule-suites", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia).", - "documentationUrl": "https://docs.github.com/rest/releases/releases#get-a-release", + "description": "Lists suites of rule evaluations at the repository level.\nFor more information, see \"[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets).\"", + "documentationUrl": "https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites", "previews": [], "headers": [], "parameters": [ @@ -57100,53 +58489,11 @@ "deprecated": null }, { - "name": "release_id", - "description": "The unique identifier of the release.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia).", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"discussion_url\":\"https://github.com/octocat/Hello-World/discussions/90\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"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},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"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": 401, "description": "Unauthorized", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a release asset", - "scope": "repos", - "id": "getReleaseAsset", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", - "documentationUrl": "https://docs.github.com/rest/releases/assets#get-a-release-asset", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", + "name": "ref", + "description": "The name of the ref. Cannot contain wildcard characters. When specified, only rule evaluations triggered for this ref will be returned.", + "in": "QUERY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -57155,12 +58502,12 @@ "deprecated": null }, { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "PATH", + "name": "time_period", + "description": "The time period to filter by.\n\nFor example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours).", + "in": "QUERY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": ["hour", "day", "week", "month"], "allowNull": false, "mapToData": null, "validation": null, @@ -57168,55 +58515,25 @@ "deprecated": null }, { - "name": "asset_id", - "description": "The unique identifier of the asset.", - "in": "PATH", - "type": "integer", - "required": true, + "name": "actor_name", + "description": "The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned.", + "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": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"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": 302, "description": "Found", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a release by tag name", - "scope": "repos", - "id": "getReleaseByTag", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/tags/{tag}", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Get a published release with the specified tag.", - "documentationUrl": "https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name", - "previews": [], - "headers": [], - "parameters": [ { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", + "name": "rule_suite_result", + "description": "The rule results to filter on. When specified, only suites with this result will be returned.", + "in": "QUERY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": ["pass", "fail", "bypass", "all"], "allowNull": false, "mapToData": null, "validation": null, @@ -57224,11 +58541,11 @@ "deprecated": null }, { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "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, @@ -57237,11 +58554,11 @@ "deprecated": null }, { - "name": "tag", - "description": "tag parameter", - "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, @@ -57256,11 +58573,12 @@ "description": "Response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"discussion_url\":\"https://github.com/octocat/Hello-World/discussions/90\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"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},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"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": "[{\"id\":21,\"actor_id\":12,\"username\":\"octocat\",\"before_sha\":\"893f768e172fb1bc9c5d6f3dd48557e45f14e01d\",\"after_sha\":\"dedd88641a362b6b4ea872da4847d6131a164d01\",\"ref\":\"refs/heads/i-see-everything\",\"repository_id\":404,\"repository_name\":\"octo-repo\",\"pushed_at\":\"2023-07-06T08:43:03Z\",\"result\":\"bypass\"},{\"id\":25,\"actor_id\":11,\"username\":\"not-octocat\",\"before_sha\":\"48994e4e01ccc943624c6231f172702b82b233cc\",\"after_sha\":\"ecfd5a1025fa271a33ca5608d089476a2df3c9a1\",\"ref\":\"refs/heads/i-am-everything\",\"repository_id\":404,\"repository_name\":\"octo-repo\",\"pushed_at\":\"2023-07-07T08:43:03Z\",\"result\":\"pass\",\"evaluation_result\":\"fail\"}]" } ] }, - { "code": 404, "description": "Resource not found", "examples": null } + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 500, "description": "Internal Error", "examples": null } ], "renamed": null }, @@ -57865,7 +59183,7 @@ }, { "name": "hook_id", - "description": "The unique identifier of the hook.", + "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", "in": "PATH", "type": "integer", "required": true, @@ -57933,7 +59251,7 @@ }, { "name": "hook_id", - "description": "The unique identifier of the hook.", + "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", "in": "PATH", "type": "integer", "required": true, @@ -58000,7 +59318,7 @@ }, { "name": "hook_id", - "description": "The unique identifier of the hook.", + "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", "in": "PATH", "type": "integer", "required": true, @@ -58054,7 +59372,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users.\n\nFor more information about viewing repository activity,\nsee \"[Viewing repository activity](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/viewing-repository-activity).\"", + "description": "Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users.\n\nFor more information about viewing repository activity,\nsee \"[Viewing activity and data for your repository](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository).\"", "documentationUrl": "https://docs.github.com/rest/repos/repos#list-repository-activities", "previews": [], "headers": [], @@ -60882,7 +62200,7 @@ }, { "name": "hook_id", - "description": "The unique identifier of the hook.", + "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", "in": "PATH", "type": "integer", "required": true, @@ -61267,7 +62585,7 @@ }, { "name": "hook_id", - "description": "The unique identifier of the hook.", + "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", "in": "PATH", "type": "integer", "required": true, @@ -61327,7 +62645,7 @@ }, { "name": "hook_id", - "description": "The unique identifier of the hook.", + "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", "in": "PATH", "type": "integer", "required": true, @@ -62489,7 +63807,7 @@ }, { "name": "hook_id", - "description": "The unique identifier of the hook.", + "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", "in": "PATH", "type": "integer", "required": true, @@ -63632,7 +64950,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Updates a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", + "description": "Updates a deployment branch or tag policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy", "previews": [], "headers": [], @@ -63996,7 +65314,7 @@ }, { "name": "bypass_actors[].actor_id", - "description": "The ID of the actor that can bypass a ruleset", + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`.", "in": "BODY", "type": "integer", "required": true, @@ -64065,7 +65383,7 @@ "in": "BODY", "type": "string", "required": true, - "enum": ["tag_name_pattern"], + "enum": ["workflows"], "allowNull": false, "mapToData": null, "validation": null, @@ -64279,6 +65597,71 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "rules[].parameters.workflows", + "description": "Workflows that must pass for this rule to pass.", + "in": "BODY", + "type": "object[]", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "rules[].parameters.workflows[].path", + "description": "The path to the workflow file", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "rules[].parameters.workflows[].ref", + "description": "The ref (branch or tag) of the workflow file to use", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "rules[].parameters.workflows[].repository_id", + "description": "The ID of the repository where the workflow is defined", + "in": "BODY", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "rules[].parameters.workflows[].sha", + "description": "The commit SHA of the workflow file to use", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -64913,7 +66296,7 @@ }, { "name": "bypass_actors[].actor_id", - "description": "The ID of the actor that can bypass a ruleset", + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`.", "in": "BODY", "type": "integer", "required": true, @@ -65021,7 +66404,7 @@ "in": "BODY", "type": "string", "required": true, - "enum": ["tag_name_pattern"], + "enum": ["workflows"], "allowNull": false, "mapToData": null, "validation": null, @@ -65235,6 +66618,71 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "rules[].parameters.workflows", + "description": "Workflows that must pass for this rule to pass.", + "in": "BODY", + "type": "object[]", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "rules[].parameters.workflows[].path", + "description": "The path to the workflow file", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "rules[].parameters.workflows[].ref", + "description": "The ref (branch or tag) of the workflow file to use", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "rules[].parameters.workflows[].repository_id", + "description": "The ID of the repository where the workflow is defined", + "in": "BODY", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "rules[].parameters.workflows[].sha", + "description": "The commit SHA of the workflow file to use", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -65575,7 +67023,7 @@ }, { "name": "hook_id", - "description": "The unique identifier of the hook.", + "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", "in": "PATH", "type": "integer", "required": true, @@ -65791,7 +67239,7 @@ }, { "name": "hook_id", - "description": "The unique identifier of the hook.", + "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", "in": "PATH", "type": "integer", "required": true, diff --git a/src/generated/endpoints.ts b/src/generated/endpoints.ts index dd0b2fda2..856bd0d2a 100644 --- a/src/generated/endpoints.ts +++ b/src/generated/endpoints.ts @@ -101,6 +101,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = { enableWorkflow: [ "PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable", ], + forceCancelWorkflowRun: [ + "POST /repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel", + ], generateRunnerJitconfigForOrg: [ "POST /orgs/{org}/actions/runners/generate-jitconfig", ], @@ -510,6 +513,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = { addSelectedRepoToOrgSecret: [ "PUT /orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}", ], + checkPermissionsForDevcontainer: [ + "GET /repos/{owner}/{repo}/codespaces/permissions_check", + ], codespaceMachinesForAuthenticatedUser: [ "GET /user/codespaces/{codespace_name}/machines", ], @@ -627,7 +633,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { "DELETE /orgs/{org}/copilot/billing/selected_users", ], getCopilotOrganizationDetails: ["GET /orgs/{org}/copilot/billing"], - getCopilotSeatAssignmentDetailsForUser: [ + getCopilotSeatDetailsForUser: [ "GET /orgs/{org}/members/{username}/copilot", ], listCopilotSeats: ["GET /orgs/{org}/copilot/billing/seats"], @@ -840,7 +846,14 @@ const Endpoints: EndpointsDefaultsAndDecorations = { root: ["GET /"], }, migrations: { - cancelImport: ["DELETE /repos/{owner}/{repo}/import"], + cancelImport: [ + "DELETE /repos/{owner}/{repo}/import", + {}, + { + deprecated: + "octokit.rest.migrations.cancelImport() is deprecated, see https://docs.github.com/rest/migrations/source-imports#cancel-an-import", + }, + ], deleteArchiveForAuthenticatedUser: [ "DELETE /user/migrations/{migration_id}/archive", ], @@ -853,9 +866,30 @@ const Endpoints: EndpointsDefaultsAndDecorations = { getArchiveForAuthenticatedUser: [ "GET /user/migrations/{migration_id}/archive", ], - getCommitAuthors: ["GET /repos/{owner}/{repo}/import/authors"], - getImportStatus: ["GET /repos/{owner}/{repo}/import"], - getLargeFiles: ["GET /repos/{owner}/{repo}/import/large_files"], + getCommitAuthors: [ + "GET /repos/{owner}/{repo}/import/authors", + {}, + { + deprecated: + "octokit.rest.migrations.getCommitAuthors() is deprecated, see https://docs.github.com/rest/migrations/source-imports#get-commit-authors", + }, + ], + getImportStatus: [ + "GET /repos/{owner}/{repo}/import", + {}, + { + deprecated: + "octokit.rest.migrations.getImportStatus() is deprecated, see https://docs.github.com/rest/migrations/source-imports#get-an-import-status", + }, + ], + getLargeFiles: [ + "GET /repos/{owner}/{repo}/import/large_files", + {}, + { + deprecated: + "octokit.rest.migrations.getLargeFiles() is deprecated, see https://docs.github.com/rest/migrations/source-imports#get-large-files", + }, + ], getStatusForAuthenticatedUser: ["GET /user/migrations/{migration_id}"], getStatusForOrg: ["GET /orgs/{org}/migrations/{migration_id}"], listForAuthenticatedUser: ["GET /user/migrations"], @@ -869,18 +903,46 @@ const Endpoints: EndpointsDefaultsAndDecorations = { {}, { renamed: ["migrations", "listReposForAuthenticatedUser"] }, ], - mapCommitAuthor: ["PATCH /repos/{owner}/{repo}/import/authors/{author_id}"], - setLfsPreference: ["PATCH /repos/{owner}/{repo}/import/lfs"], + mapCommitAuthor: [ + "PATCH /repos/{owner}/{repo}/import/authors/{author_id}", + {}, + { + deprecated: + "octokit.rest.migrations.mapCommitAuthor() is deprecated, see https://docs.github.com/rest/migrations/source-imports#map-a-commit-author", + }, + ], + setLfsPreference: [ + "PATCH /repos/{owner}/{repo}/import/lfs", + {}, + { + deprecated: + "octokit.rest.migrations.setLfsPreference() is deprecated, see https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference", + }, + ], startForAuthenticatedUser: ["POST /user/migrations"], startForOrg: ["POST /orgs/{org}/migrations"], - startImport: ["PUT /repos/{owner}/{repo}/import"], + startImport: [ + "PUT /repos/{owner}/{repo}/import", + {}, + { + deprecated: + "octokit.rest.migrations.startImport() is deprecated, see https://docs.github.com/rest/migrations/source-imports#start-an-import", + }, + ], unlockRepoForAuthenticatedUser: [ "DELETE /user/migrations/{migration_id}/repos/{repo_name}/lock", ], unlockRepoForOrg: [ "DELETE /orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock", ], - updateImport: ["PATCH /repos/{owner}/{repo}/import"], + updateImport: [ + "PATCH /repos/{owner}/{repo}/import", + {}, + { + deprecated: + "octokit.rest.migrations.updateImport() is deprecated, see https://docs.github.com/rest/migrations/source-imports#update-an-import", + }, + ], }, orgs: { addSecurityManagerTeam: [ @@ -895,6 +957,13 @@ const Endpoints: EndpointsDefaultsAndDecorations = { "PUT /orgs/{org}/outside_collaborators/{username}", ], createInvitation: ["POST /orgs/{org}/invitations"], + createOrUpdateCustomProperties: ["PATCH /orgs/{org}/properties/schema"], + createOrUpdateCustomPropertiesValuesForRepos: [ + "PATCH /orgs/{org}/properties/values", + ], + createOrUpdateCustomProperty: [ + "PUT /orgs/{org}/properties/schema/{custom_property_name}", + ], createWebhook: ["POST /orgs/{org}/hooks"], delete: ["DELETE /orgs/{org}"], deleteWebhook: ["DELETE /orgs/{org}/hooks/{hook_id}"], @@ -902,6 +971,10 @@ const Endpoints: EndpointsDefaultsAndDecorations = { "POST /orgs/{org}/{security_product}/{enablement}", ], get: ["GET /orgs/{org}"], + getAllCustomProperties: ["GET /orgs/{org}/properties/schema"], + getCustomProperty: [ + "GET /orgs/{org}/properties/schema/{custom_property_name}", + ], getMembershipForAuthenticatedUser: ["GET /user/memberships/orgs/{org}"], getMembershipForUser: ["GET /orgs/{org}/memberships/{username}"], getWebhook: ["GET /orgs/{org}/hooks/{hook_id}"], @@ -912,6 +985,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { list: ["GET /organizations"], listAppInstallations: ["GET /orgs/{org}/installations"], listBlockedUsers: ["GET /orgs/{org}/blocks"], + listCustomPropertiesValuesForRepos: ["GET /orgs/{org}/properties/values"], listFailedInvitations: ["GET /orgs/{org}/failed_invitations"], listForAuthenticatedUser: ["GET /user/orgs"], listForUser: ["GET /users/{username}/orgs"], @@ -936,6 +1010,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = { redeliverWebhookDelivery: [ "POST /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts", ], + removeCustomProperty: [ + "DELETE /orgs/{org}/properties/schema/{custom_property_name}", + ], removeMember: ["DELETE /orgs/{org}/members/{username}"], removeMembershipForUser: ["DELETE /orgs/{org}/memberships/{username}"], removeOutsideCollaborator: [ @@ -1416,6 +1493,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { getCustomDeploymentProtectionRule: [ "GET /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}", ], + getCustomPropertiesValues: ["GET /repos/{owner}/{repo}/properties/values"], getDeployKey: ["GET /repos/{owner}/{repo}/keys/{key_id}"], getDeployment: ["GET /repos/{owner}/{repo}/deployments/{deployment_id}"], getDeploymentBranchPolicy: [ @@ -1429,6 +1507,8 @@ const Endpoints: EndpointsDefaultsAndDecorations = { ], getLatestPagesBuild: ["GET /repos/{owner}/{repo}/pages/builds/latest"], getLatestRelease: ["GET /repos/{owner}/{repo}/releases/latest"], + getOrgRuleSuite: ["GET /orgs/{org}/rulesets/rule-suites/{rule_suite_id}"], + getOrgRuleSuites: ["GET /orgs/{org}/rulesets/rule-suites"], getOrgRuleset: ["GET /orgs/{org}/rulesets/{ruleset_id}"], getOrgRulesets: ["GET /orgs/{org}/rulesets"], getPages: ["GET /repos/{owner}/{repo}/pages"], @@ -1444,6 +1524,10 @@ const Endpoints: EndpointsDefaultsAndDecorations = { getRelease: ["GET /repos/{owner}/{repo}/releases/{release_id}"], getReleaseAsset: ["GET /repos/{owner}/{repo}/releases/assets/{asset_id}"], getReleaseByTag: ["GET /repos/{owner}/{repo}/releases/tags/{tag}"], + getRepoRuleSuite: [ + "GET /repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}", + ], + getRepoRuleSuites: ["GET /repos/{owner}/{repo}/rulesets/rule-suites"], getRepoRuleset: ["GET /repos/{owner}/{repo}/rulesets/{ruleset_id}"], getRepoRulesets: ["GET /repos/{owner}/{repo}/rulesets"], getStatusChecksProtection: [ diff --git a/src/generated/method-types.ts b/src/generated/method-types.ts index 7ee54f07b..d7d9773b8 100644 --- a/src/generated/method-types.ts +++ b/src/generated/method-types.ts @@ -24,7 +24,6 @@ export type RestEndpointMethods = { * 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. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -92,7 +91,6 @@ export type RestEndpointMethods = { * Cancels a workflow run using its `id`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:write` permission to use this endpoint. */ cancelWorkflowRun: { @@ -108,7 +106,6 @@ export type RestEndpointMethods = { * Create an environment variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -288,7 +285,6 @@ export type RestEndpointMethods = { * expires after one hour. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * @@ -339,7 +335,6 @@ export type RestEndpointMethods = { * a repository. The token expires after one hour. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * @@ -363,7 +358,6 @@ export type RestEndpointMethods = { * Creates a repository variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -456,7 +450,6 @@ export type RestEndpointMethods = { * Deletes an environment variable using the variable name. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -523,7 +516,6 @@ export type RestEndpointMethods = { * Deletes a repository variable using the variable name. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -557,7 +549,6 @@ export type RestEndpointMethods = { * Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -713,6 +704,22 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job. + * You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-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. + */ + forceCancelWorkflowRun: { + ( + params?: RestEndpointMethodTypes["actions"]["forceCancelWorkflowRun"]["parameters"], + ): Promise< + RestEndpointMethodTypes["actions"]["forceCancelWorkflowRun"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Generates a configuration that can be passed to the runner application at startup. * @@ -734,7 +741,6 @@ export type RestEndpointMethods = { * Generates a configuration that can be passed to the runner application at startup. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -879,7 +885,6 @@ export type RestEndpointMethods = { * Gets a specific variable in an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environments:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -1083,7 +1088,6 @@ export type RestEndpointMethods = { * Gets a specific variable in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -1129,7 +1133,6 @@ export type RestEndpointMethods = { * Gets a specific self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -1257,7 +1260,6 @@ export type RestEndpointMethods = { * Lists all environment variables. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environments:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -1315,7 +1317,6 @@ export type RestEndpointMethods = { * 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. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -1380,7 +1381,6 @@ export type RestEndpointMethods = { * Lists all organiation variables shared with a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -1413,7 +1413,6 @@ export type RestEndpointMethods = { /** * Lists all repository variables. * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -1459,7 +1458,6 @@ export type RestEndpointMethods = { * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -1543,7 +1541,6 @@ export type RestEndpointMethods = { * Lists all self-hosted runners configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -1600,7 +1597,6 @@ export type RestEndpointMethods = { * 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. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:write` permission to use this endpoint. */ reRunJobForWorkflowRun: { @@ -1659,7 +1655,6 @@ export type RestEndpointMethods = { * 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. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -1701,7 +1696,6 @@ export type RestEndpointMethods = { * present on the runner. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -1835,7 +1829,6 @@ export type RestEndpointMethods = { * self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -1982,7 +1975,6 @@ export type RestEndpointMethods = { * Updates an environment variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -2016,7 +2008,6 @@ export type RestEndpointMethods = { * Updates a repository variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -3107,9 +3098,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * + * **Note:** The endpoints to manage checks only look 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. + * + * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. */ listForRef: { ( @@ -3119,9 +3112,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * + * **Note:** The endpoints to manage checks only look 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. */ listForSuite: { ( @@ -3131,9 +3124,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - * * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. + * + * **Note:** The endpoints to manage checks only look 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`. */ listSuitesForRef: { ( @@ -3185,9 +3178,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. + * + * **Note:** The endpoints to manage checks only look 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. */ update: { ( @@ -3599,6 +3592,22 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user. + * + * 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. + */ + checkPermissionsForDevcontainer: { + ( + params?: RestEndpointMethodTypes["codespaces"]["checkPermissionsForDevcontainer"]["parameters"], + ): Promise< + RestEndpointMethodTypes["codespaces"]["checkPermissionsForDevcontainer"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * List the machine types a codespace can transition to use. * @@ -4349,11 +4358,11 @@ export type RestEndpointMethods = { * * Organization owners and members with admin permissions can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. */ - getCopilotSeatAssignmentDetailsForUser: { + getCopilotSeatDetailsForUser: { ( - params?: RestEndpointMethodTypes["copilot"]["getCopilotSeatAssignmentDetailsForUser"]["parameters"], + params?: RestEndpointMethodTypes["copilot"]["getCopilotSeatDetailsForUser"]["parameters"], ): Promise< - RestEndpointMethodTypes["copilot"]["getCopilotSeatAssignmentDetailsForUser"]["response"] + RestEndpointMethodTypes["copilot"]["getCopilotSeatDetailsForUser"]["response"] >; defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; @@ -5979,9 +5988,9 @@ export type RestEndpointMethods = { /** * Stop an import for a repository. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * + * @deprecated octokit.rest.migrations.cancelImport() is deprecated, see https://docs.github.com/rest/migrations/source-imports#cancel-an-import */ cancelImport: { ( @@ -6065,9 +6074,8 @@ export type RestEndpointMethods = { * * This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * @deprecated octokit.rest.migrations.getCommitAuthors() is deprecated, see https://docs.github.com/rest/migrations/source-imports#get-commit-authors */ getCommitAuthors: { ( @@ -6081,9 +6089,7 @@ export type RestEndpointMethods = { /** * View the progress of an import. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * * **Import status** * @@ -6117,6 +6123,7 @@ export type RestEndpointMethods = { * * `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step. * * `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository. * * `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request. + * @deprecated octokit.rest.migrations.getImportStatus() is deprecated, see https://docs.github.com/rest/migrations/source-imports#get-an-import-status */ getImportStatus: { ( @@ -6130,9 +6137,9 @@ export type RestEndpointMethods = { /** * List files larger than 100MB found during the import * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * + * @deprecated octokit.rest.migrations.getLargeFiles() is deprecated, see https://docs.github.com/rest/migrations/source-imports#get-large-files */ getLargeFiles: { ( @@ -6248,9 +6255,9 @@ export type RestEndpointMethods = { * Update an author's identity for the import. Your application can continue updating authors any time before you push * new commits to the repository. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * + * @deprecated octokit.rest.migrations.mapCommitAuthor() is deprecated, see https://docs.github.com/rest/migrations/source-imports#map-a-commit-author */ mapCommitAuthor: { ( @@ -6268,9 +6275,9 @@ export type RestEndpointMethods = { * You can learn more about our LFS feature and working with large files [on our help * site](https://docs.github.com/repositories/working-with-files/managing-large-files). * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * + * @deprecated octokit.rest.migrations.setLfsPreference() is deprecated, see https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference */ setLfsPreference: { ( @@ -6306,8 +6313,13 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Start a source import to a GitHub repository using GitHub Importer. Importing into a GitHub repository with GitHub Actions enabled is not supported and will return a status `422 Unprocessable Entity` response. - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * Start a source import to a GitHub repository using GitHub Importer. + * Importing into a GitHub repository with GitHub Actions enabled is not supported and will + * return a status `422 Unprocessable Entity` response. + * + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * + * @deprecated octokit.rest.migrations.startImport() is deprecated, see https://docs.github.com/rest/migrations/source-imports#start-an-import */ startImport: { ( @@ -6350,9 +6362,8 @@ export type RestEndpointMethods = { * 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. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * @deprecated octokit.rest.migrations.updateImport() is deprecated, see https://docs.github.com/rest/migrations/source-imports#update-an-import */ updateImport: { ( @@ -6467,6 +6478,51 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Creates new or updates existing custom properties defined for an organization in a batch. + * Only organization owners (or users with the proper permissions granted by them) can update these properties + */ + createOrUpdateCustomProperties: { + ( + params?: RestEndpointMethodTypes["orgs"]["createOrUpdateCustomProperties"]["parameters"], + ): Promise< + RestEndpointMethodTypes["orgs"]["createOrUpdateCustomProperties"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Create new or update existing custom property values for repositories in a batch that belong to an organization. + * Each target repository will have its custom property values updated to match the values provided in the request. + * + * A maximum of 30 repositories can be updated in a single request. + * + * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + * + * Only organization owners (or users with the proper permissions granted by them) can update these properties + */ + createOrUpdateCustomPropertiesValuesForRepos: { + ( + params?: RestEndpointMethodTypes["orgs"]["createOrUpdateCustomPropertiesValuesForRepos"]["parameters"], + ): Promise< + RestEndpointMethodTypes["orgs"]["createOrUpdateCustomPropertiesValuesForRepos"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Creates a new or updates an existing custom property that is defined for an organization. + * You must be an organization owner to use this endpoint. + */ + createOrUpdateCustomProperty: { + ( + params?: RestEndpointMethodTypes["orgs"]["createOrUpdateCustomProperty"]["parameters"], + ): Promise< + RestEndpointMethodTypes["orgs"]["createOrUpdateCustomProperty"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Here's how you can create a hook that posts payloads in JSON format: */ @@ -6532,6 +6588,32 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Gets all custom properties defined for an organization. + * You must be an organization owner to use this endpoint. + */ + getAllCustomProperties: { + ( + params?: RestEndpointMethodTypes["orgs"]["getAllCustomProperties"]["parameters"], + ): Promise< + RestEndpointMethodTypes["orgs"]["getAllCustomProperties"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Gets a custom property that is defined for an organization. + * You must be an organization owner to use this endpoint. + */ + getCustomProperty: { + ( + params?: RestEndpointMethodTypes["orgs"]["getCustomProperty"]["parameters"], + ): Promise< + RestEndpointMethodTypes["orgs"]["getCustomProperty"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a `404` is returned. This endpoint will return a `403` if the request is made by a GitHub App that is blocked by the organization. */ @@ -6628,6 +6710,19 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Lists organization repositories with all of their custom property values. + * Organization members can read these properties. + */ + listCustomPropertiesValuesForRepos: { + ( + params?: RestEndpointMethodTypes["orgs"]["listCustomPropertiesValuesForRepos"]["parameters"], + ): Promise< + RestEndpointMethodTypes["orgs"]["listCustomPropertiesValuesForRepos"]["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. */ @@ -6854,6 +6949,19 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Removes a custom property that is defined for an organization. + * You must be an organization owner to use this endpoint. + */ + removeCustomProperty: { + ( + params?: RestEndpointMethodTypes["orgs"]["removeCustomProperty"]["parameters"], + ): Promise< + RestEndpointMethodTypes["orgs"]["removeCustomProperty"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. */ @@ -8368,7 +8476,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * List the reactions to a [pull request review comment](https://docs.github.com/pulls/comments#get-a-review-comment-for-a-pull-request). + * List the reactions to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ listForPullRequestReviewComment: { ( @@ -8824,7 +8932,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Creates a deployment branch policy for an environment. + * Creates a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -9234,7 +9342,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Deletes a deployment branch policy for an environment. + * Deletes a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -9813,10 +9921,8 @@ export type RestEndpointMethods = { * README, and CONTRIBUTING files. * * The `health_percentage` score is defined as a percentage of how many of - * these four documents are present: README, CONTRIBUTING, LICENSE, and - * CODE_OF_CONDUCT. For example, if all four documents are present, then - * the `health_percentage` is `100`. If only one is present, then the - * `health_percentage` is `25`. + * the recommended community health files are present. For more information, see + * "[About community profiles for public repositories](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)." * * `content_reports_enabled` is only returned for organization-owned repositories. */ @@ -9906,6 +10012,19 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Gets all custom property values that are set for a repository. + * Users with admin access to the repository can use this endpoint. + */ + getCustomPropertiesValues: { + ( + params?: RestEndpointMethodTypes["repos"]["getCustomPropertiesValues"]["parameters"], + ): Promise< + RestEndpointMethodTypes["repos"]["getCustomPropertiesValues"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; getDeployKey: { ( @@ -9923,7 +10042,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets a deployment branch policy for an environment. + * Gets a deployment branch or tag policy for an environment. * * 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. */ @@ -9992,6 +10111,32 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Gets information about a suite of rule evaluations from within an organization. + * For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." + */ + getOrgRuleSuite: { + ( + params?: RestEndpointMethodTypes["repos"]["getOrgRuleSuite"]["parameters"], + ): Promise< + RestEndpointMethodTypes["repos"]["getOrgRuleSuite"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Lists suites of rule evaluations at the organization level. + * For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." + */ + getOrgRuleSuites: { + ( + params?: RestEndpointMethodTypes["repos"]["getOrgRuleSuites"]["parameters"], + ): Promise< + RestEndpointMethodTypes["repos"]["getOrgRuleSuites"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Get a repository ruleset for an organization. */ @@ -10160,6 +10305,32 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Gets information about a suite of rule evaluations from within a repository. + * For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." + */ + getRepoRuleSuite: { + ( + params?: RestEndpointMethodTypes["repos"]["getRepoRuleSuite"]["parameters"], + ): Promise< + RestEndpointMethodTypes["repos"]["getRepoRuleSuite"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Lists suites of rule evaluations at the repository level. + * For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." + */ + getRepoRuleSuites: { + ( + params?: RestEndpointMethodTypes["repos"]["getRepoRuleSuites"]["parameters"], + ): Promise< + RestEndpointMethodTypes["repos"]["getRepoRuleSuites"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Get a ruleset for a repository. */ @@ -10296,7 +10467,7 @@ export type RestEndpointMethods = { * Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users. * * For more information about viewing repository activity, - * see "[Viewing repository activity](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/viewing-repository-activity)." + * see "[Viewing activity and data for your repository](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository)." */ listActivities: { ( @@ -11045,7 +11216,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Updates a deployment branch policy for an environment. + * Updates a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ diff --git a/src/generated/parameters-and-response-types.ts b/src/generated/parameters-and-response-types.ts index 7bac0ba4a..49645408e 100644 --- a/src/generated/parameters-and-response-types.ts +++ b/src/generated/parameters-and-response-types.ts @@ -306,6 +306,14 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable"]["response"]; }; + forceCancelWorkflowRun: { + parameters: RequestParameters & + Omit< + Endpoints["POST /repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["POST /repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel"]["response"]; + }; generateRunnerJitconfigForOrg: { parameters: RequestParameters & Omit< @@ -1848,6 +1856,14 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["PUT /orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}"]["response"]; }; + checkPermissionsForDevcontainer: { + parameters: RequestParameters & + Omit< + Endpoints["GET /repos/{owner}/{repo}/codespaces/permissions_check"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /repos/{owner}/{repo}/codespaces/permissions_check"]["response"]; + }; codespaceMachinesForAuthenticatedUser: { parameters: RequestParameters & Omit< @@ -2226,7 +2242,7 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /orgs/{org}/copilot/billing"]["response"]; }; - getCopilotSeatAssignmentDetailsForUser: { + getCopilotSeatDetailsForUser: { parameters: RequestParameters & Omit< Endpoints["GET /orgs/{org}/members/{username}/copilot"]["parameters"], @@ -3476,6 +3492,30 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["POST /orgs/{org}/invitations"]["response"]; }; + createOrUpdateCustomProperties: { + parameters: RequestParameters & + Omit< + Endpoints["PATCH /orgs/{org}/properties/schema"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PATCH /orgs/{org}/properties/schema"]["response"]; + }; + createOrUpdateCustomPropertiesValuesForRepos: { + parameters: RequestParameters & + Omit< + Endpoints["PATCH /orgs/{org}/properties/values"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PATCH /orgs/{org}/properties/values"]["response"]; + }; + createOrUpdateCustomProperty: { + parameters: RequestParameters & + Omit< + Endpoints["PUT /orgs/{org}/properties/schema/{custom_property_name}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["PUT /orgs/{org}/properties/schema/{custom_property_name}"]["response"]; + }; createWebhook: { parameters: RequestParameters & Omit< @@ -3516,6 +3556,22 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /orgs/{org}"]["response"]; }; + getAllCustomProperties: { + parameters: RequestParameters & + Omit< + Endpoints["GET /orgs/{org}/properties/schema"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /orgs/{org}/properties/schema"]["response"]; + }; + getCustomProperty: { + parameters: RequestParameters & + Omit< + Endpoints["GET /orgs/{org}/properties/schema/{custom_property_name}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /orgs/{org}/properties/schema/{custom_property_name}"]["response"]; + }; getMembershipForAuthenticatedUser: { parameters: RequestParameters & Omit< @@ -3580,6 +3636,14 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /orgs/{org}/blocks"]["response"]; }; + listCustomPropertiesValuesForRepos: { + parameters: RequestParameters & + Omit< + Endpoints["GET /orgs/{org}/properties/values"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /orgs/{org}/properties/values"]["response"]; + }; listFailedInvitations: { parameters: RequestParameters & Omit< @@ -3724,6 +3788,14 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["POST /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts"]["response"]; }; + removeCustomProperty: { + parameters: RequestParameters & + Omit< + Endpoints["DELETE /orgs/{org}/properties/schema/{custom_property_name}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["DELETE /orgs/{org}/properties/schema/{custom_property_name}"]["response"]; + }; removeMember: { parameters: RequestParameters & Omit< @@ -5440,6 +5512,14 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}"]["response"]; }; + getCustomPropertiesValues: { + parameters: RequestParameters & + Omit< + Endpoints["GET /repos/{owner}/{repo}/properties/values"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /repos/{owner}/{repo}/properties/values"]["response"]; + }; getDeployKey: { parameters: RequestParameters & Omit< @@ -5496,6 +5576,22 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /repos/{owner}/{repo}/releases/latest"]["response"]; }; + getOrgRuleSuite: { + parameters: RequestParameters & + Omit< + Endpoints["GET /orgs/{org}/rulesets/rule-suites/{rule_suite_id}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /orgs/{org}/rulesets/rule-suites/{rule_suite_id}"]["response"]; + }; + getOrgRuleSuites: { + parameters: RequestParameters & + Omit< + Endpoints["GET /orgs/{org}/rulesets/rule-suites"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /orgs/{org}/rulesets/rule-suites"]["response"]; + }; getOrgRuleset: { parameters: RequestParameters & Omit< @@ -5600,6 +5696,22 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /repos/{owner}/{repo}/releases/tags/{tag}"]["response"]; }; + getRepoRuleSuite: { + parameters: RequestParameters & + Omit< + Endpoints["GET /repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}"]["response"]; + }; + getRepoRuleSuites: { + parameters: RequestParameters & + Omit< + Endpoints["GET /repos/{owner}/{repo}/rulesets/rule-suites"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /repos/{owner}/{repo}/rulesets/rule-suites"]["response"]; + }; getRepoRuleset: { parameters: RequestParameters & Omit<