Get the GitHub-hosted runners limits for an organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Get the GitHub-hosted runners limits for an organization.
" + ] }, { "serverUrl": "https://api.github.com", @@ -5962,7 +5962,7 @@ "type": "array of strings", "name": "patterns_allowed", "in": "body", - "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to private repositories.\nFor more information, see \"Allowing access to components in a private repository.\"
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to private repositories.\nFor more information, see \"Allowing access to components in a private repository.\"
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for a repository.\"
OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for a repository.\"
OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Lists all secrets available in an organization without revealing their\nencrypted values.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
OK
" } - ], - "descriptionHTML": "Lists all secrets available in an organization without revealing their\nencrypted values.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Creates a new self-hosted runner group for an organization.
\nOAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Created
" } - ], - "descriptionHTML": "Creates a new self-hosted runner group for an organization.
\nOAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Gets a specific self-hosted runner group for an organization.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets a specific self-hosted runner group for an organization.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Deletes a self-hosted runner group for an organization.
\nOAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Deletes a self-hosted runner group for an organization.
\nOAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Lists all organization variables.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
OK
" } - ], - "descriptionHTML": "Lists all organization variables.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"Using environments for deployment.\"
\nNote
\n\nGitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"Using environments for deployment.\"
\nNote
\n\nGitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Warning
\n
\nThis endpoint is in the process of closing down. Refer to \"Actions Get workflow usage and Get workflow run usage endpoints closing down\" for more information.
Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Warning
\n
\nThis endpoint is in the process of closing down. Refer to \"Actions Get workflow usage and Get workflow run usage endpoints closing down\" for more information.
Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Warning
\n
\nThis endpoint is in the process of closing down. Refer to \"Actions Get workflow usage and Get workflow run usage endpoints closing down\" for more information.
Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".
\nYou can replace workflow_id with the workflow file name. For example, you could use main.yaml.
Anyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Warning
\n
\nThis endpoint is in the process of closing down. Refer to \"Actions Get workflow usage and Get workflow run usage endpoints closing down\" for more information.
Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".
\nYou can replace workflow_id with the workflow file name. For example, you could use main.yaml.
Anyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Note
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nIf you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. Optional: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nIf you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. Optional: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nThis is the user's organization dashboard. You must be authenticated as the user to view this.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nThis is the user's organization dashboard. You must be authenticated as the user to view this.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nOK
" } - ], - "descriptionHTML": "Note
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nThese are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nThese are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nLists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.
\nuri_template. For more information, see \"Hypermedia.\"By default, timeline resources are returned in JSON. You can specify the application/atom+xml type in the Accept header to return timeline resources in Atom format. For more information, see \"Media types.\"
Note
\n\nPrivate feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
\nLists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.
\nuri_template. For more information, see \"Hypermedia.\"By default, timeline resources are returned in JSON. You can specify the application/atom+xml type in the Accept header to return timeline resources in Atom format. For more information, see \"Media types.\"
Note
\n\nPrivate feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
\nNote
\n\nThe :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).
Note
\n\nThe :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).
Gets the summary of the free and paid GitHub Actions minutes used.
\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".
\nOAuth app tokens and personal access tokens (classic) need the repo or admin:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets the summary of the free and paid GitHub Actions minutes used.
\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".
\nOAuth app tokens and personal access tokens (classic) need the repo or admin:org scope to use this endpoint.
Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nOAuth app tokens and personal access tokens (classic) need the repo or admin:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nOAuth app tokens and personal access tokens (classic) need the repo or admin:org scope to use this endpoint.
Renames a branch in a repository.
\nNote
\n\nAlthough the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".
\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.
\nIn order to rename the default branch, fine-grained access tokens also need the administration:write repository permission.
Renames a branch in a repository.
\nNote
\n\nAlthough the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".
\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.
\nIn order to rename the default branch, fine-grained access tokens also need the administration:write repository permission.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nProtecting a branch requires admin or owner permissions to the repository.
\nNote
\n\nPassing new arrays of users and teams replaces their previous values.
Note
\n\nThe list of users, apps, and teams in total is limited to 100 items.
\nProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nProtecting a branch requires admin or owner permissions to the repository.
\nNote
\n\nPassing new arrays of users and teams replaces their previous values.
Note
\n\nThe list of users, apps, and teams in total is limited to 100 items.
\nProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
\nNote
\n\nPassing new arrays of users and teams replaces their previous values.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
\nNote
\n\nPassing new arrays of users and teams replaces their previous values.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.
Note
\n\nYou must enable branch protection to require signed commits.
\nProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.
Note
\n\nYou must enable branch protection to require signed commits.
\nProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists who has access to this protected branch.
\nNote
\n\nUsers, apps, and teams restrictions are only available for organization-owned repositories.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists who has access to this protected branch.
\nNote
\n\nUsers, apps, and teams restrictions are only available for organization-owned repositories.
Creates a new check run for a specific commit in a repository.
\nTo create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.
\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
\nNote
\n\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Creates a new check run for a specific commit in a repository.
\nTo create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.
\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
\nNote
\n\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Gets a single check run using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Gets a single check run using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Updates a check run for a specific commit in a repository.
\nNote
\n\nThe 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.
OAuth apps and personal access tokens (classic) cannot use this endpoint.
", + "descriptionHTML": "Updates a check run for a specific commit in a repository.
\nNote
\n\nThe 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.
OAuth apps and personal access tokens (classic) cannot use this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -145093,7 +145093,7 @@ } ], "previews": [], - "descriptionHTML": "Lists check runs for a check suite using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check runs for a check suite using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name.
Note
\n\nThe 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 endpoint and provide the check_suite_id parameter to the List check runs in a check suite endpoint.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name.
Note
\n\nThe 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 endpoint and provide the check_suite_id parameter to the List check runs in a check suite endpoint.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Creates a check suite manually. By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"Update repository preferences for check suites\".
\nNote
\n\nThe 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.
OAuth apps and personal access tokens (classic) cannot use this endpoint.
", + "descriptionHTML": "Creates a check suite manually. By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"Update repository preferences for check suites\".
\nNote
\n\nThe 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.
OAuth apps and personal access tokens (classic) cannot use this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -153682,7 +153682,7 @@ } ], "previews": [], - "descriptionHTML": "Gets a single check suite using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Gets a single check suite using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.
The rules_count field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.
Warning
\n\nClosing down notice: The tool_name field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.
OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.
The rules_count field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.
Warning
\n\nClosing down notice: The tool_name field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.
OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Deletes an organization development environment secret using the secret name.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Resource not found
" } - ], - "descriptionHTML": "Deletes an organization development environment secret using the secret name.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nIf the repository is private, OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nIf the repository is private, OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Gets a development environment secret available to a user's codespaces without revealing its encrypted value.
\nThe authenticated user must have Codespaces access to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the codespace or codespace:secrets scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets a development environment secret available to a user's codespaces without revealing its encrypted value.
\nThe authenticated user must have Codespaces access to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the codespace or codespace:secrets scope to use this endpoint.
Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret.
\nThe authenticated user must have Codespaces access to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the codespace or codespace:secrets scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret.
\nThe authenticated user must have Codespaces access to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the codespace or codespace:secrets scope to use this endpoint.
Removes a collaborator from a repository.
\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.
\nThis endpoint also:
\nRemoving a user as a collaborator has the following effects on forks:
\nNote
\n\nA user can still have access to the repository through organization permissions like base repository permissions.
\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.
\nFor more information on fork permissions, see \"About permissions and visibility of forks\".
", + "descriptionHTML": "Removes a collaborator from a repository.
\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.
\nThis endpoint also:
\nRemoving a user as a collaborator has the following effects on forks:
\nNote
\n\nA user can still have access to the repository through organization permissions like base repository permissions.
\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.
\nFor more information on fork permissions, see \"About permissions and visibility of forks\".
", "statusCodes": [ { "httpStatusCode": "204", @@ -232723,7 +232723,7 @@ } ], "previews": [], - "descriptionHTML": "Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.
Note
\n\nIf there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\" Pagination query parameters are not supported for these media types.
\napplication/vnd.github.diff: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property. Larger diffs may time out and return a 5xx status code.application/vnd.github.sha: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
verified_at | string | The date the signature was verified by GitHub. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on their account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.
Note
\n\nIf there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\" Pagination query parameters are not supported for these media types.
\napplication/vnd.github.diff: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property. Larger diffs may time out and return a 5xx status code.application/vnd.github.sha: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
verified_at | string | The date the signature was verified by GitHub. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on their account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.
\nNote
\n\nThis endpoint will only return results for a given day if the organization contained five or more members with active Copilot licenses on that day, as evaluated at the end of that day.
\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.
\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot, read:org, or read:enterprise scopes to use this endpoint.
Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.
\nNote
\n\nThis endpoint will only return results for a given day if the organization contained five or more members with active Copilot licenses on that day, as evaluated at the end of that day.
\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.
\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot, read:org, or read:enterprise scopes to use this endpoint.
Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.
\nNote
\n\nThis endpoint will only return results for a given day if the team had five or more members with active Copilot licenses on that day, as evaluated at the end of that day.
\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.
\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings.\nOnly organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot, read:org, or read:enterprise scopes to use this endpoint.
Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.
\nNote
\n\nThis endpoint will only return results for a given day if the team had five or more members with active Copilot licenses on that day, as evaluated at the end of that day.
\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.
\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings.\nOnly organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot, read:org, or read:enterprise scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"Managing policies for Copilot in your organization.\"
\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"Managing policies for Copilot in your organization.\"
\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.
\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at.\nFor more information about activity data, see \"Reviewing user activity data for Copilot in your organization.\"
OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.
\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at.\nFor more information about activity data, see \"Reviewing user activity data for Copilot in your organization.\"
OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"About billing for GitHub Copilot in your organization.\"
\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"Subscribing to Copilot for your organization.\"\nFor more information about setting a suggestion matching policy, see \"Managing policies for Copilot in your organization.\"
\nThe response contains the total number of new seats that were created and existing seats that were refreshed.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"About billing for GitHub Copilot in your organization.\"
\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"Subscribing to Copilot for your organization.\"\nFor more information about setting a suggestion matching policy, see \"Managing policies for Copilot in your organization.\"
\nThe response contains the total number of new seats that were created and existing seats that were refreshed.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"Revoking access to Copilot for members of your organization.\"
\nOnly organization owners can cancel Copilot seats for their organization members.
\nThe response contains the total number of seats set to \"pending cancellation\".
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"Revoking access to Copilot for members of your organization.\"
\nOnly organization owners can cancel Copilot seats for their organization members.
\nThe response contains the total number of seats set to \"pending cancellation\".
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"About billing for GitHub Copilot in your organization.\"
\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"Subscribing to Copilot for your organization.\"\nFor more information about setting a suggestion matching policy, see \"Managing policies for Copilot in your organization.\"
\nThe response contains the total number of new seats that were created and existing seats that were refreshed.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"About billing for GitHub Copilot in your organization.\"
\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"Subscribing to Copilot for your organization.\"\nFor more information about setting a suggestion matching policy, see \"Managing policies for Copilot in your organization.\"
\nThe response contains the total number of new seats that were created and existing seats that were refreshed.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"Revoking access to Copilot for members of your organization.\"
\nOnly organization owners can cancel Copilot seats for their organization members.
\nThe response contains the total number of seats set to \"pending cancellation\".
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"Revoking access to Copilot for members of your organization.\"
\nOnly organization owners can cancel Copilot seats for their organization members.
\nThe response contains the total number of seats set to \"pending cancellation\".
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.
\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at.\nFor more information about activity data, see \"Reviewing user activity data for Copilot in your organization.\"
Only organization owners can view Copilot seat assignment details for members of their organization.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.
\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at.\nFor more information about activity data, see \"Reviewing user activity data for Copilot in your organization.\"
Only organization owners can view Copilot seat assignment details for members of their organization.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.
Submit a list of credentials to be revoked. This endpoint is intended to revoke credentials the caller does not own and may have found exposed on GitHub.com or elsewhere. It can also be used for credentials associated with an old user account that you no longer have access to. Credential owners will be notified of the revocation.
\nThis endpoint currently accepts the following credential types:
\nRevoked credentials may impact users on GitHub Free, Pro, & Team and GitHub Enterprise Cloud, and GitHub Enterprise Cloud with Enterprise Managed Users.\nGitHub cannot reactivate any credentials that have been revoked; new credentials will need to be generated.
\nTo prevent abuse, this API is limited to only 60 unauthenticated requests per hour and a max of 1000 tokens per API request.
\nNote
\n\nAny authenticated requests will return a 403.
\nSubmit a list of credentials to be revoked. This endpoint is intended to revoke credentials the caller does not own and may have found exposed on GitHub.com or elsewhere. It can also be used for credentials associated with an old user account that you no longer have access to. Credential owners will be notified of the revocation.
\nThis endpoint currently accepts the following credential types:
\nRevoked credentials may impact users on GitHub Free, Pro, & Team and GitHub Enterprise Cloud, and GitHub Enterprise Cloud with Enterprise Managed Users.\nGitHub cannot reactivate any credentials that have been revoked; new credentials will need to be generated.
\nTo prevent abuse, this API is limited to only 60 unauthenticated requests per hour and a max of 1000 tokens per API request.
\nNote
\n\nAny authenticated requests will return a 403.
\nNote
\n\nThis operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.
\nNote
\n\nThis operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.
\nNote
\n\nThis operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.
\nExample request body:
\n{\n \"repository_ids_to_add\": [123, 456],\n \"repository_ids_to_remove\": [789]\n}\nNote
\n\nThis operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.
\nExample request body:
\n{\n \"repository_ids_to_add\": [123, 456],\n \"repository_ids_to_remove\": [789]\n}\nNote
\n\nThis operation supports both server-to-server and user-to-server access.\nSets the default level of repository access Dependabot will have while performing an update. Available values are:
\nUnauthorized users will not see the existence of this endpoint.
", + "descriptionHTML": "Note
\n\nThis operation supports both server-to-server and user-to-server access.\nSets the default level of repository access Dependabot will have while performing an update. Available values are:
\nUnauthorized users will not see the existence of this endpoint.
", "statusCodes": [ { "httpStatusCode": "204", @@ -255927,13 +255927,13 @@ } ], "previews": [], + "descriptionHTML": "Simple filtering of deployments is available via query parameters:
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Simple filtering of deployments is available via query parameters:
" + ] }, { "serverUrl": "https://api.github.com", @@ -258329,13 +258329,13 @@ } ], "previews": [], + "descriptionHTML": "Gets a deployment branch or tag policy for an environment.
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
OK
" } - ], - "descriptionHTML": "Gets a deployment branch or tag policy for an environment.
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Note
\n\nTo get information about name patterns that branches must match in order to deploy to this environment, see \"Get a deployment branch policy.\"
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Note
\n\nTo get information about name patterns that branches must match in order to deploy to this environment, see \"Get a deployment branch policy.\"
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"Environments.\"
\nNote
\n\nTo create or update name patterns that branches must match in order to deploy to this environment, see \"Deployment branch policies.\"
\nNote
\n\nTo create or update secrets for an environment, see \"GitHub Actions secrets.\"
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"Environments.\"
\nNote
\n\nTo create or update name patterns that branches must match in order to deploy to this environment, see \"Deployment branch policies.\"
\nNote
\n\nTo create or update secrets for an environment, see \"GitHub Actions secrets.\"
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment.
\nNote
\n\nIt's recommended to use the log_url parameter, which replaces target_url.
The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment.
\nNote
\n\nIt's recommended to use the log_url parameter, which replaces target_url.
Allows you to add a new gist with one or more files.
\nNote
\n\nDon't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.
\nAllows you to add a new gist with one or more files.
\nNote
\n\nDon't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.
\nReturns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.
When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.
Note
\n\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nIf you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.
Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.
When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.
Note
\n\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nIf you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.
Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.
Note
\n\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nReturns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.
Note
\n\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nReturns a single tree using the SHA1 value or ref name for that tree.
\nIf truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.
Note
\n\nThe limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
Returns a single tree using the SHA1 value or ref name for that tree.
\nIf truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.
Note
\n\nThe limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.
Note
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.
Note
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues in an organization assigned to the authenticated user.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues in an organization assigned to the authenticated user.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues in a repository. Only open issues will be listed.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues in a repository. Only open issues will be listed.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.
Note
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.
Note
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues across owned and member repositories assigned to the authenticated user.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues across owned and member repositories assigned to the authenticated user.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Lists labels for issues in a milestone.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Lists labels for issues in a milestone.
" + ] } ], "milestones": [ @@ -341161,6 +341161,7 @@ } ], "previews": [], + "descriptionHTML": "Lists milestones for a repository.
", "statusCodes": [ { "httpStatusCode": "200", @@ -341170,8 +341171,7 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ], - "descriptionHTML": "Lists milestones for a repository.
" + ] }, { "serverUrl": "https://api.github.com", @@ -373304,7 +373304,7 @@ } ], "previews": [], - "descriptionHTML": "Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"About GitHub's IP addresses.\"
\nThe API's response also includes a list of GitHub's domain names.
\nThe values shown in the documentation's response are example values. You must always query the API directly to get the latest values.
\nNote
\n\nThis endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.
\nReturns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"About GitHub's IP addresses.\"
\nThe API's response also includes a list of GitHub's domain names.
\nThe values shown in the documentation's response are example values. You must always query the API directly to get the latest values.
\nNote
\n\nThis endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.
\nReturns a weekly aggregate of the number of additions and deletions pushed to a repository.
\nNote
\n\nThis endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned.
\nReturns a weekly aggregate of the number of additions and deletions pushed to a repository.
\nNote
\n\nThis endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned.
\nReturns the total number of commits authored by the contributor. In addition, the response includes a Weekly Hash (weeks array) with the following information:
w - Start of the week, given as a Unix timestamp.a - Number of additionsd - Number of deletionsc - Number of commitsNote
\n\nThis endpoint will return 0 values for all addition and deletion counts in repositories with 10,000 or more commits.
Returns the total number of commits authored by the contributor. In addition, the response includes a Weekly Hash (weeks array) with the following information:
w - Start of the week, given as a Unix timestamp.a - Number of additionsd - Number of deletionsc - Number of commitsNote
\n\nThis endpoint will return 0 values for all addition and deletion counts in repositories with 10,000 or more commits.
View the progress of an import.
\nWarning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nImport status
\nThis section includes details about the possible values of the status field of the Import Progress response.
An import that does not have errors will progress through these steps:
\ndetecting - the \"detection\" step of the import is in progress because the request did not include a vcs parameter. The import is identifying the type of source control present at the URL.importing - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include commit_count (the total number of raw commits that will be imported) and percent (0 - 100, the current progress through the import).mapping - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.pushing - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include push_percent, which is the percent value reported by git push when it is \"Writing objects\".complete - the import is complete, and the repository is ready on GitHub.If there are problems, you will see one of these in the status field:
auth_failed - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the Update an import section.error - the import encountered an error. The import progress response will include the failed_step and an error message. Contact GitHub Support for more information.detection_needs_auth - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the Update an import section.detection_found_nothing - the importer didn't recognize any source control at the URL. To resolve, Cancel the import and retry with the correct URL.detection_found_multiple - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a project_choices field with the possible project choices as values. To update project choice, please see the Update an import section.The project_choices field
\nWhen multiple projects are found at the provided URL, the response hash will include a project_choices field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.
Git LFS related fields
\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.
\nuse_lfs - describes whether the import has been opted in or out of using Git LFS. The value can be opt_in, opt_out, or undecided if no action has been taken.has_large_files - the boolean value describing whether files larger than 100MB were found during the importing step.large_files_size - the total size in gigabytes of files larger than 100MB found in the originating repository.large_files_count - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.View the progress of an import.
\nWarning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nImport status
\nThis section includes details about the possible values of the status field of the Import Progress response.
An import that does not have errors will progress through these steps:
\ndetecting - the \"detection\" step of the import is in progress because the request did not include a vcs parameter. The import is identifying the type of source control present at the URL.importing - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include commit_count (the total number of raw commits that will be imported) and percent (0 - 100, the current progress through the import).mapping - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.pushing - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include push_percent, which is the percent value reported by git push when it is \"Writing objects\".complete - the import is complete, and the repository is ready on GitHub.If there are problems, you will see one of these in the status field:
auth_failed - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the Update an import section.error - the import encountered an error. The import progress response will include the failed_step and an error message. Contact GitHub Support for more information.detection_needs_auth - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the Update an import section.detection_found_nothing - the importer didn't recognize any source control at the URL. To resolve, Cancel the import and retry with the correct URL.detection_found_multiple - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a project_choices field with the possible project choices as values. To update project choice, please see the Update an import section.The project_choices field
\nWhen multiple projects are found at the provided URL, the response hash will include a project_choices field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.
Git LFS related fields
\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.
\nuse_lfs - describes whether the import has been opted in or out of using Git LFS. The value can be opt_in, opt_out, or undecided if no action has been taken.has_large_files - the boolean value describing whether files larger than 100MB were found during the importing step.large_files_size - the total size in gigabytes of files larger than 100MB found in the originating repository.large_files_count - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.Start a source import to a GitHub repository using GitHub Importer.\nImporting into a GitHub repository with GitHub Actions enabled is not supported and will\nreturn a status 422 Unprocessable Entity response.
Warning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nStart 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.
Warning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nAn 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.
\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.
Warning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nAn 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.
\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.
Warning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nStop an import for a repository.
\nWarning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nStop an import for a repository.
\nWarning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nEach type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username hubot into something like hubot <hubot@12341234-abab-fefe-8787-fedcba987654>.
This endpoint and the Map a commit author endpoint allow you to provide correct Git author information.
\nWarning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nEach type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username hubot into something like hubot <hubot@12341234-abab-fefe-8787-fedcba987654>.
This endpoint and the Map a commit author endpoint allow you to provide correct Git author information.
\nWarning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nUpdate an author's identity for the import. Your application can continue updating authors any time before you push\nnew commits to the repository.
\nWarning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nUpdate an author's identity for the import. Your application can continue updating authors any time before you push\nnew commits to the repository.
\nWarning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nList files larger than 100MB found during the import
\nWarning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nUnavailable due to service under maintenance.
" } - ], - "descriptionHTML": "List files larger than 100MB found during the import
\nWarning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nYou can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by Git LFS.
\nYou can learn more about our LFS feature and working with large files on our help\nsite.
\nWarning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nYou can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by Git LFS.
\nYou can learn more about our LFS feature and working with large files on our help\nsite.
\nWarning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nOK
" } ] + }, + { + "serverUrl": "https://models.github.ai", + "verb": "post", + "requestPath": "/orgs/{org}/inference/embeddings", + "title": "Run an embedding request attributed to an organization", + "category": "models", + "subcategory": "inference", + "parameters": [ + { + "in": "query", + "required": false, + "name": "api-version", + "description": "The API version to use. Optional, but required for some features.
", + "schema": { + "type": "string" + }, + "example": "2024-05-01-preview" + }, + { + "in": "path", + "name": "org", + "required": true, + "description": "The organization login associated with the organization to which the request is to be attributed.
", + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "model", + "in": "body", + "description": "ID of the specific model to use for the request. The model ID should be in the format of {publisher}/{model_name} where \"openai/text-embedding-3-small\" is an example of a model ID. You can find supported models in the catalog/models endpoint.
", + "isRequired": true + }, + { + "type": "string or array", + "name": "input", + "in": "body", + "description": "Input text to embed, encoded as a string or array of strings. To embed multiple inputs in a single request, pass an array of strings. Each input must not exceed the max input tokens for the model, cannot be an empty string, and any array must be 2048 dimensions or less.
", + "isRequired": true + }, + { + "type": "string", + "name": "encoding_format", + "in": "body", + "description": "The format to return the embeddings in. Can be either float or base64.
", + "enum": [ + "float", + "base64" + ], + "default": "float" + }, + { + "type": "integer", + "name": "dimensions", + "in": "body", + "description": "The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models.
" + }, + { + "type": "string", + "name": "user", + "in": "body", + "description": "A unique identifier representing your end-user, which can help us to monitor and detect abuse.
" + } + ], + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "model": "openai/text-embedding-3-small", + "input": [ + "The food was delicious and the waiter was very friendly.", + "I had a great time at the restaurant." + ] + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "", + "example": { + "object": "list", + "data": [ + { + "object": "embedding", + "index": 0, + "embedding": [ + 0.0023064255, + -0.009327292, + -0.0028842222 + ] + } + ], + "model": "openai/text-embedding-3-small", + "usage": { + "prompt_tokens": 8, + "total_tokens": 8 + } + }, + "schema": { + "title": "Embedding Response", + "description": "The response for an embedding request.", + "type": "object", + "properties": { + "object": { + "description": "The object type, which is always \"list\" for embedding responses.", + "type": "string", + "enum": [ + "list" + ] + }, + "data": { + "description": "A list of embedding objects.", + "type": "array", + "items": { + "title": "Embedding Object", + "description": "An embedding vector returned by the model.", + "type": "object", + "properties": { + "object": { + "description": "The object type, which is always \"embedding\".", + "type": "string", + "enum": [ + "embedding" + ] + }, + "index": { + "description": "The index of the embedding in the list of embeddings.", + "type": "integer" + }, + "embedding": { + "description": "The embedding vector, which is a list of floats.", + "type": "array", + "items": { + "type": "number" + } + } + }, + "required": [ + "object", + "index", + "embedding" + ] + } + }, + "model": { + "description": "The model used for the embedding.", + "type": "string" + }, + "usage": { + "description": "Usage statistics for the request.", + "type": "object", + "properties": { + "prompt_tokens": { + "description": "The number of tokens in the input.", + "type": "integer" + }, + "total_tokens": { + "description": "The total number of tokens processed.", + "type": "integer" + } + }, + "required": [ + "prompt_tokens", + "total_tokens" + ] + } + }, + "required": [ + "object", + "data", + "model", + "usage" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "This endpoint allows you to run an embedding request attributed to a specific organization. You must be a member of the organization and have enabled models to use this endpoint.\nThe token used to authenticate must have the models: read permission if using a fine-grained PAT or GitHub App minted token.\nThe request body should contain the model ID and the input text(s) for the embedding request. The response will include the generated embeddings.
OK
" + } + ] + }, + { + "serverUrl": "https://models.github.ai", + "verb": "post", + "requestPath": "/inference/embeddings", + "title": "Run an embedding request", + "category": "models", + "subcategory": "inference", + "parameters": [ + { + "in": "query", + "required": false, + "name": "api-version", + "description": "The API version to use. Optional, but required for some features.
", + "schema": { + "type": "string" + }, + "example": "2024-05-01-preview" + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "model", + "in": "body", + "description": "ID of the specific model to use for the request. The model ID should be in the format of {publisher}/{model_name} where \"openai/text-embedding-3-small\" is an example of a model ID. You can find supported models in the catalog/models endpoint.
", + "isRequired": true + }, + { + "type": "string or array", + "name": "input", + "in": "body", + "description": "Input text to embed, encoded as a string or array of strings. To embed multiple inputs in a single request, pass an array of strings. Each input must not exceed the max input tokens for the model, cannot be an empty string, and any array must be 2048 dimensions or less.
", + "isRequired": true + }, + { + "type": "string", + "name": "encoding_format", + "in": "body", + "description": "The format to return the embeddings in. Can be either float or base64.
", + "enum": [ + "float", + "base64" + ], + "default": "float" + }, + { + "type": "integer", + "name": "dimensions", + "in": "body", + "description": "The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models.
" + }, + { + "type": "string", + "name": "user", + "in": "body", + "description": "A unique identifier representing your end-user, which can help us to monitor and detect abuse.
" + } + ], + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "model": "openai/text-embedding-3-small", + "input": [ + "The food was delicious and the waiter was very friendly.", + "I had a great time at the restaurant." + ] + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "", + "example": { + "object": "list", + "data": [ + { + "object": "embedding", + "index": 0, + "embedding": [ + 0.0023064255, + -0.009327292, + -0.0028842222 + ] + } + ], + "model": "openai/text-embedding-3-small", + "usage": { + "prompt_tokens": 8, + "total_tokens": 8 + } + }, + "schema": { + "title": "Embedding Response", + "description": "The response for an embedding request.", + "type": "object", + "properties": { + "object": { + "description": "The object type, which is always \"list\" for embedding responses.", + "type": "string", + "enum": [ + "list" + ] + }, + "data": { + "description": "A list of embedding objects.", + "type": "array", + "items": { + "title": "Embedding Object", + "description": "An embedding vector returned by the model.", + "type": "object", + "properties": { + "object": { + "description": "The object type, which is always \"embedding\".", + "type": "string", + "enum": [ + "embedding" + ] + }, + "index": { + "description": "The index of the embedding in the list of embeddings.", + "type": "integer" + }, + "embedding": { + "description": "The embedding vector, which is a list of floats.", + "type": "array", + "items": { + "type": "number" + } + } + }, + "required": [ + "object", + "index", + "embedding" + ] + } + }, + "model": { + "description": "The model used for the embedding.", + "type": "string" + }, + "usage": { + "description": "Usage statistics for the request.", + "type": "object", + "properties": { + "prompt_tokens": { + "description": "The number of tokens in the input.", + "type": "integer" + }, + "total_tokens": { + "description": "The total number of tokens processed.", + "type": "integer" + } + }, + "required": [ + "prompt_tokens", + "total_tokens" + ] + } + }, + "required": [ + "object", + "data", + "model", + "usage" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "This endpoint allows you to run an embedding request. The token used to authenticate must have the models: read permission if using a fine-grained PAT or GitHub App minted token.\nThe request body should contain the model ID and the input text(s) for the embedding request. The response will include the generated embeddings.
OK
" + } + ] } ] }, @@ -389738,7 +390118,7 @@ } ], "previews": [], - "descriptionHTML": "Lists all organizations, in the order that they were created.
\nNote
\n\nPagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
Lists all organizations, in the order that they were created.
\nNote
\n\nPagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
Warning
\n\nClosing down notice: GitHub will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.
Warning
\n\nClosing down notice: Code security product enablement for new repositories through the organization API is closing down. Please use code security configurations to set defaults instead. For more information on setting a default security configuration, see the changelog.
\nUpdates the organization's profile and member privileges.
\nThe authenticated user must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Warning
\n\nClosing down notice: GitHub will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.
Warning
\n\nClosing down notice: Code security product enablement for new repositories through the organization API is closing down. Please use code security configurations to set defaults instead. For more information on setting a default security configuration, see the changelog.
\nUpdates the organization's profile and member privileges.
\nThe authenticated user must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Warning
\n\nClosing down notice: The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use code security configurations instead. For more information, see the changelog.
\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"Managing security managers in your organization.\"
\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org, write:org, or repo scopes to use this endpoint.
Warning
\n\nClosing down notice: The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use code security configurations instead. For more information, see the changelog.
\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"Managing security managers in your organization.\"
\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org, write:org, or repo scopes to use this endpoint.
List organizations for the authenticated user.
\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a 403 Forbidden response.
Note
\n\nRequests using a fine-grained access token will receive a 200 Success response with an empty list.
List organizations for the authenticated user.
\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a 403 Forbidden response.
Note
\n\nRequests using a fine-grained access token will receive a 200 Success response with an empty list.
The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "array of strings", + "name": "subject_digests", + "in": "body", + "description": "List of subject digests associated with the artifact attestations to delete.
", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Attestations\" repository permissions": "write" + } + ] + }, + "codeExamples": [], + "previews": [], + "descriptionHTML": "Delete artifact attestations in bulk by either subject digests or unique ID.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/attestations/digest/{subject_digest}", + "title": "Delete attestations by subject digest", + "category": "orgs", + "subcategory": "attestations", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "subject_digest", + "description": "Subject Digest
", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Attestations\" repository permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "200", + "request": { + "description": "Example 1: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "subject_digest": "SUBJECT_DIGEST" + } + }, + "response": { + "statusCode": "200", + "description": "Response
" + } + }, + { + "key": "204", + "request": { + "description": "Example 2: Status Code 204", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "subject_digest": "SUBJECT_DIGEST" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Delete an artifact attestation by subject digest.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/attestations/{attestation_id}", + "title": "Delete attestations by ID", + "category": "orgs", + "subcategory": "attestations", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "attestation_id", + "description": "Attestation ID
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Attestations\" repository permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "200", + "request": { + "description": "Example 1: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "attestation_id": "ATTESTATION_ID" + } + }, + "response": { + "statusCode": "200", + "description": "Response
" + } + }, + { + "key": "204", + "request": { + "description": "Example 2: Status Code 204", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "attestation_id": "ATTESTATION_ID" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Delete an artifact attestation by unique ID that is associated with a repository owned by an org.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + } + ], "blocking": [ { "serverUrl": "https://api.github.com", @@ -402332,13 +402944,13 @@ } ], "previews": [], + "descriptionHTML": "Creates a hosted compute network configuration for an organization.
\nOAuth app tokens and personal access tokens (classic) need the write:network_configurations scope to use this endpoint.
Created
" } - ], - "descriptionHTML": "Creates a hosted compute network configuration for an organization.
\nOAuth app tokens and personal access tokens (classic) need the write:network_configurations scope to use this endpoint.
Warning
\n\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.
\nWarning
\n\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.
\nWarning
\n\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.
\nWarning
\n\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.
\nWarning
\n\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.
\nWarning
\n\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.
\nGets a specific package version for a package owned by the authenticated user.
\nOAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
OK
" } - ], - "descriptionHTML": "Gets a specific package version for a package owned by the authenticated user.
\nOAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
Gets a specific package version for a public package owned by a specified user.
\nOAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
OK
" } - ], - "descriptionHTML": "Gets a specific package version for a public package owned by a specified user.
\nOAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nLists the files in a specified pull request.
\nNote
\n\nResponses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Lists the files in a specified pull request.
\nNote
\n\nResponses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.OK
" } - ], - "descriptionHTML": "Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Creates a review on a specified pull request.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note
\n\nTo comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the application/vnd.github.v3.diff media type to the Accept header of a call to the Get a pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Creates a review on a specified pull request.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note
\n\nTo comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the application/vnd.github.v3.diff media type to the Accept header of a call to the Get a pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Dismisses a specified review on a pull request.
\nNote
\n\nTo dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Dismisses a specified review on a pull request.
\nNote
\n\nTo dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Note
\n\nAccessing this endpoint does not count against your REST API rate limit.
\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under resources, you'll see objects relating to different categories:
core object provides your rate limit status for all non-search-related resources in the REST API.search object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"Search.\"code_search object provides your rate limit status for the REST API for searching code. For more information, see \"Search code.\"graphql object provides your rate limit status for the GraphQL API. For more information, see \"Resource limitations.\"integration_manifest object provides your rate limit status for the POST /app-manifests/{code}/conversions operation. For more information, see \"Creating a GitHub App from a manifest.\"dependency_snapshots object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"Dependency graph.\"dependency_sbom object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"Dependency graph.\"code_scanning_upload object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"Uploading a SARIF file to GitHub.\"actions_runner_registration object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"Self-hosted runners.\"source_import object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"API Versions.\"Note
\n\nThe rate object is closing down. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.
Note
\n\nAccessing this endpoint does not count against your REST API rate limit.
\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under resources, you'll see objects relating to different categories:
core object provides your rate limit status for all non-search-related resources in the REST API.search object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"Search.\"code_search object provides your rate limit status for the REST API for searching code. For more information, see \"Search code.\"graphql object provides your rate limit status for the GraphQL API. For more information, see \"Resource limitations.\"integration_manifest object provides your rate limit status for the POST /app-manifests/{code}/conversions operation. For more information, see \"Creating a GitHub App from a manifest.\"dependency_snapshots object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"Dependency graph.\"dependency_sbom object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"Dependency graph.\"code_scanning_upload object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"Uploading a SARIF file to GitHub.\"actions_runner_registration object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"Self-hosted runners.\"source_import object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"API Versions.\"Note
\n\nThe rate object is closing down. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.
List the reactions to a team discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
List the reactions to a team discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Create a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Create a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
List the reactions to a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
List the reactions to a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Create a reaction to a team discussion.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Create a reaction to a team discussion.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -488251,7 +488863,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -489340,7 +489952,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", "statusCodes": [ { "httpStatusCode": "204", @@ -490428,7 +491040,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -491499,7 +492111,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", "statusCodes": [ { "httpStatusCode": "204", @@ -491857,7 +492469,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Get a published release with the specified tag.
", "statusCodes": [ { "httpStatusCode": "200", @@ -496111,8 +496724,7 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ], - "descriptionHTML": "Get a published release with the specified tag.
" + ] }, { "serverUrl": "https://api.github.com", @@ -496860,7 +497472,7 @@ } ], "previews": [], - "descriptionHTML": "Gets a public release with the specified release ID.
\nNote
\n\nThis returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"Getting started with the REST API.\"
Gets a public release with the specified release ID.
\nNote
\n\nThis returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"Getting started with the REST API.\"
Lists repositories for the specified organization.
\nNote
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
Lists repositories for the specified organization.
\nNote
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.
Note
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.
Note
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.
OAuth app tokens and personal access tokens (classic) need the public_repo or repo scope to create a public repository, and repo scope to create a private repository.
Created
" } - ], - "descriptionHTML": "Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.
OAuth app tokens and personal access tokens (classic) need the public_repo or repo scope to create a public repository, and repo scope to create a private repository.
Creates a new file or replaces an existing file in a repository.
\nNote
\n\nIf you use this endpoint and the \"Delete a file\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. The workflow scope is also required in order to modify files in the .github/workflows directory.
Creates a new file or replaces an existing file in a repository.
\nNote
\n\nIf you use this endpoint and the \"Delete a file\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. The workflow scope is also required in order to modify files in the .github/workflows directory.
Deletes a file in a repository.
\nYou can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.
The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.
You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.
Note
\n\nIf you use this endpoint and the \"Create or update file contents\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
\nDeletes a file in a repository.
\nYou can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.
The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.
You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.
Note
\n\nIf you use this endpoint and the \"Create or update file contents\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
\nGets a redirect URL to download a tar archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes.
\nGets a redirect URL to download a tar archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes.
\nGets a redirect URL to download a zip archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.
\nGets a redirect URL to download a zip archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.
\nCreate a fork for the authenticated user.
\nNote
\n\nForking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub Support.
\nNote
\n\nAlthough this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.
\nCreate a fork for the authenticated user.
\nNote
\n\nForking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub Support.
\nNote
\n\nAlthough this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.
\nWarning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis returns the tag protection states of a repository.
\nThis information is only available to repository administrators.
", + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis returns the tag protection states of a repository.
\nThis information is only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "200", @@ -552575,7 +553187,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "201", @@ -552657,7 +553269,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "204", @@ -555085,7 +555697,7 @@ } ], "previews": [], - "descriptionHTML": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook is not subscribed to push events, the server will respond with 204 but no test POST will be generated.
Note
\n\nPreviously /repos/:owner/:repo/hooks/:hook_id/test
This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook is not subscribed to push events, the server will respond with 204 but no test POST will be generated.
Note
\n\nPreviously /repos/:owner/:repo/hooks/:hook_id/test
Warning
\n\nNotice: Search for issues and pull requests will be overridden by advanced search on September 4, 2025.\nYou can read more about this change on the GitHub blog.
\nWarning
\n\nNotice: Search for issues and pull requests will be overridden by advanced search on September 4, 2025.\nYou can read more about this change on the GitHub blog.
\nCreate a temporary private fork to collaborate on fixing a security vulnerability in your repository.
\nNote
\n\nForking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork.
\nCreate a temporary private fork to collaborate on fixing a security vulnerability in your repository.
\nNote
\n\nForking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork.
\nGets a team using the team's slug. To create the slug, GitHub replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a - separator. For example, \"My TEam Näme\" would become my-team-name.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
Gets a team using the team's slug. To create the slug, GitHub replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a - separator. For example, \"My TEam Näme\" would become my-team-name.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
To edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}.
To edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}.
To delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}.
To delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}.
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nLists a team's repositories visible to the authenticated user.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos.
Lists a team's repositories visible to the authenticated user.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos.
Checks whether a team has admin, push, maintain, triage, or pull permission for a repository. Repositories inherited through a parent team will also be checked.
You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the application/vnd.github.v3.repository+json accept header.
If a team doesn't have permission for the repository, you will receive a 404 Not Found response status.
If the repository is private, you must have at least read permission for that repository, and your token must have the repo or admin:org scope. Otherwise, you will receive a 404 Not Found response status.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
Checks whether a team has admin, push, maintain, triage, or pull permission for a repository. Repositories inherited through a parent team will also be checked.
You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the application/vnd.github.v3.repository+json accept header.
If a team doesn't have permission for the repository, you will receive a 404 Not Found response status.
If the repository is private, you must have at least read permission for that repository, and your token must have the repo or admin:org scope. Otherwise, you will receive a 404 Not Found response status.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Note
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
For more information about the permission levels, see \"Repository permission levels for an organization\".
", + "descriptionHTML": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Note
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
For more information about the permission levels, see \"Repository permission levels for an organization\".
", "statusCodes": [ { "httpStatusCode": "204", @@ -601263,7 +601875,7 @@ } ], "previews": [], - "descriptionHTML": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
Lists the child teams of the team specified by {team_slug}.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.
Lists the child teams of the team specified by {team_slug}.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the Get a team by name endpoint.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the Get a team by name endpoint.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a team endpoint.
\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote
\n\nWith nested teams, the privacy for parent teams cannot be secret.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a team endpoint.
\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote
\n\nWith nested teams, the privacy for parent teams cannot be secret.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a team endpoint.
\nTo delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
", + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a team endpoint.
\nTo delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
", "statusCodes": [ { "httpStatusCode": "204", @@ -604273,7 +604885,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team repositories endpoint.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team repositories endpoint.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a repository endpoint.
\nNote
\n\nRepositories inherited through a parent team will also be checked.
\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a repository endpoint.
\nNote
\n\nRepositories inherited through a parent team will also be checked.
\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Add or update team repository permissions\" endpoint.
\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization.
Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Add or update team repository permissions\" endpoint.
\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization.
Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a repository from a team endpoint.
\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.
", + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a repository from a team endpoint.
\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.
", "statusCodes": [ { "httpStatusCode": "204", @@ -607371,7 +607983,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List child teams endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List child teams endpoint.
List all comments on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "List all comments on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Creates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Creates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Get a specific comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Get a specific comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Edits the body text of a discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Edits the body text of a discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Deletes a comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Deletes a comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion comments endpoint.
\nList all comments on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion comments endpoint.
\nList all comments on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.
\nCreates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.
\nCreates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion comment endpoint.
\nGet a specific comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion comment endpoint.
\nGet a specific comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.
\nEdits the body text of a discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.
\nEdits the body text of a discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion comment endpoint.
\nDeletes a comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion comment endpoint.
\nDeletes a comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
List all discussions on a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
List all discussions on a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Get a specific discussion on a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Get a specific discussion on a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Edits the title and body text of a discussion post. Only the parameters you provide are updated.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Edits the title and body text of a discussion post. Only the parameters you provide are updated.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Delete a discussion from a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Delete a discussion from a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.
List all discussions on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.
List all discussions on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.
Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.
Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion endpoint.
\nGet a specific discussion on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion endpoint.
\nGet a specific discussion on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion endpoint.
\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion endpoint.
\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion endpoint.
Delete a discussion from a team's page.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion endpoint.
Delete a discussion from a team's page.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub member, the login field in the return hash will be null.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/invitations.
The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub member, the login field in the return hash will be null.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/invitations.
Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note
\n\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note
\n\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub.\"
\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}.
Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub.\"
\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}.
To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}.
To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List pending team invitations endpoint.
The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub member, the login field in the return hash will be null.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List pending team invitations endpoint.
The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub member, the login field in the return hash will be null.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members endpoint.
Team members will include the members of child teams.
", + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members endpoint.
Team members will include the members of child teams.
", "statusCodes": [ { "httpStatusCode": "200", @@ -617550,7 +618162,7 @@ } ], "previews": [], - "descriptionHTML": "The \"Add team member\" endpoint (described below) is closing down.
\nWe recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub.\"
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
The \"Add team member\" endpoint (described below) is closing down.
\nWe recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub.\"
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
The \"Remove team member\" endpoint (described below) is closing down.
\nWe recommend using the Remove team membership for a user endpoint instead. It allows you to remove both active and pending memberships.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub.\"
\nThe \"Remove team member\" endpoint (described below) is closing down.
\nWe recommend using the Remove team membership for a user endpoint instead. It allows you to remove both active and pending memberships.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub.\"
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership for a user endpoint.
\nTeam members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership for a user endpoint.
\nTeam members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub.\"
\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
", + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub.\"
\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
", "statusCodes": [ { "httpStatusCode": "200", @@ -617908,7 +618520,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub.\"
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub.\"
\nLists the people who the specified user follows.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Lists the people who the specified user follows.
" + ] }, { "serverUrl": "https://api.github.com", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 0fce1cc7afd1..e454934b2b7d 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -276,13 +276,13 @@ } ], "previews": [], - "descriptionHTML": "Lists all artifacts for a repository.
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
OK
" } - ] + ], + "descriptionHTML": "Lists all artifacts for a repository.
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Lists repositories and their GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
\nOAuth tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists repositories and their GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
\nOAuth tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
Gets GitHub Actions cache usage for a repository.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
\nAnyone with read access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets GitHub Actions cache usage for a repository.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
\nAnyone with read access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Creates a GitHub-hosted runner for an enterprise.\nOAuth tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Created
" } - ], - "descriptionHTML": "Creates a GitHub-hosted runner for an enterprise.\nOAuth tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Updates a GitHub-hosted runner for an organization.\nOAuth app tokens and personal access tokens (classic) need the manage_runners:org scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Updates a GitHub-hosted runner for an organization.\nOAuth app tokens and personal access tokens (classic) need the manage_runners:org scope to use this endpoint.
Gets the customization template for an OpenID Connect (OIDC) subject claim.
\nOAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
A JSON serialized template for OIDC subject claim customization
" } - ] + ], + "descriptionHTML": "Gets the customization template for an OpenID Connect (OIDC) subject claim.
\nOAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an enterprise,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Enforcing a policy for workflow permissions in your enterprise.\"
OAuth tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Success response
" } - ], - "descriptionHTML": "Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an enterprise,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Enforcing a policy for workflow permissions in your enterprise.\"
OAuth tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for a repository.\"
OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for a repository.\"
OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Lists all secrets available in an organization without revealing their\nencrypted values.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
OK
" } - ], - "descriptionHTML": "Lists all secrets available in an organization without revealing their\nencrypted values.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Gets a single organization secret without revealing its encrypted value.
\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets
\nOAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets a single organization secret without revealing its encrypted value.
\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets
\nOAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Deletes a secret in an organization using the secret name.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Deletes a secret in an organization using the secret name.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
No Content
" } - ], - "descriptionHTML": "Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Gets a single environment secret without revealing its encrypted value.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets a single environment secret without revealing its encrypted value.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Deletes a secret in an environment using the secret name.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Default response
" } - ], - "descriptionHTML": "Deletes a secret in an environment using the secret name.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Lists all self-hosted runner groups for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists all self-hosted runner groups for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Lists the organizations with access to a self-hosted runner group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists the organizations with access to a self-hosted runner group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Lists the self-hosted runners that are in a specific enterprise group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists the self-hosted runners that are in a specific enterprise group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Replaces the list of self-hosted runners that are part of an enterprise runner group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Replaces the list of self-hosted runners that are part of an enterprise runner group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Adds a self-hosted runner to a runner group configured in an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Adds a self-hosted runner to a runner group configured in an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Deletes a self-hosted runner group for an organization.
\nOAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Deletes a self-hosted runner group for an organization.
\nOAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Lists the GitHub-hosted runners in an organization group.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists the GitHub-hosted runners in an organization group.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Replaces the list of self-hosted runners that are part of an organization runner group.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Replaces the list of self-hosted runners that are part of an organization runner group.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
OK
" } - ] + ], + "descriptionHTML": "Lists binaries for the runner application that you can download and run.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Returns a token that you can pass to the config script. The token expires after one hour.
For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to configure your self-hosted runner:
./config.sh --url https://github.com/octo-org --token TOKEN\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Created
" } - ], - "descriptionHTML": "Returns a token that you can pass to the config script. The token expires after one hour.
For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to configure your self-hosted runner:
./config.sh --url https://github.com/octo-org --token TOKEN\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Gets a specific self-hosted runner configured in an organization.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
OK
" } - ] + ], + "descriptionHTML": "Gets a specific self-hosted runner configured in an organization.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Lists all labels for a self-hosted runner configured in an organization.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Resource not found
" } - ] + ], + "descriptionHTML": "Lists all labels for a self-hosted runner configured in an organization.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Gets a specific self-hosted runner configured in a repository.
\nAuthenticated users must have admin access to the repository to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets a specific self-hosted runner configured in a repository.
\nAuthenticated users must have admin access to the repository to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Lists all organization variables.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
OK
" } - ] + ], + "descriptionHTML": "Lists all organization variables.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Gets a specific variable in an organization.
\nThe authenticated user must have collaborator access to a repository to create, update, or read variables.
\nOAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets a specific variable in an organization.
\nThe authenticated user must have collaborator access to a repository to create, update, or read variables.
\nOAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Gets a specific variable in an environment.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets a specific variable in an environment.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Updates an environment variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Updates an environment variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Deletes a specific workflow run.
\nAnyone with write access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Deletes a specific workflow run.
\nAnyone with write access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Cancels a workflow run using its id.
OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Conflict
" } - ] + ], + "descriptionHTML": "Cancels a workflow run using its id.
OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"Using environments for deployment.\"
\nNote
\n\nGitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"Using environments for deployment.\"
\nNote
\n\nGitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Warning
\n
\nThis endpoint is in the process of closing down. Refer to \"Actions Get workflow usage and Get workflow run usage endpoints closing down\" for more information.
Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub Enterprise Cloud-hosted runners. Usage is listed for each GitHub Enterprise Cloud-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Warning
\n
\nThis endpoint is in the process of closing down. Refer to \"Actions Get workflow usage and Get workflow run usage endpoints closing down\" for more information.
Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub Enterprise Cloud-hosted runners. Usage is listed for each GitHub Enterprise Cloud-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
List all workflow runs for a workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
Anyone with read access to the repository can use this endpoint
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
This endpoint will return up to 1,000 results for each search when using the following parameters: actor, branch, check_suite_id, created, event, head_sha, status.
OK
" } - ], - "descriptionHTML": "List all workflow runs for a workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
Anyone with read access to the repository can use this endpoint
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
This endpoint will return up to 1,000 results for each search when using the following parameters: actor, branch, check_suite_id, created, event, head_sha, status.
Warning
\n
\nThis endpoint is in the process of closing down. Refer to \"Actions Get workflow usage and Get workflow run usage endpoints closing down\" for more information.
Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub Enterprise Cloud-hosted runners. Usage is listed for each GitHub Enterprise Cloud-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".
\nYou can replace workflow_id with the workflow file name. For example, you could use main.yaml.
Anyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Warning
\n
\nThis endpoint is in the process of closing down. Refer to \"Actions Get workflow usage and Get workflow run usage endpoints closing down\" for more information.
Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub Enterprise Cloud-hosted runners. Usage is listed for each GitHub Enterprise Cloud-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".
\nYou can replace workflow_id with the workflow file name. For example, you could use main.yaml.
Anyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Note
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nOK
" } - ], - "descriptionHTML": "Note
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nIf you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. Optional: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nIf you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. Optional: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nThis is the user's organization dashboard. You must be authenticated as the user to view this.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nThis is the user's organization dashboard. You must be authenticated as the user to view this.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nThese are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nThese are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nLists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.
\nuri_template. For more information, see \"Hypermedia.\"By default, timeline resources are returned in JSON. You can specify the application/atom+xml type in the Accept header to return timeline resources in Atom format. For more information, see \"Media types.\"
Note
\n\nPrivate feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
\nLists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.
\nuri_template. For more information, see \"Hypermedia.\"By default, timeline resources are returned in JSON. You can specify the application/atom+xml type in the Accept header to return timeline resources in Atom format. For more information, see \"Media types.\"
Note
\n\nPrivate feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
\nRemoves the announcement banner currently set for the enterprise.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ] + ], + "descriptionHTML": "Removes the announcement banner currently set for the enterprise.
" } ], "organizations": [ @@ -96906,13 +96906,13 @@ } ], "previews": [], + "descriptionHTML": "Sets the announcement banner to display for the organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Sets the announcement banner to display for the organization.
" + ] }, { "serverUrl": "https://api.github.com", @@ -97445,13 +97445,13 @@ } ], "previews": [], - "descriptionHTML": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count in the response. For more details about your app's installations, see the \"List installations for the authenticated app\" endpoint.
You must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count in the response. For more details about your app's installations, see the \"List installations for the authenticated app\" endpoint.
You must use a JWT to access this endpoint.
" }, { "serverUrl": "https://api.github.com", @@ -100804,6 +100804,7 @@ } ], "previews": [], + "descriptionHTML": "Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"Suspend an app installation\" endpoint.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "204", @@ -100813,8 +100814,7 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ], - "descriptionHTML": "Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"Suspend an app installation\" endpoint.
\nYou must use a JWT to access this endpoint.
" + ] }, { "serverUrl": "https://api.github.com", @@ -105013,7 +105013,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nThe :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).
Note
\n\nThe :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).
Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"Creating a GitHub App.\"
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"Creating a GitHub App.\"
\nYou must use a JWT to access this endpoint.
" + ] }, { "serverUrl": "https://api.github.com", @@ -118264,13 +118264,13 @@ } ], "previews": [], + "descriptionHTML": "Gets the free and paid storage used for GitHub Packages in gigabytes.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nOAuth app tokens and personal access tokens (classic) need the repo or admin:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets the free and paid storage used for GitHub Packages in gigabytes.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nOAuth app tokens and personal access tokens (classic) need the repo or admin:org scope to use this endpoint.
Gets the summary of the free and paid GitHub Actions minutes used.
\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".
\nOAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets the summary of the free and paid GitHub Actions minutes used.
\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".
\nOAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.
Renames a branch in a repository.
\nNote
\n\nAlthough the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".
\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.
\nIn order to rename the default branch, fine-grained access tokens also need the administration:write repository permission.
Renames a branch in a repository.
\nNote
\n\nAlthough the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".
\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.
\nIn order to rename the default branch, fine-grained access tokens also need the administration:write repository permission.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nProtecting a branch requires admin or owner permissions to the repository.
\nNote
\n\nPassing new arrays of users and teams replaces their previous values.
Note
\n\nThe list of users, apps, and teams in total is limited to 100 items.
\nProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nProtecting a branch requires admin or owner permissions to the repository.
\nNote
\n\nPassing new arrays of users and teams replaces their previous values.
Note
\n\nThe list of users, apps, and teams in total is limited to 100 items.
\nProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
\nNote
\n\nPassing new arrays of users and teams replaces their previous values.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
\nNote
\n\nPassing new arrays of users and teams replaces their previous values.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.
Note
\n\nYou must enable branch protection to require signed commits.
\nProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.
Note
\n\nYou must enable branch protection to require signed commits.
\nProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists who has access to this protected branch.
\nNote
\n\nUsers, apps, and teams restrictions are only available for organization-owned repositories.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists who has access to this protected branch.
\nNote
\n\nUsers, apps, and teams restrictions are only available for organization-owned repositories.
Creates a new check run for a specific commit in a repository.
\nTo create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.
\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
\nNote
\n\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Creates a new check run for a specific commit in a repository.
\nTo create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.
\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
\nNote
\n\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Gets a single check run using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Gets a single check run using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Updates a check run for a specific commit in a repository.
\nNote
\n\nThe 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.
OAuth apps and personal access tokens (classic) cannot use this endpoint.
", + "descriptionHTML": "Updates a check run for a specific commit in a repository.
\nNote
\n\nThe 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.
OAuth apps and personal access tokens (classic) cannot use this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -154532,13 +154532,13 @@ } ], "previews": [], + "descriptionHTML": "Lists check runs for a check suite using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
OK
" } - ], - "descriptionHTML": "Lists check runs for a check suite using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name.
Note
\n\nThe 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 endpoint and provide the check_suite_id parameter to the List check runs in a check suite endpoint.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name.
Note
\n\nThe 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 endpoint and provide the check_suite_id parameter to the List check runs in a check suite endpoint.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Creates a check suite manually. By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"Update repository preferences for check suites\".
\nNote
\n\nThe 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.
OAuth apps and personal access tokens (classic) cannot use this endpoint.
", + "descriptionHTML": "Creates a check suite manually. By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"Update repository preferences for check suites\".
\nNote
\n\nThe 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.
OAuth apps and personal access tokens (classic) cannot use this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -161174,13 +161174,13 @@ } ], "previews": [], + "descriptionHTML": "Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually Create a check suite.\nYou must have admin permissions in the repository to set preferences for check suites.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually Create a check suite.\nYou must have admin permissions in the repository to set preferences for check suites.
" + ] }, { "serverUrl": "https://api.github.com", @@ -163169,7 +163169,7 @@ } ], "previews": [], - "descriptionHTML": "Gets a single check suite using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Gets a single check suite using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
OK
" } - ], - "descriptionHTML": "Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.
The rules_count field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.
Warning
\n\nClosing down notice: The tool_name field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.
OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.
The rules_count field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.
Warning
\n\nClosing down notice: The tool_name field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.
OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Updates a code security configuration in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Response when no new updates are made
" } - ], - "descriptionHTML": "Updates a code security configuration in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted\nvalues.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted\nvalues.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets.\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets.\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Gets an organization development environment secret without revealing its encrypted value.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets an organization development environment secret without revealing its encrypted value.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Lists all development environment secrets available in a repository without revealing their encrypted\nvalues.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists all development environment secrets available in a repository without revealing their encrypted\nvalues.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Deletes a development environment secret in a repository using the secret name.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. The associated user must be a repository admin.
No Content
" } - ], - "descriptionHTML": "Deletes a development environment secret in a repository using the secret name.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. The associated user must be a repository admin.
For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
\nTeam members will include the members of child teams.
\nThe authenticated user must have push access to the repository to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:org and repo scopes to use this endpoint.
Not Found if user is not a collaborator
" } - ] + ], + "descriptionHTML": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
\nTeam members will include the members of child teams.
\nThe authenticated user must have push access to the repository to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:org and repo scopes to use this endpoint.
Removes a collaborator from a repository.
\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.
\nThis endpoint also:
\nRemoving a user as a collaborator has the following effects on forks:
\nNote
\n\nA user can still have access to the repository through organization permissions like base repository permissions.
\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.
\nFor more information on fork permissions, see \"About permissions and visibility of forks\".
", "statusCodes": [ { "httpStatusCode": "204", @@ -232358,7 +232357,8 @@ "httpStatusCode": "422", "description": "Validation failed, or the endpoint has been spammed.
" } - ] + ], + "descriptionHTML": "Removes a collaborator from a repository.
\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.
\nThis endpoint also:
\nRemoving a user as a collaborator has the following effects on forks:
\nNote
\n\nA user can still have access to the repository through organization permissions like base repository permissions.
\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.
\nFor more information on fork permissions, see \"About permissions and visibility of forks\".
" }, { "serverUrl": "https://api.github.com", @@ -244094,7 +244094,7 @@ } ], "previews": [], - "descriptionHTML": "Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.
Note
\n\nIf there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\" Pagination query parameters are not supported for these media types.
\napplication/vnd.github.diff: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property. Larger diffs may time out and return a 5xx status code.application/vnd.github.sha: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
verified_at | string | The date the signature was verified by GitHub. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on their account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.
Note
\n\nIf there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\" Pagination query parameters are not supported for these media types.
\napplication/vnd.github.diff: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property. Larger diffs may time out and return a 5xx status code.application/vnd.github.sha: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
verified_at | string | The date the signature was verified by GitHub. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on their account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Lists the commit comments for a specified repository. Comments are ordered by ascending ID.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.OK
" } - ], - "descriptionHTML": "Lists the commit comments for a specified repository. Comments are ordered by ascending ID.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Note
\n\nThis endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"About enterprise accounts for Copilot Business.\"
\nUse this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.
\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.
\nNote
\n\nThis endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses on that day, as evaluated at the end of that day.
\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.
Note
\n\nThis endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"About enterprise accounts for Copilot Business.\"
\nUse this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.
\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.
\nNote
\n\nThis endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses on that day, as evaluated at the end of that day.
\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.
Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.
\nNote
\n\nThis endpoint will only return results for a given day if the organization contained five or more members with active Copilot licenses on that day, as evaluated at the end of that day.
\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.
\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot, read:org, or read:enterprise scopes to use this endpoint.
Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.
\nNote
\n\nThis endpoint will only return results for a given day if the organization contained five or more members with active Copilot licenses on that day, as evaluated at the end of that day.
\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.
\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot, read:org, or read:enterprise scopes to use this endpoint.
Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.
\nNote
\n\nThis endpoint will only return results for a given day if the team had five or more members with active Copilot licenses on that day, as evaluated at the end of that day.
\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.
\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings.\nOnly organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot, read:org, or read:enterprise scopes to use this endpoint.
Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.
\nNote
\n\nThis endpoint will only return results for a given day if the team had five or more members with active Copilot licenses on that day, as evaluated at the end of that day.
\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.
\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings.\nOnly organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot, read:org, or read:enterprise scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nLists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.
\nUsers with access through multiple organizations or enterprise teams will only be counted toward total_seats once.
For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the seats array.\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have\ntelemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at. For more information about activity data,\nsee \"Reviewing user activity data for Copilot in your organization.\"
Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.
\nPersonal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nLists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.
\nUsers with access through multiple organizations or enterprise teams will only be counted toward total_seats once.
For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the seats array.\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have\ntelemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at. For more information about activity data,\nsee \"Reviewing user activity data for Copilot in your organization.\"
Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.
\nPersonal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nGets the GitHub Copilot seat details for a member of an enterprise who currently has access to GitHub Copilot.
\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at.
Only enterprise owners can view Copilot seat assignment details for members of their enterprise.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nGets the GitHub Copilot seat details for a member of an enterprise who currently has access to GitHub Copilot.
\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at.
Only enterprise owners can view Copilot seat assignment details for members of their enterprise.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"Managing policies for Copilot in your organization.\"
\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"Managing policies for Copilot in your organization.\"
\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.
\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at.\nFor more information about activity data, see \"Reviewing user activity data for Copilot in your organization.\"
OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.
\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at.\nFor more information about activity data, see \"Reviewing user activity data for Copilot in your organization.\"
OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"About billing for GitHub Copilot in your organization.\"
\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"Subscribing to Copilot for your organization.\"\nFor more information about setting a suggestion matching policy, see \"Managing policies for Copilot in your organization.\"
\nThe response contains the total number of new seats that were created and existing seats that were refreshed.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"About billing for GitHub Copilot in your organization.\"
\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"Subscribing to Copilot for your organization.\"\nFor more information about setting a suggestion matching policy, see \"Managing policies for Copilot in your organization.\"
\nThe response contains the total number of new seats that were created and existing seats that were refreshed.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"Revoking access to Copilot for members of your organization.\"
\nOnly organization owners can cancel Copilot seats for their organization members.
\nThe response contains the total number of seats set to \"pending cancellation\".
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"Revoking access to Copilot for members of your organization.\"
\nOnly organization owners can cancel Copilot seats for their organization members.
\nThe response contains the total number of seats set to \"pending cancellation\".
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"About billing for GitHub Copilot in your organization.\"
\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"Subscribing to Copilot for your organization.\"\nFor more information about setting a suggestion matching policy, see \"Managing policies for Copilot in your organization.\"
\nThe response contains the total number of new seats that were created and existing seats that were refreshed.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"About billing for GitHub Copilot in your organization.\"
\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"Subscribing to Copilot for your organization.\"\nFor more information about setting a suggestion matching policy, see \"Managing policies for Copilot in your organization.\"
\nThe response contains the total number of new seats that were created and existing seats that were refreshed.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"Revoking access to Copilot for members of your organization.\"
\nOnly organization owners can cancel Copilot seats for their organization members.
\nThe response contains the total number of seats set to \"pending cancellation\".
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"Revoking access to Copilot for members of your organization.\"
\nOnly organization owners can cancel Copilot seats for their organization members.
\nThe response contains the total number of seats set to \"pending cancellation\".
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.
\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at.\nFor more information about activity data, see \"Reviewing user activity data for Copilot in your organization.\"
Only organization owners can view Copilot seat assignment details for members of their organization.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.
Note
\n\nThis endpoint is in public preview and is subject to change.
\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.
\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at.\nFor more information about activity data, see \"Reviewing user activity data for Copilot in your organization.\"
Only organization owners can view Copilot seat assignment details for members of their organization.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.
Submit a list of credentials to be revoked. This endpoint is intended to revoke credentials the caller does not own and may have found exposed on GitHub.com or elsewhere. It can also be used for credentials associated with an old user account that you no longer have access to. Credential owners will be notified of the revocation.
\nThis endpoint currently accepts the following credential types:
\nRevoked credentials may impact users on GitHub Free, Pro, & Team and GitHub Enterprise Cloud, and GitHub Enterprise Cloud with Enterprise Managed Users.\nGitHub cannot reactivate any credentials that have been revoked; new credentials will need to be generated.
\nTo prevent abuse, this API is limited to only 60 unauthenticated requests per hour and a max of 1000 tokens per API request.
\nNote
\n\nAny authenticated requests will return a 403.
\nSubmit a list of credentials to be revoked. This endpoint is intended to revoke credentials the caller does not own and may have found exposed on GitHub.com or elsewhere. It can also be used for credentials associated with an old user account that you no longer have access to. Credential owners will be notified of the revocation.
\nThis endpoint currently accepts the following credential types:
\nRevoked credentials may impact users on GitHub Free, Pro, & Team and GitHub Enterprise Cloud, and GitHub Enterprise Cloud with Enterprise Managed Users.\nGitHub cannot reactivate any credentials that have been revoked; new credentials will need to be generated.
\nTo prevent abuse, this API is limited to only 60 unauthenticated requests per hour and a max of 1000 tokens per API request.
\nNote
\n\nAny authenticated requests will return a 403.
\nNote
\n\nThis operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.
\nNote
\n\nThis operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.
\nNote
\n\nThis operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.
\nExample request body:
\n{\n \"repository_ids_to_add\": [123, 456],\n \"repository_ids_to_remove\": [789]\n}\nNote
\n\nThis operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.
\nExample request body:
\n{\n \"repository_ids_to_add\": [123, 456],\n \"repository_ids_to_remove\": [789]\n}\nNote
\n\nThis operation supports both server-to-server and user-to-server access.\nSets the default level of repository access Dependabot will have while performing an update. Available values are:
\nUnauthorized users will not see the existence of this endpoint.
", + "descriptionHTML": "Note
\n\nThis operation supports both server-to-server and user-to-server access.\nSets the default level of repository access Dependabot will have while performing an update. Available values are:
\nUnauthorized users will not see the existence of this endpoint.
", "statusCodes": [ { "httpStatusCode": "204", @@ -265581,13 +265581,13 @@ } ], "previews": [], + "descriptionHTML": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Lists all repositories that have been selected when the visibility\nfor repository access to a secret is set to selected.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Lists all repositories that have been selected when the visibility\nfor repository access to a secret is set to selected.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Gets a deployment branch or tag policy for an environment.
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
OK
" } - ], - "descriptionHTML": "Gets a deployment branch or tag policy for an environment.
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Updates a deployment branch or tag policy for an environment.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Updates a deployment branch or tag policy for an environment.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Note
\n\nTo get information about name patterns that branches must match in order to deploy to this environment, see \"Get a deployment branch policy.\"
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Note
\n\nTo get information about name patterns that branches must match in order to deploy to this environment, see \"Get a deployment branch policy.\"
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"Environments.\"
\nNote
\n\nTo create or update name patterns that branches must match in order to deploy to this environment, see \"Deployment branch policies.\"
\nNote
\n\nTo create or update secrets for an environment, see \"GitHub Actions secrets.\"
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"Environments.\"
\nNote
\n\nTo create or update name patterns that branches must match in order to deploy to this environment, see \"Deployment branch policies.\"
\nNote
\n\nTo create or update secrets for an environment, see \"GitHub Actions secrets.\"
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Enable a custom deployment protection rule for an environment.
\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.
\nFor more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint, as well as the guide to creating custom deployment protection rules.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
The enabled custom deployment protection rule
" } - ], - "descriptionHTML": "Enable a custom deployment protection rule for an environment.
\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.
\nFor more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint, as well as the guide to creating custom deployment protection rules.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment.
\nNote
\n\nIt's recommended to use the log_url parameter, which replaces target_url.
The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment.
\nNote
\n\nIt's recommended to use the log_url parameter, which replaces target_url.
Returns aggregate usage metrics for your GitHub Enterprise Server 3.5+ instance for a specified time period up to 365 days.
\nTo use this endpoint, your GitHub Enterprise Server instance must be connected to GitHub Enterprise Cloud using GitHub Connect. You must enable Server Statistics, and for the API request provide your enterprise account name or organization name connected to the GitHub Enterprise Server. For more information, see \"Enabling Server Statistics for your enterprise\" in the GitHub Enterprise Server documentation.
\nOAuth app tokens and personal access tokens (classic) need:
\nread:enterprise scope if you connected your GitHub Enterprise Server to an enterprise account and enabled Server Statisticsread:org scope if you connected your GitHub Enterprise Server to an organization account and enabled Server StatisticsOK
" } - ], - "descriptionHTML": "Returns aggregate usage metrics for your GitHub Enterprise Server 3.5+ instance for a specified time period up to 365 days.
\nTo use this endpoint, your GitHub Enterprise Server instance must be connected to GitHub Enterprise Cloud using GitHub Connect. You must enable Server Statistics, and for the API request provide your enterprise account name or organization name connected to the GitHub Enterprise Server. For more information, see \"Enabling Server Statistics for your enterprise\" in the GitHub Enterprise Server documentation.
\nOAuth app tokens and personal access tokens (classic) need:
\nread:enterprise scope if you connected your GitHub Enterprise Server to an enterprise account and enabled Server Statisticsread:org scope if you connected your GitHub Enterprise Server to an organization account and enabled Server StatisticsGets the summary of the free and paid GitHub Actions minutes used.
\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".
\nThe authenticated user must be an enterprise admin.
\nNote
\n\nThis endpoint is available to enterprise customers who are using the legacy billing platform.
\nGets the summary of the free and paid GitHub Actions minutes used.
\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".
\nThe authenticated user must be an enterprise admin.
\nNote
\n\nThis endpoint is available to enterprise customers who are using the legacy billing platform.
\nGets the GitHub Advanced Security active committers for an enterprise per repository.
\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository.
The total number of repositories with committer information is tracked by the total_count field.
Success
" } - ], - "descriptionHTML": "Gets the GitHub Advanced Security active committers for an enterprise per repository.
\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository.
The total number of repositories with committer information is tracked by the total_count field.
Gets the free and paid storage used for GitHub Packages in gigabytes.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nThe authenticated user must be an enterprise admin.
\nNote
\n\nThis endpoint is available to enterprise customers who are using the legacy billing platform.
\nOK
" } - ], - "descriptionHTML": "Gets the free and paid storage used for GitHub Packages in gigabytes.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nThe authenticated user must be an enterprise admin.
\nNote
\n\nThis endpoint is available to enterprise customers who are using the legacy billing platform.
\nGets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nThe authenticated user must be an enterprise admin.
\nNote
\n\nThis endpoint is available to enterprise customers who are using the legacy billing platform.
\nOK
" } - ] + ], + "descriptionHTML": "Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nThe authenticated user must be an enterprise admin.
\nNote
\n\nThis endpoint is available to enterprise customers who are using the legacy billing platform.
\nWarning
\n\nClosing down notice: The ability to fetch code security and analysis settings for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.
\nGets code security and analysis settings for the specified enterprise.
\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.
Warning
\n\nClosing down notice: The ability to fetch code security and analysis settings for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.
\nGets code security and analysis settings for the specified enterprise.
\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.
Warning
\n\nClosing down notice: The ability to update code security and analysis settings for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.
\nUpdates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise.
\nThe authenticated user must be an administrator of the enterprise to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Warning
\n\nClosing down notice: The ability to update code security and analysis settings for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.
\nUpdates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise.
\nThe authenticated user must be an administrator of the enterprise to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Warning
\n\nClosing down notice: The ability to enable or disable a security feature for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.
\nEnables or disables the specified security feature for all repositories in an enterprise.
\nThe authenticated user must be an administrator of the enterprise to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Warning
\n\nClosing down notice: The ability to enable or disable a security feature for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.
\nEnables or disables the specified security feature for all repositories in an enterprise.
\nThe authenticated user must be an administrator of the enterprise to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Gets information about the status of a license sync job for an enterprise.
\nThe authenticated user must be an enterprise admin to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.
License Sync Status Response
" } - ], - "descriptionHTML": "Gets information about the status of a license sync job for an enterprise.
\nThe authenticated user must be an enterprise admin to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.
Gets a hosted compute network configuration configured in an enterprise.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Gets a hosted compute network configuration configured in an enterprise.
" + ] }, { "serverUrl": "https://api.github.com", @@ -295913,7 +295913,7 @@ } ], "previews": [], - "descriptionHTML": "Update a provisioned group’s individual attributes.
\nTo modify a group's values, you'll need to use a specific Operations JSON format which must include at least one of the following operations: add, remove, or replace. For examples and more information on this SCIM format, consult the SCIM specification. The update function can also be used to add group memberships.
\nYou can submit group memberships individually or in batches for improved efficiency.
\nNote
\n\nMemberships are referenced via a local user id. Ensure users are created before referencing them here.
\nUpdate a provisioned group’s individual attributes.
\nTo modify a group's values, you'll need to use a specific Operations JSON format which must include at least one of the following operations: add, remove, or replace. For examples and more information on this SCIM format, consult the SCIM specification. The update function can also be used to add group memberships.
\nYou can submit group memberships individually or in batches for improved efficiency.
\nNote
\n\nMemberships are referenced via a local user id. Ensure users are created before referencing them here.
\nReplaces an existing provisioned user's information.
\nYou must supply complete user information, just as you would when provisioning them initially. Any previously existing data not provided will be deleted. To update only a specific attribute, refer to the Update an attribute for a SCIM user endpoint.
\nWarning
\n\nSetting active: false will suspend a user, and their handle and email will be obfuscated.
Replaces an existing provisioned user's information.
\nYou must supply complete user information, just as you would when provisioning them initially. Any previously existing data not provided will be deleted. To update only a specific attribute, refer to the Update an attribute for a SCIM user endpoint.
\nWarning
\n\nSetting active: false will suspend a user, and their handle and email will be obfuscated.
Update a provisioned user's individual attributes.
\nTo modify a user's attributes, you'll need to provide a Operations JSON formatted request that includes at least one of the following actions: add, remove, or replace. For specific examples and more information on the SCIM operations format, please refer to the SCIM specification.
Note
\n\nComplex SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will be ineffective.
Warning
\n\nSetting active: false will suspend a user, and their handle and email will be obfuscated.
{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\nUpdate a provisioned user's individual attributes.
\nTo modify a user's attributes, you'll need to provide a Operations JSON formatted request that includes at least one of the following actions: add, remove, or replace. For specific examples and more information on the SCIM operations format, please refer to the SCIM specification.
Note
\n\nComplex SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will be ineffective.
Warning
\n\nSetting active: false will suspend a user, and their handle and email will be obfuscated.
{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\nAllows you to add a new gist with one or more files.
\nNote
\n\nDon't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.
\nAllows you to add a new gist with one or more files.
\nNote
\n\nDon't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.
\nReturns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.
When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.
Note
\n\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nIf you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.
Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.
When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.
Note
\n\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nIf you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.
Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.
Note
\n\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nReturns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.
Note
\n\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nReturns a single tree using the SHA1 value or ref name for that tree.
\nIf truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.
Note
\n\nThe limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
Returns a single tree using the SHA1 value or ref name for that tree.
\nIf truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.
Note
\n\nThe limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.
Note
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.
Note
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues in an organization assigned to the authenticated user.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues in an organization assigned to the authenticated user.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues in a repository. Only open issues will be listed.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues in a repository. Only open issues will be listed.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.
Note
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.
Note
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues across owned and member repositories assigned to the authenticated user.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues across owned and member repositories assigned to the authenticated user.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Get Hypermedia links to resources accessible in GitHub's REST API
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Get Hypermedia links to resources accessible in GitHub's REST API
" }, { "serverUrl": "https://api.github.com", @@ -406366,7 +406366,7 @@ } ], "previews": [], - "descriptionHTML": "Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"About GitHub's IP addresses.\"
\nThe API's response also includes a list of GitHub's domain names.
\nThe values shown in the documentation's response are example values. You must always query the API directly to get the latest values.
\nNote
\n\nThis endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.
\nReturns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"About GitHub's IP addresses.\"
\nThe API's response also includes a list of GitHub's domain names.
\nThe values shown in the documentation's response are example values. You must always query the API directly to get the latest values.
\nNote
\n\nThis endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.
\nReturns all community profile metrics for a repository. The repository cannot be a fork.
\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.
\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.\"
content_reports_enabled is only returned for organization-owned repositories.
OK
" } - ], - "descriptionHTML": "Returns all community profile metrics for a repository. The repository cannot be a fork.
\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.
\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.\"
content_reports_enabled is only returned for organization-owned repositories.
Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
\nNote
\n\nThis endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned.
\nReturns a weekly aggregate of the number of additions and deletions pushed to a repository.
\nNote
\n\nThis endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned.
\nReturns the total number of commits authored by the contributor. In addition, the response includes a Weekly Hash (weeks array) with the following information:
w - Start of the week, given as a Unix timestamp.a - Number of additionsd - Number of deletionsc - Number of commitsNote
\n\nThis endpoint will return 0 values for all addition and deletion counts in repositories with 10,000 or more commits.
Returns the total number of commits authored by the contributor. In addition, the response includes a Weekly Hash (weeks array) with the following information:
w - Start of the week, given as a Unix timestamp.a - Number of additionsd - Number of deletionsc - Number of commitsNote
\n\nThis endpoint will return 0 values for all addition and deletion counts in repositories with 10,000 or more commits.
Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).
\nA list of repositories is only returned for export migrations.
OK
" } - ], - "descriptionHTML": "Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).
\nA list of repositories is only returned for export migrations.
Initiates the generation of a migration archive.
", "statusCodes": [ { "httpStatusCode": "201", @@ -411535,8 +411536,7 @@ "httpStatusCode": "422", "description": "Validation failed, or the endpoint has been spammed.
" } - ], - "descriptionHTML": "Initiates the generation of a migration archive.
" + ] }, { "serverUrl": "https://api.github.com", @@ -413127,6 +413127,7 @@ } ], "previews": [], + "descriptionHTML": "Deletes a previous migration archive. Migration archives are automatically deleted after seven days.
", "statusCodes": [ { "httpStatusCode": "204", @@ -413136,8 +413137,7 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ], - "descriptionHTML": "Deletes a previous migration archive. Migration archives are automatically deleted after seven days.
" + ] }, { "serverUrl": "https://api.github.com", @@ -413201,6 +413201,7 @@ } ], "previews": [], + "descriptionHTML": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and delete them when the migration is complete and you no longer need the source data.
", "statusCodes": [ { "httpStatusCode": "204", @@ -413210,8 +413211,7 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ], - "descriptionHTML": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and delete them when the migration is complete and you no longer need the source data.
" + ] }, { "serverUrl": "https://api.github.com", @@ -414504,7 +414504,7 @@ } ], "previews": [], - "descriptionHTML": "View the progress of an import.
\nWarning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nImport status
\nThis section includes details about the possible values of the status field of the Import Progress response.
An import that does not have errors will progress through these steps:
\ndetecting - the \"detection\" step of the import is in progress because the request did not include a vcs parameter. The import is identifying the type of source control present at the URL.importing - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include commit_count (the total number of raw commits that will be imported) and percent (0 - 100, the current progress through the import).mapping - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.pushing - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub Enterprise Cloud. The import progress response will include push_percent, which is the percent value reported by git push when it is \"Writing objects\".complete - the import is complete, and the repository is ready on GitHub Enterprise Cloud.If there are problems, you will see one of these in the status field:
auth_failed - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the Update an import section.error - the import encountered an error. The import progress response will include the failed_step and an error message. Contact GitHub Enterprise Cloud Support for more information.detection_needs_auth - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the Update an import section.detection_found_nothing - the importer didn't recognize any source control at the URL. To resolve, Cancel the import and retry with the correct URL.detection_found_multiple - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a project_choices field with the possible project choices as values. To update project choice, please see the Update an import section.The project_choices field
\nWhen multiple projects are found at the provided URL, the response hash will include a project_choices field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.
Git LFS related fields
\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.
\nuse_lfs - describes whether the import has been opted in or out of using Git LFS. The value can be opt_in, opt_out, or undecided if no action has been taken.has_large_files - the boolean value describing whether files larger than 100MB were found during the importing step.large_files_size - the total size in gigabytes of files larger than 100MB found in the originating repository.large_files_count - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.View the progress of an import.
\nWarning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nImport status
\nThis section includes details about the possible values of the status field of the Import Progress response.
An import that does not have errors will progress through these steps:
\ndetecting - the \"detection\" step of the import is in progress because the request did not include a vcs parameter. The import is identifying the type of source control present at the URL.importing - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include commit_count (the total number of raw commits that will be imported) and percent (0 - 100, the current progress through the import).mapping - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.pushing - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub Enterprise Cloud. The import progress response will include push_percent, which is the percent value reported by git push when it is \"Writing objects\".complete - the import is complete, and the repository is ready on GitHub Enterprise Cloud.If there are problems, you will see one of these in the status field:
auth_failed - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the Update an import section.error - the import encountered an error. The import progress response will include the failed_step and an error message. Contact GitHub Enterprise Cloud Support for more information.detection_needs_auth - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the Update an import section.detection_found_nothing - the importer didn't recognize any source control at the URL. To resolve, Cancel the import and retry with the correct URL.detection_found_multiple - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a project_choices field with the possible project choices as values. To update project choice, please see the Update an import section.The project_choices field
\nWhen multiple projects are found at the provided URL, the response hash will include a project_choices field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.
Git LFS related fields
\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.
\nuse_lfs - describes whether the import has been opted in or out of using Git LFS. The value can be opt_in, opt_out, or undecided if no action has been taken.has_large_files - the boolean value describing whether files larger than 100MB were found during the importing step.large_files_size - the total size in gigabytes of files larger than 100MB found in the originating repository.large_files_count - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.Start a source import to a GitHub Enterprise Cloud repository using GitHub Enterprise Cloud Importer.\nImporting into a GitHub Enterprise Cloud repository with GitHub Actions enabled is not supported and will\nreturn a status 422 Unprocessable Entity response.
Warning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nStart a source import to a GitHub Enterprise Cloud repository using GitHub Enterprise Cloud Importer.\nImporting into a GitHub Enterprise Cloud repository with GitHub Actions enabled is not supported and will\nreturn a status 422 Unprocessable Entity response.
Warning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nAn 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.
\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.
Warning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nAn 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.
\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.
Warning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nStop an import for a repository.
\nWarning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nStop an import for a repository.
\nWarning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nEach 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 Enterprise Cloud Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username hubot into something like hubot <hubot@12341234-abab-fefe-8787-fedcba987654>.
This endpoint and the Map a commit author endpoint allow you to provide correct Git author information.
\nWarning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nEach 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 Enterprise Cloud Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username hubot into something like hubot <hubot@12341234-abab-fefe-8787-fedcba987654>.
This endpoint and the Map a commit author endpoint allow you to provide correct Git author information.
\nWarning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nUpdate an author's identity for the import. Your application can continue updating authors any time before you push\nnew commits to the repository.
\nWarning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nUpdate an author's identity for the import. Your application can continue updating authors any time before you push\nnew commits to the repository.
\nWarning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nList files larger than 100MB found during the import
\nWarning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nList files larger than 100MB found during the import
\nWarning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nYou can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by Git LFS.
\nYou can learn more about our LFS feature and working with large files on our help\nsite.
\nWarning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nYou can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by Git LFS.
\nYou can learn more about our LFS feature and working with large files on our help\nsite.
\nWarning
\n\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.
\nLists all organizations, in the order that they were created.
\nNote
\n\nPagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
Lists all organizations, in the order that they were created.
\nNote
\n\nPagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
Warning
\n\nClosing down notice: GitHub Enterprise Cloud will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.
Warning
\n\nClosing down notice: Code security product enablement for new repositories through the organization API is closing down. Please use code security configurations to set defaults instead. For more information on setting a default security configuration, see the changelog.
\nUpdates the organization's profile and member privileges.
\nThe authenticated user must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Warning
\n\nClosing down notice: GitHub Enterprise Cloud will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.
Warning
\n\nClosing down notice: Code security product enablement for new repositories through the organization API is closing down. Please use code security configurations to set defaults instead. For more information on setting a default security configuration, see the changelog.
\nUpdates the organization's profile and member privileges.
\nThe authenticated user must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization.
\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the attestations:read permission is required.
Please note: in order to offer meaningful security benefits, an attestation's signature and timestamps must be cryptographically verified, and the identity of the attestation signer must be validated. Attestations can be verified using the GitHub CLI attestation verify command. For more information, see our guide on how to use artifact attestations to establish a build's provenance.
OK
" } - ], - "descriptionHTML": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization.
\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the attestations:read permission is required.
Please note: in order to offer meaningful security benefits, an attestation's signature and timestamps must be cryptographically verified, and the identity of the attestation signer must be validated. Attestations can be verified using the GitHub CLI attestation verify command. For more information, see our guide on how to use artifact attestations to establish a build's provenance.
Warning
\n\nClosing down notice: The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use code security configurations instead. For more information, see the changelog.
\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"Managing security managers in your organization.\"
\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org, write:org, or repo scopes to use this endpoint.
Warning
\n\nClosing down notice: The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use code security configurations instead. For more information, see the changelog.
\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"Managing security managers in your organization.\"
\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org, write:org, or repo scopes to use this endpoint.
List organizations for the authenticated user.
\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a 403 Forbidden response.
Note
\n\nRequests using a fine-grained access token will receive a 200 Success response with an empty list.
List organizations for the authenticated user.
\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a 403 Forbidden response.
Note
\n\nRequests using a fine-grained access token will receive a 200 Success response with an empty list.
Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.
" + ] }, { "serverUrl": "https://api.github.com", @@ -427253,13 +427253,13 @@ } ], "previews": [], + "descriptionHTML": "Get the number of API requests and rate-limited requests made within an organization over a specified time period.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Get the number of API requests and rate-limited requests made within an organization over a specified time period.
" + ] }, { "serverUrl": "https://api.github.com", @@ -427560,13 +427560,13 @@ } ], "previews": [], + "descriptionHTML": "Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period.
" + ] }, { "serverUrl": "https://api.github.com", @@ -427774,6 +427774,238 @@ ] } ], + "attestations": [ + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/orgs/{org}/attestations/delete-request", + "title": "Delete attestations in bulk", + "category": "orgs", + "subcategory": "attestations", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "array of strings", + "name": "subject_digests", + "in": "body", + "description": "List of subject digests associated with the artifact attestations to delete.
", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Attestations\" repository permissions": "write" + } + ] + }, + "codeExamples": [], + "previews": [], + "descriptionHTML": "Delete artifact attestations in bulk by either subject digests or unique ID.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/attestations/digest/{subject_digest}", + "title": "Delete attestations by subject digest", + "category": "orgs", + "subcategory": "attestations", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "subject_digest", + "description": "Subject Digest
", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Attestations\" repository permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "200", + "request": { + "description": "Example 1: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "subject_digest": "SUBJECT_DIGEST" + } + }, + "response": { + "statusCode": "200", + "description": "Response
" + } + }, + { + "key": "204", + "request": { + "description": "Example 2: Status Code 204", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "subject_digest": "SUBJECT_DIGEST" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Delete an artifact attestation by subject digest.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/attestations/{attestation_id}", + "title": "Delete attestations by ID", + "category": "orgs", + "subcategory": "attestations", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "attestation_id", + "description": "Attestation ID
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Attestations\" repository permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "200", + "request": { + "description": "Example 1: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "attestation_id": "ATTESTATION_ID" + } + }, + "response": { + "statusCode": "200", + "description": "Response
" + } + }, + { + "key": "204", + "request": { + "description": "Example 2: Status Code 204", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "attestation_id": "ATTESTATION_ID" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Delete an artifact attestation by unique ID that is associated with a repository owned by an org.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + } + ], "blocking": [ { "serverUrl": "https://api.github.com", @@ -428033,13 +428265,13 @@ } ], "previews": [], - "descriptionHTML": "List the users blocked by an organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "List the users blocked by an organization.
" }, { "serverUrl": "https://api.github.com", @@ -428233,13 +428465,13 @@ } ], "previews": [], + "descriptionHTML": "Unblocks the given user on behalf of the specified organization.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "Unblocks the given user on behalf of the specified organization.
" + ] } ], "bypass-requests": [ @@ -430299,13 +430531,13 @@ } ], "previews": [], + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.
\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Response - list of custom role names
" } - ], - "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.
\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Warning
\n\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"Create a custom repository role\" endpoint instead.
\nCreates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Warning
\n\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"Create a custom repository role\" endpoint instead.
\nCreates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Warning
\n\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"Get a custom repository role\" endpoint instead.
\nGets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Warning
\n\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"Get a custom repository role\" endpoint instead.
\nGets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Warning
\n\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"Update a custom repository role\" endpoint instead.
\nUpdates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Warning
\n\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"Update a custom repository role\" endpoint instead.
\nUpdates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Warning
\n\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"Delete a custom repository role\" endpoint instead.
\nDeletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Warning
\n\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"Delete a custom repository role\" endpoint instead.
\nDeletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Warning
\n\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"List fine-grained repository permissions\" endpoint instead.
\nLists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"About custom repository roles.\"
\nTo use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Warning
\n\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"List fine-grained repository permissions\" endpoint instead.
\nLists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"About custom repository roles.\"
\nTo use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
List all teams associated with an invitation. In order to see invitations\nin an organization, the authenticated user must be an organization owner.
\nThis endpoint is not available for Enterprise Managed User (EMU) organizations.
", "statusCodes": [ { "httpStatusCode": "200", @@ -435171,8 +435404,7 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ], - "descriptionHTML": "List all teams associated with an invitation. In order to see invitations\nin an organization, the authenticated user must be an organization owner.
\nThis endpoint is not available for Enterprise Managed User (EMU) organizations.
" + ] }, { "serverUrl": "https://api.github.com", @@ -435604,7 +435836,6 @@ } ], "previews": [], - "descriptionHTML": "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.
", "statusCodes": [ { "httpStatusCode": "204", @@ -435614,7 +435845,8 @@ "httpStatusCode": "403", "description": "Forbidden
" } - ] + ], + "descriptionHTML": "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.
" }, { "serverUrl": "https://api.github.com", @@ -436516,7 +436748,6 @@ } ], "previews": [], - "descriptionHTML": "Only authenticated organization owners can add a member to the organization or update the member's role.
\nIf the authenticated user is adding a member to the organization, the invited user will receive an email inviting them to the organization. The user's membership status will be pending until they accept the invitation.
Authenticated users can update a user's membership by passing the role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.
Rate limits
\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
", "statusCodes": [ { "httpStatusCode": "200", @@ -436530,7 +436761,8 @@ "httpStatusCode": "422", "description": "Validation failed, or the endpoint has been spammed.
" } - ] + ], + "descriptionHTML": "Only authenticated organization owners can add a member to the organization or update the member's role.
\nIf the authenticated user is adding a member to the organization, the invited user will receive an email inviting them to the organization. The user's membership status will be pending until they accept the invitation.
Authenticated users can update a user's membership by passing the role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.
Rate limits
\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
" }, { "serverUrl": "https://api.github.com", @@ -437064,13 +437296,13 @@ } ], "previews": [], - "descriptionHTML": "Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ] + ], + "descriptionHTML": "Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.
" }, { "serverUrl": "https://api.github.com", @@ -438797,13 +439029,13 @@ } ], "previews": [], - "descriptionHTML": "Creates a hosted compute network configuration for an organization.
\nOAuth app tokens and personal access tokens (classic) need the write:network_configurations scope to use this endpoint.
Created
" } - ] + ], + "descriptionHTML": "Creates a hosted compute network configuration for an organization.
\nOAuth app tokens and personal access tokens (classic) need the write:network_configurations scope to use this endpoint.
Gets a hosted compute network settings resource configured for an organization.
\nOAuth app tokens and personal access tokens (classic) need the read:network_configurations scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets a hosted compute network settings resource configured for an organization.
\nOAuth app tokens and personal access tokens (classic) need the read:network_configurations scope to use this endpoint.
Removes all assigned organization roles from a team. For more information on organization roles, see \"Using organization roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Removes all assigned organization roles from a team. For more information on organization roles, see \"Using organization roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Revokes all assigned organization roles from a user. For more information on organization roles, see \"Using organization roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Revokes all assigned organization roles from a user. For more information on organization roles, see \"Using organization roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Deletes a custom organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"
\nTo use this endpoint, the authenticated user must be one of:
\nwrite_organization_custom_org_role in the organization.OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Deletes a custom organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"
\nTo use this endpoint, the authenticated user must be one of:
\nwrite_organization_custom_org_role in the organization.OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
List all users who are outside collaborators of an organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "List all users who are outside collaborators of an organization.
" }, { "serverUrl": "https://api.github.com", @@ -442605,7 +442837,6 @@ } ], "previews": [], - "descriptionHTML": "Removing a user from this list will remove them from all the organization's repositories.
", "statusCodes": [ { "httpStatusCode": "204", @@ -442615,7 +442846,8 @@ "httpStatusCode": "422", "description": "Unprocessable Entity if user is a member of the organization
" } - ] + ], + "descriptionHTML": "Removing a user from this list will remove them from all the organization's repositories.
" } ], "personal-access-tokens": [ @@ -455151,7 +455383,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.
\nWarning
\n\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.
\nWarning
\n\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.
\nNo Content
" } - ] + ], + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.
\nWarning
\n\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.
\nNo Content
" } - ], - "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.
\nYou must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit webhooks\nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
Resource not found
" } - ] + ], + "descriptionHTML": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit webhooks\nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit webhooks\nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
OK
" } - ], - "descriptionHTML": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit webhooks\nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
Lists all private registry configurations available at the organization-level without revealing their encrypted\nvalues.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Resource not found
" } - ], - "descriptionHTML": "Lists all private registry configurations available at the organization-level without revealing their encrypted\nvalues.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nValidation failed, or the endpoint has been spammed.
" } - ], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nLists the files in a specified pull request.
\nNote
\n\nResponses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Lists the files in a specified pull request.
\nNote
\n\nResponses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Creates a review on a specified pull request.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note
\n\nTo comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the application/vnd.github.v3.diff media type to the Accept header of a call to the Get a pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Creates a review on a specified pull request.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note
\n\nTo comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the application/vnd.github.v3.diff media type to the Accept header of a call to the Get a pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Dismisses a specified review on a pull request.
\nNote
\n\nTo dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Dismisses a specified review on a pull request.
\nNote
\n\nTo dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Note
\n\nAccessing this endpoint does not count against your REST API rate limit.
\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under resources, you'll see objects relating to different categories:
core object provides your rate limit status for all non-search-related resources in the REST API.search object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"Search.\"code_search object provides your rate limit status for the REST API for searching code. For more information, see \"Search code.\"graphql object provides your rate limit status for the GraphQL API. For more information, see \"Resource limitations.\"integration_manifest object provides your rate limit status for the POST /app-manifests/{code}/conversions operation. For more information, see \"Creating a GitHub App from a manifest.\"dependency_snapshots object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"Dependency graph.\"dependency_sbom object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"Dependency graph.\"code_scanning_upload object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"Uploading a SARIF file to GitHub.\"actions_runner_registration object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"Self-hosted runners.\"source_import object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"API Versions.\"Note
\n\nThe rate object is closing down. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.
Note
\n\nAccessing this endpoint does not count against your REST API rate limit.
\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under resources, you'll see objects relating to different categories:
core object provides your rate limit status for all non-search-related resources in the REST API.search object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"Search.\"code_search object provides your rate limit status for the REST API for searching code. For more information, see \"Search code.\"graphql object provides your rate limit status for the GraphQL API. For more information, see \"Resource limitations.\"integration_manifest object provides your rate limit status for the POST /app-manifests/{code}/conversions operation. For more information, see \"Creating a GitHub App from a manifest.\"dependency_snapshots object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"Dependency graph.\"dependency_sbom object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"Dependency graph.\"code_scanning_upload object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"Uploading a SARIF file to GitHub.\"actions_runner_registration object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"Self-hosted runners.\"source_import object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"API Versions.\"Note
\n\nThe rate object is closing down. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.
List the reactions to a team discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
List the reactions to a team discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Create a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Create a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
List the reactions to a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
List the reactions to a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Create a reaction to a team discussion.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Create a reaction to a team discussion.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
List the reactions to a commit comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -524003,7 +524234,8 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ] + ], + "descriptionHTML": "List the reactions to a commit comment.
" }, { "serverUrl": "https://api.github.com", @@ -524711,13 +524943,13 @@ } ], "previews": [], + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
" + ] }, { "serverUrl": "https://api.github.com", @@ -525799,13 +526031,13 @@ } ], "previews": [], + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
" + ] }, { "serverUrl": "https://api.github.com", @@ -526888,7 +527120,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", "statusCodes": [ { "httpStatusCode": "204", @@ -527976,7 +528208,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -529047,7 +529279,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", "statusCodes": [ { "httpStatusCode": "204", @@ -529405,7 +529637,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Created
" } - ] + ], + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Gets a public release with the specified release ID.
\nNote
\n\nThis returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"Getting started with the REST API.\"
Gets a public release with the specified release ID.
\nNote
\n\nThis returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"Getting started with the REST API.\"
OK
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "https://uploads.github.com", @@ -538029,7 +538261,7 @@ } ], "previews": [], - "descriptionHTML": "Lists repositories for the specified organization.
\nNote
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
Lists repositories for the specified organization.
\nNote
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.
Note
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.
Note
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
Creates a new file or replaces an existing file in a repository.
\nNote
\n\nIf you use this endpoint and the \"Delete a file\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. The workflow scope is also required in order to modify files in the .github/workflows directory.
Creates a new file or replaces an existing file in a repository.
\nNote
\n\nIf you use this endpoint and the \"Delete a file\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. The workflow scope is also required in order to modify files in the .github/workflows directory.
Deletes a file in a repository.
\nYou can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.
The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.
You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.
Note
\n\nIf you use this endpoint and the \"Create or update file contents\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
\nDeletes a file in a repository.
\nYou can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.
The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.
You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.
Note
\n\nIf you use this endpoint and the \"Create or update file contents\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
\nGets a redirect URL to download a tar archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes.
\nGets a redirect URL to download a tar archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes.
\nGets a redirect URL to download a zip archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.
\nGets a redirect URL to download a zip archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.
\nCreate a fork for the authenticated user.
\nNote
\n\nForking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub Enterprise Cloud Support.
\nNote
\n\nAlthough this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.
\nCreate a fork for the authenticated user.
\nNote
\n\nForking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub Enterprise Cloud Support.
\nNote
\n\nAlthough this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.
\nWarning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis returns the tag protection states of a repository.
\nThis information is only available to repository administrators.
", + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis returns the tag protection states of a repository.
\nThis information is only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "200", @@ -591192,7 +591424,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "201", @@ -591274,7 +591506,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "204", @@ -592730,13 +592962,13 @@ } ], "previews": [], + "descriptionHTML": "Returns the webhook configuration for a repository. To get more information about the webhook, including the active state and events, use \"Get a repository webhook.\"
OAuth app tokens and personal access tokens (classic) need the read:repo_hook or repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Returns the webhook configuration for a repository. To get more information about the webhook, including the active state and events, use \"Get a repository webhook.\"
OAuth app tokens and personal access tokens (classic) need the read:repo_hook or repo scope to use this endpoint.
This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook is not subscribed to push events, the server will respond with 204 but no test POST will be generated.
Note
\n\nPreviously /repos/:owner/:repo/hooks/:hook_id/test
This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook is not subscribed to push events, the server will respond with 204 but no test POST will be generated.
Note
\n\nPreviously /repos/:owner/:repo/hooks/:hook_id/test
Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the Update an attribute for a SCIM user endpoint instead.
\nYou must at least provide the required values for the user: userName, name, and emails.
Warning
\n\nSetting active: false removes the user from the organization, deletes the external identity, and deletes the associated {scim_user_id}.
Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the Update an attribute for a SCIM user endpoint instead.
\nYou must at least provide the required values for the user: userName, name, and emails.
Warning
\n\nSetting active: false removes the user from the organization, deletes the external identity, and deletes the associated {scim_user_id}.
Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.
Note
\n\nComplicated SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will not work.
Warning
\n\nIf you set active:false using the replace operation (as shown in the JSON example below), it removes the user from the organization, deletes the external identity, and deletes the associated :scim_user_id.
{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\nAllows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.
Note
\n\nComplicated SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will not work.
Warning
\n\nIf you set active:false using the replace operation (as shown in the JSON example below), it removes the user from the organization, deletes the external identity, and deletes the associated :scim_user_id.
{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\nWarning
\n\nNotice: Search for issues and pull requests will be overridden by advanced search on September 4, 2025.\nYou can read more about this change on the GitHub blog.
\nWarning
\n\nNotice: Search for issues and pull requests will be overridden by advanced search on September 4, 2025.\nYou can read more about this change on the GitHub blog.
\nLists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.
\nBy default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the type parameter in your request, with the value malware. For more information about the different types of security advisories, see \"About the GitHub Advisory database.\"
Too many requests
" } - ] + ], + "descriptionHTML": "Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.
\nBy default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the type parameter in your request, with the value malware. For more information about the different types of security advisories, see \"About the GitHub Advisory database.\"
Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier.
", "statusCodes": [ { "httpStatusCode": "200", @@ -616903,7 +617135,8 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ] + ], + "descriptionHTML": "Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier.
" } ], "repository-advisories": [ @@ -638445,7 +638678,7 @@ } ], "previews": [], - "descriptionHTML": "Create a temporary private fork to collaborate on fixing a security vulnerability in your repository.
\nNote
\n\nForking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork.
\nCreate a temporary private fork to collaborate on fixing a security vulnerability in your repository.
\nNote
\n\nForking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork.
\nGets a team using the team's slug. To create the slug, GitHub Enterprise Cloud replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a - separator. For example, \"My TEam Näme\" would become my-team-name.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
Gets a team using the team's slug. To create the slug, GitHub Enterprise Cloud replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a - separator. For example, \"My TEam Näme\" would become my-team-name.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
To edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}.
To edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}.
To delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}.
No Content
" } - ] + ], + "descriptionHTML": "To delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}.
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nOK
" } - ] + ], + "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nLists a team's repositories visible to the authenticated user.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos.
Lists a team's repositories visible to the authenticated user.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos.
Checks whether a team has admin, push, maintain, triage, or pull permission for a repository. Repositories inherited through a parent team will also be checked.
You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the application/vnd.github.v3.repository+json accept header.
If a team doesn't have permission for the repository, you will receive a 404 Not Found response status.
If the repository is private, you must have at least read permission for that repository, and your token must have the repo or admin:org scope. Otherwise, you will receive a 404 Not Found response status.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
Checks whether a team has admin, push, maintain, triage, or pull permission for a repository. Repositories inherited through a parent team will also be checked.
You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the application/vnd.github.v3.repository+json accept header.
If a team doesn't have permission for the repository, you will receive a 404 Not Found response status.
If the repository is private, you must have at least read permission for that repository, and your token must have the repo or admin:org scope. Otherwise, you will receive a 404 Not Found response status.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Note
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
For more information about the permission levels, see \"Repository permission levels for an organization\".
", + "descriptionHTML": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Note
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
For more information about the permission levels, see \"Repository permission levels for an organization\".
", "statusCodes": [ { "httpStatusCode": "204", @@ -645206,7 +645439,7 @@ } ], "previews": [], - "descriptionHTML": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
Lists the child teams of the team specified by {team_slug}.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.
Lists the child teams of the team specified by {team_slug}.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the Get a team by name endpoint.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the Get a team by name endpoint.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a team endpoint.
\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote
\n\nWith nested teams, the privacy for parent teams cannot be secret.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a team endpoint.
\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote
\n\nWith nested teams, the privacy for parent teams cannot be secret.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a team endpoint.
\nTo delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
", + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a team endpoint.
\nTo delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
", "statusCodes": [ { "httpStatusCode": "204", @@ -648216,7 +648449,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team repositories endpoint.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team repositories endpoint.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a repository endpoint.
\nNote
\n\nRepositories inherited through a parent team will also be checked.
\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a repository endpoint.
\nNote
\n\nRepositories inherited through a parent team will also be checked.
\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Add or update team repository permissions\" endpoint.
\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization.
Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Add or update team repository permissions\" endpoint.
\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization.
Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a repository from a team endpoint.
\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.
", + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a repository from a team endpoint.
\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.
", "statusCodes": [ { "httpStatusCode": "204", @@ -651326,7 +651559,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List child teams endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List child teams endpoint.
List all comments on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
List all comments on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Creates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Created
" } - ], - "descriptionHTML": "Creates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Get a specific comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Get a specific comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Edits the body text of a discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Edits the body text of a discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Deletes a comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Deletes a comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion comments endpoint.
\nList all comments on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion comments endpoint.
\nList all comments on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.
\nCreates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.
\nCreates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion comment endpoint.
\nGet a specific comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion comment endpoint.
\nGet a specific comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.
\nEdits the body text of a discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.
\nEdits the body text of a discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion comment endpoint.
\nDeletes a comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion comment endpoint.
\nDeletes a comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
List all discussions on a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
List all discussions on a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Get a specific discussion on a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Get a specific discussion on a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Edits the title and body text of a discussion post. Only the parameters you provide are updated.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Edits the title and body text of a discussion post. Only the parameters you provide are updated.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Delete a discussion from a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Delete a discussion from a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.
List all discussions on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.
List all discussions on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.
Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.
Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion endpoint.
\nGet a specific discussion on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion endpoint.
\nGet a specific discussion on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion endpoint.
\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion endpoint.
\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion endpoint.
Delete a discussion from a team's page.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion endpoint.
Delete a discussion from a team's page.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
" + ] }, { "serverUrl": "https://api.github.com", @@ -660988,7 +661221,7 @@ } ], "previews": [], - "descriptionHTML": "The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub Enterprise Cloud member, the login field in the return hash will be null.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/invitations.
The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub Enterprise Cloud member, the login field in the return hash will be null.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/invitations.
Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note
\n\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note
\n\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Cloud.\"
\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}.
Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Cloud.\"
\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}.
To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Cloud.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}.
To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Cloud.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List pending team invitations endpoint.
The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub Enterprise Cloud member, the login field in the return hash will be null.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List pending team invitations endpoint.
The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub Enterprise Cloud member, the login field in the return hash will be null.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members endpoint.
Team members will include the members of child teams.
", + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members endpoint.
Team members will include the members of child teams.
", "statusCodes": [ { "httpStatusCode": "200", @@ -662326,7 +662559,7 @@ } ], "previews": [], - "descriptionHTML": "The \"Add team member\" endpoint (described below) is closing down.
\nWe recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Cloud.\"
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
The \"Add team member\" endpoint (described below) is closing down.
\nWe recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Cloud.\"
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
The \"Remove team member\" endpoint (described below) is closing down.
\nWe recommend using the Remove team membership for a user endpoint instead. It allows you to remove both active and pending memberships.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Cloud.\"
\nThe \"Remove team member\" endpoint (described below) is closing down.
\nWe recommend using the Remove team membership for a user endpoint instead. It allows you to remove both active and pending memberships.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Cloud.\"
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership for a user endpoint.
\nTeam members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership for a user endpoint.
\nTeam members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Cloud.\"
\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
", + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Cloud.\"
\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
", "statusCodes": [ { "httpStatusCode": "200", @@ -662684,7 +662917,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Cloud.\"
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Cloud.\"
\nList IdP groups connected to a team on GitHub Enterprise Cloud.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings.
List IdP groups connected to a team on GitHub Enterprise Cloud.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings.
Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty groups array will remove all connections for a team.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings.
OK
" } - ] + ], + "descriptionHTML": "Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty groups array will remove all connections for a team.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List IdP groups for a team endpoint.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nList IdP groups connected to a team on GitHub Enterprise Cloud.
", + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List IdP groups for a team endpoint.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nList IdP groups connected to a team on GitHub Enterprise Cloud.
", "statusCodes": [ { "httpStatusCode": "200", @@ -663495,7 +663728,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create or update IdP group connections endpoint.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nCreates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty groups array will remove all connections for a team.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create or update IdP group connections endpoint.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nCreates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty groups array will remove all connections for a team.
Lists all artifacts for a repository.
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
OK
" } - ], - "descriptionHTML": "Lists all artifacts for a repository.
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Lists the GitHub Actions caches for a repository.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists the GitHub Actions caches for a repository.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Deletes a GitHub Actions cache for a repository, using a cache ID.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Deletes a GitHub Actions cache for a repository, using a cache ID.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Deletes a secret in an environment using the secret name.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Default response
" } - ], - "descriptionHTML": "Deletes a secret in an environment using the secret name.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Lists all self-hosted runner groups for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists all self-hosted runner groups for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Lists all labels for a self-hosted runner configured in an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Resource not found
" } - ], - "descriptionHTML": "Lists all labels for a self-hosted runner configured in an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"Using environments for deployment.\"
\nNote
\n\nGitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"Using environments for deployment.\"
\nNote
\n\nGitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Note
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nIf you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. Optional: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nIf you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. Optional: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nThis is the user's organization dashboard. You must be authenticated as the user to view this.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nThis is the user's organization dashboard. You must be authenticated as the user to view this.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nThese are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nThese are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nLists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.
\nuri_template. For more information, see \"Hypermedia.\"By default, timeline resources are returned in JSON. You can specify the application/atom+xml type in the Accept header to return timeline resources in Atom format. For more information, see \"Media types.\"
Note
\n\nPrivate feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
\nLists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.
\nuri_template. For more information, see \"Hypermedia.\"By default, timeline resources are returned in JSON. You can specify the application/atom+xml type in the Accept header to return timeline resources in Atom format. For more information, see \"Media types.\"
Note
\n\nPrivate feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
\nLists the people watching the specified repository.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Lists the people watching the specified repository.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -98739,7 +98739,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nThe :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).
Note
\n\nThe :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).
Renames a branch in a repository.
\nNote
\n\nAlthough the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".
\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.
\nIn order to rename the default branch, fine-grained access tokens also need the administration:write repository permission.
Renames a branch in a repository.
\nNote
\n\nAlthough the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".
\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.
\nIn order to rename the default branch, fine-grained access tokens also need the administration:write repository permission.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nProtecting a branch requires admin or owner permissions to the repository.
\nNote
\n\nPassing new arrays of users and teams replaces their previous values.
Note
\n\nThe list of users, apps, and teams in total is limited to 100 items.
\nProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nProtecting a branch requires admin or owner permissions to the repository.
\nNote
\n\nPassing new arrays of users and teams replaces their previous values.
Note
\n\nThe list of users, apps, and teams in total is limited to 100 items.
\nProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -127488,7 +127488,7 @@ } ], "previews": [], - "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
\nNote
\n\nPassing new arrays of users and teams replaces their previous values.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
\nNote
\n\nPassing new arrays of users and teams replaces their previous values.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.
Note
\n\nYou must enable branch protection to require signed commits.
\nProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.
Note
\n\nYou must enable branch protection to require signed commits.
\nProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists who has access to this protected branch.
\nNote
\n\nUsers, apps, and teams restrictions are only available for organization-owned repositories.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists who has access to this protected branch.
\nNote
\n\nUsers, apps, and teams restrictions are only available for organization-owned repositories.
Creates a new check run for a specific commit in a repository.
\nTo create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.
\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
\nNote
\n\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Creates a new check run for a specific commit in a repository.
\nTo create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.
\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
\nNote
\n\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Gets a single check run using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Gets a single check run using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Updates a check run for a specific commit in a repository.
\nNote
\n\nThe 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.
OAuth apps and personal access tokens (classic) cannot use this endpoint.
", + "descriptionHTML": "Updates a check run for a specific commit in a repository.
\nNote
\n\nThe 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.
OAuth apps and personal access tokens (classic) cannot use this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -141474,7 +141474,7 @@ } ], "previews": [], - "descriptionHTML": "Lists check runs for a check suite using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check runs for a check suite using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name.
Note
\n\nThe 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 endpoint and provide the check_suite_id parameter to the List check runs in a check suite endpoint.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name.
Note
\n\nThe 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 endpoint and provide the check_suite_id parameter to the List check runs in a check suite endpoint.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Creates a check suite manually. By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"Update repository preferences for check suites\".
\nNote
\n\nThe 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.
OAuth apps and personal access tokens (classic) cannot use this endpoint.
", + "descriptionHTML": "Creates a check suite manually. By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"Update repository preferences for check suites\".
\nNote
\n\nThe 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.
OAuth apps and personal access tokens (classic) cannot use this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -149869,7 +149869,7 @@ } ], "previews": [], - "descriptionHTML": "Gets a single check suite using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Gets a single check suite using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.
The rules_count field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.
Warning
\n\nClosing down notice: The tool_name field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.
OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.
The rules_count field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.
Warning
\n\nClosing down notice: The tool_name field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.
OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Removes a collaborator from a repository.
\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.
\nThis endpoint also:
\nRemoving a user as a collaborator has the following effects on forks:
\nNote
\n\nA user can still have access to the repository through organization permissions like base repository permissions.
\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.
\nFor more information on fork permissions, see \"About permissions and visibility of forks\".
", + "descriptionHTML": "Removes a collaborator from a repository.
\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.
\nThis endpoint also:
\nRemoving a user as a collaborator has the following effects on forks:
\nNote
\n\nA user can still have access to the repository through organization permissions like base repository permissions.
\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.
\nFor more information on fork permissions, see \"About permissions and visibility of forks\".
", "statusCodes": [ { "httpStatusCode": "204", @@ -161784,13 +161784,13 @@ } ], "previews": [], + "descriptionHTML": "When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -171588,7 +171588,7 @@ } ], "previews": [], - "descriptionHTML": "Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.
Note
\n\nIf there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\" Pagination query parameters are not supported for these media types.
\napplication/vnd.github.diff: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property. Larger diffs may time out and return a 5xx status code.application/vnd.github.sha: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
verified_at | string | The date the signature was verified by GitHub. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on their account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.
Note
\n\nIf there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\" Pagination query parameters are not supported for these media types.
\napplication/vnd.github.diff: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property. Larger diffs may time out and return a 5xx status code.application/vnd.github.sha: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
verified_at | string | The date the signature was verified by GitHub. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on their account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Note
\n\nTo get information about name patterns that branches must match in order to deploy to this environment, see \"Get a deployment branch policy.\"
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Note
\n\nTo get information about name patterns that branches must match in order to deploy to this environment, see \"Get a deployment branch policy.\"
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"Environments.\"
\nNote
\n\nTo create or update name patterns that branches must match in order to deploy to this environment, see \"Deployment branch policies.\"
\nNote
\n\nTo create or update secrets for an environment, see \"GitHub Actions secrets.\"
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"Environments.\"
\nNote
\n\nTo create or update name patterns that branches must match in order to deploy to this environment, see \"Deployment branch policies.\"
\nNote
\n\nTo create or update secrets for an environment, see \"GitHub Actions secrets.\"
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment.
\nNote
\n\nIt's recommended to use the log_url parameter, which replaces target_url.
The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment.
\nNote
\n\nIt's recommended to use the log_url parameter, which replaces target_url.
OK
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -201499,13 +201499,13 @@ } ], "previews": [], + "descriptionHTML": "Gets the current message and expiration date of the global announcement banner in your enterprise.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Gets the current message and expiration date of the global announcement banner in your enterprise.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -202726,13 +202726,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -203426,13 +203426,13 @@ } ], "previews": [], + "descriptionHTML": "Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -203488,13 +203488,13 @@ } ], "previews": [], + "descriptionHTML": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a 201 is returned, the sync job is queued successfully, and is performed when the instance is ready.
Created
" } - ], - "descriptionHTML": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a 201 is returned, the sync job is queued successfully, and is performed when the instance is ready.
When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.
\nImportant
\n\nTo start the configuration process and apply the license, you need to POST to /manage/v1/config/apply
The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.
\nNote
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.
\nImportant
\n\nTo start the configuration process and apply the license, you need to POST to /manage/v1/config/apply
The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.
\nNote
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
Uploads a new enterprise license. In order to apply it right away, use the apply query parameter.
Note
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
Uploads a new enterprise license. In order to apply it right away, use the apply query parameter.
Note
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
Note
\n\nThe request body for this operation must be submitted as application/x-www-form-urlencoded data. You can submit a parameter value as a string, or you can use a tool such as curl to submit a parameter value as the contents of a text file. For more information, see the curl documentation.
Note
\n\nThe request body for this operation must be submitted as application/x-www-form-urlencoded data. You can submit a parameter value as a string, or you can use a tool such as curl to submit a parameter value as the contents of a text file. For more information, see the curl documentation.
Gets the settings for your instance. To change settings, see the Set settings endpoint.
\nNote
\n\nYou cannot retrieve the management console password with the Enterprise administration API.
\nGets the settings for your instance. To change settings, see the Set settings endpoint.
\nNote
\n\nYou cannot retrieve the management console password with the Enterprise administration API.
\nWhen you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.
\nNote that you need to POST to /setup/api/configure to start the actual configuration process.
When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:
\nNote
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.
\nNote that you need to POST to /setup/api/configure to start the actual configuration process.
When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:
\nNote
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
This API upgrades your license and also triggers the configuration process.
\nNote
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
This API upgrades your license and also triggers the configuration process.
\nNote
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -208252,13 +208252,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -209017,13 +209017,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -209275,6 +209275,7 @@ } ], "previews": [], + "descriptionHTML": "You cannot modify the default environment. If you attempt to modify the default environment, you will receive a 422 Unprocessable Entity response.
Client Errors
" } - ], - "descriptionHTML": "You cannot modify the default environment. If you attempt to modify the default environment, you will receive a 422 Unprocessable Entity response.
OK
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -211163,7 +211163,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nLists provisioned SCIM groups in an enterprise.
\nYou can improve query search time by using the excludedAttributes query parameter with a value of members to exclude members from the response.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nLists provisioned SCIM groups in an enterprise.
\nYou can improve query search time by using the excludedAttributes query parameter with a value of members to exclude members from the response.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nCreates a SCIM group for an enterprise.
\nIf members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the externalId and id of each user.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nCreates a SCIM group for an enterprise.
\nIf members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the externalId and id of each user.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nGets information about a SCIM group.
", + "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nGets information about a SCIM group.
", "statusCodes": [ { "httpStatusCode": "200", @@ -212298,7 +212298,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nReplaces an existing provisioned group’s information.
\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the Update an attribute for a SCIM enterprise group endpoint instead.
", + "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nReplaces an existing provisioned group’s information.
\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the Update an attribute for a SCIM enterprise group endpoint instead.
", "statusCodes": [ { "httpStatusCode": "200", @@ -212845,7 +212845,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nUpdate a provisioned group’s individual attributes.
\nTo change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification. Update can also be used to add group memberships.
\nGroup memberships can be sent one at a time or in batches for faster performance. Note: The memberships are referenced through a local user id, and the user will need to be created before they are referenced here.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nUpdate a provisioned group’s individual attributes.
\nTo change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification. Update can also be used to add group memberships.
\nGroup memberships can be sent one at a time or in batches for faster performance. Note: The memberships are referenced through a local user id, and the user will need to be created before they are referenced here.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nDeletes a SCIM group from an enterprise.
", + "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nDeletes a SCIM group from an enterprise.
", "statusCodes": [ { "httpStatusCode": "204", @@ -213400,7 +213400,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nLists provisioned SCIM enterprise members.
\nWhen a user with a SCIM-provisioned external identity is removed from an enterprise through a patch with active flag set to false, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the delete request. Users that were not permanently deleted will be visible in the returned results.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nLists provisioned SCIM enterprise members.
\nWhen a user with a SCIM-provisioned external identity is removed from an enterprise through a patch with active flag set to false, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the delete request. Users that were not permanently deleted will be visible in the returned results.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nCreates an external identity for a new SCIM enterprise user.
\nSCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response NameID to SCIM userName.
When converting existing enterprise to use SCIM, the user handle (userName) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nCreates an external identity for a new SCIM enterprise user.
\nSCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response NameID to SCIM userName.
When converting existing enterprise to use SCIM, the user handle (userName) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nGets information about a SCIM user.
", + "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nGets information about a SCIM user.
", "statusCodes": [ { "httpStatusCode": "200", @@ -215135,7 +215135,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nReplaces an existing provisioned user's information.
\nYou must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the Update an attribute for a SCIM user endpoint instead.
\nWarning
\n\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nReplaces an existing provisioned user's information.
\nYou must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the Update an attribute for a SCIM user endpoint instead.
\nWarning
\n\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nUpdate a provisioned user's individual attributes.
\nTo change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.
Note
\n\nComplicated SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will not work.
Warning
\n\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.
{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\nNote
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nUpdate a provisioned user's individual attributes.
\nTo change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.
Note
\n\nComplicated SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will not work.
Warning
\n\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.
{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\nNote
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nPermanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action.
", + "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nPermanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action.
", "statusCodes": [ { "httpStatusCode": "204", @@ -222162,7 +222162,7 @@ } ], "previews": [], - "descriptionHTML": "Allows you to add a new gist with one or more files.
\nNote
\n\nDon't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.
\nAllows you to add a new gist with one or more files.
\nNote
\n\nDon't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.
\nReturns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.
When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.
Note
\n\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nIf you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.
Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.
When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.
Note
\n\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nIf you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.
Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.
Note
\n\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nReturns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.
Note
\n\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nReturns a single tree using the SHA1 value or ref name for that tree.
\nIf truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.
Note
\n\nThe limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
Returns a single tree using the SHA1 value or ref name for that tree.
\nIf truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.
Note
\n\nThe limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.
Note
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.
Note
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues in an organization assigned to the authenticated user.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues in an organization assigned to the authenticated user.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues in a repository. Only open issues will be listed.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues in a repository. Only open issues will be listed.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.
Note
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.
Note
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues across owned and member repositories assigned to the authenticated user.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues across owned and member repositories assigned to the authenticated user.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return [\"repo\", \"user\"].
Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return [\"repo\", \"user\"].
Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on the application authorizations settings screen within GitHub.
", + "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on the application authorizations settings screen within GitHub.
", "statusCodes": [ { "httpStatusCode": "204", @@ -325977,7 +325977,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nCreates OAuth tokens using Basic Authentication. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use fingerprint to differentiate between them.
You can also create tokens on GitHub Enterprise Server from the personal access tokens settings page. Read more about these tokens in the GitHub Help documentation.
\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see \"About identity and access management with SAML single sign-on\" in the GitHub Enterprise Cloud documentation.
", + "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nCreates OAuth tokens using Basic Authentication. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use fingerprint to differentiate between them.
You can also create tokens on GitHub Enterprise Server from the personal access tokens settings page. Read more about these tokens in the GitHub Help documentation.
\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see \"About identity and access management with SAML single sign-on\" in the GitHub Enterprise Cloud documentation.
", "statusCodes": [ { "httpStatusCode": "201", @@ -328070,7 +328070,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nCreates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
", + "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nCreates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -329011,7 +329011,7 @@ }, { "httpStatusCode": "201", - "description": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nThis method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. fingerprint is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
", + "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nThis method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. fingerprint is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -331992,7 +331992,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nYou can only send one of these scope keys at a time.
", + "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nYou can only send one of these scope keys at a time.
", "statusCodes": [ { "httpStatusCode": "200", @@ -333084,7 +333084,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nLists all organizations, in the order that they were created.
\nNote
\n\nPagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
Lists all organizations, in the order that they were created.
\nNote
\n\nPagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
Warning
\n\nClosing down notice: GitHub Enterprise Server will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.
Updates the organization's profile and member privileges.
\nThe authenticated user must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Warning
\n\nClosing down notice: GitHub Enterprise Server will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.
Updates the organization's profile and member privileges.
\nThe authenticated user must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
List organizations for the authenticated user.
\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a 403 Forbidden response.
Note
\n\nRequests using a fine-grained access token will receive a 200 Success response with an empty list.
List organizations for the authenticated user.
\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a 403 Forbidden response.
Note
\n\nRequests using a fine-grained access token will receive a 200 Success response with an empty list.
Warning
\n\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.
\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Warning
\n\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.
\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Gets a specific package in an organization.
\nOAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
OK
" } - ], - "descriptionHTML": "Gets a specific package in an organization.
\nOAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
Gets a specific package for a package owned by the authenticated user.
\nOAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
OK
" } - ], - "descriptionHTML": "Gets a specific package for a package owned by the authenticated user.
\nOAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
Gets information about the single most recent build of a GitHub Enterprise Server Pages site.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets information about the single most recent build of a GitHub Enterprise Server Pages site.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Lists the files in a specified pull request.
\nNote
\n\nResponses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Lists the files in a specified pull request.
\nNote
\n\nResponses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Creates a review on a specified pull request.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note
\n\nTo comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the application/vnd.github.v3.diff media type to the Accept header of a call to the Get a pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Creates a review on a specified pull request.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note
\n\nTo comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the application/vnd.github.v3.diff media type to the Accept header of a call to the Get a pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Dismisses a specified review on a pull request.
\nNote
\n\nTo dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Dismisses a specified review on a pull request.
\nNote
\n\nTo dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Note
\n\nAccessing this endpoint does not count against your REST API rate limit.
\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under resources, you'll see objects relating to different categories:
core object provides your rate limit status for all non-search-related resources in the REST API.search object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"Search.\"code_search object provides your rate limit status for the REST API for searching code. For more information, see \"Search code.\"graphql object provides your rate limit status for the GraphQL API. For more information, see \"Resource limitations.\"integration_manifest object provides your rate limit status for the POST /app-manifests/{code}/conversions operation. For more information, see \"Creating a GitHub App from a manifest.\"dependency_snapshots object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"Dependency graph.\"dependency_sbom object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"Dependency graph.\"code_scanning_upload object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"Uploading a SARIF file to GitHub.\"actions_runner_registration object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"Self-hosted runners.\"source_import object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"API Versions.\"Note
\n\nThe rate object is closing down. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.
Note
\n\nAccessing this endpoint does not count against your REST API rate limit.
\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under resources, you'll see objects relating to different categories:
core object provides your rate limit status for all non-search-related resources in the REST API.search object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"Search.\"code_search object provides your rate limit status for the REST API for searching code. For more information, see \"Search code.\"graphql object provides your rate limit status for the GraphQL API. For more information, see \"Resource limitations.\"integration_manifest object provides your rate limit status for the POST /app-manifests/{code}/conversions operation. For more information, see \"Creating a GitHub App from a manifest.\"dependency_snapshots object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"Dependency graph.\"dependency_sbom object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"Dependency graph.\"code_scanning_upload object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"Uploading a SARIF file to GitHub.\"actions_runner_registration object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"Self-hosted runners.\"source_import object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"API Versions.\"Note
\n\nThe rate object is closing down. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.
List the reactions to a team discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "List the reactions to a team discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Create a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Create a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
List the reactions to a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
List the reactions to a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Create a reaction to a team discussion.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Create a reaction to a team discussion.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -423022,7 +423022,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -424111,13 +424111,13 @@ } ], "previews": [], + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -425199,7 +425199,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -426270,7 +426270,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", "statusCodes": [ { "httpStatusCode": "204", @@ -426628,7 +426628,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Gets a public release with the specified release ID.
\nNote
\n\nThis returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"Getting started with the REST API.\"
Gets a public release with the specified release ID.
\nNote
\n\nThis returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"Getting started with the REST API.\"
Lists repositories for the specified organization.
\nNote
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
Lists repositories for the specified organization.
\nNote
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.
Note
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.
Note
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
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.
\nFor more information about viewing repository activity,\nsee \"Viewing activity and data for your repository.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -450062,8 +450063,7 @@ "httpStatusCode": "422", "description": "Validation failed, or the endpoint has been spammed.
" } - ], - "descriptionHTML": "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.
\nFor more information about viewing repository activity,\nsee \"Viewing activity and data for your repository.\"
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -469059,7 +469059,7 @@ } ], "previews": [], - "descriptionHTML": "Creates a new file or replaces an existing file in a repository.
\nNote
\n\nIf you use this endpoint and the \"Delete a file\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. The workflow scope is also required in order to modify files in the .github/workflows directory.
Creates a new file or replaces an existing file in a repository.
\nNote
\n\nIf you use this endpoint and the \"Delete a file\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. The workflow scope is also required in order to modify files in the .github/workflows directory.
Deletes a file in a repository.
\nYou can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.
The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.
You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.
Note
\n\nIf you use this endpoint and the \"Create or update file contents\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
\nDeletes a file in a repository.
\nYou can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.
The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.
You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.
Note
\n\nIf you use this endpoint and the \"Create or update file contents\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
\nGets a redirect URL to download a tar archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes.
\nGets a redirect URL to download a tar archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes.
\nGets a redirect URL to download a zip archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.
\nGets a redirect URL to download a zip archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.
\nCreate a fork for the authenticated user.
\nNote
\n\nForking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub Enterprise Server Support.
\nNote
\n\nAlthough this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.
\nCreate a fork for the authenticated user.
\nNote
\n\nForking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub Enterprise Server Support.
\nNote
\n\nAlthough this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.
\nWarning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis returns the tag protection states of a repository.
\nThis information is only available to repository administrators.
", + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis returns the tag protection states of a repository.
\nThis information is only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "200", @@ -483859,7 +483859,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "201", @@ -483941,7 +483941,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "204", @@ -486369,7 +486369,7 @@ } ], "previews": [], - "descriptionHTML": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook is not subscribed to push events, the server will respond with 204 but no test POST will be generated.
Note
\n\nPreviously /repos/:owner/:repo/hooks/:hook_id/test
This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook is not subscribed to push events, the server will respond with 204 but no test POST will be generated.
Note
\n\nPreviously /repos/:owner/:repo/hooks/:hook_id/test
Find issues by state and keyword. This method returns up to 100 results per page.
\nWhen searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.
For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.
\nq=windows+label:bug+language:python+state:open&sort=created&order=asc
This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.
Note
\n\nFor requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"
Find issues by state and keyword. This method returns up to 100 results per page.
\nWhen searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.
For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.
\nq=windows+label:bug+language:python+state:open&sort=created&order=asc
This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.
Note
\n\nFor requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"
Gets a team using the team's slug. To create the slug, GitHub Enterprise Server replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a - separator. For example, \"My TEam Näme\" would become my-team-name.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
Gets a team using the team's slug. To create the slug, GitHub Enterprise Server replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a - separator. For example, \"My TEam Näme\" would become my-team-name.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
To edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}.
To edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}.
To delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}.
To delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}.
Lists the organization projects for a team.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects.
Lists the organization projects for a team.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects.
Checks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects/{project_id}.
Checks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects/{project_id}.
Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.
Note
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}.
Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.
Note
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}.
Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have read access to both the team and project, or admin access to the team or project. This endpoint removes the project from the team, but does not delete the project.
Note
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}.
Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have read access to both the team and project, or admin access to the team or project. This endpoint removes the project from the team, but does not delete the project.
Note
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}.
Lists a team's repositories visible to the authenticated user.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos.
Lists a team's repositories visible to the authenticated user.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos.
Checks whether a team has admin, push, maintain, triage, or pull permission for a repository. Repositories inherited through a parent team will also be checked.
You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the application/vnd.github.v3.repository+json accept header.
If a team doesn't have permission for the repository, you will receive a 404 Not Found response status.
If the repository is private, you must have at least read permission for that repository, and your token must have the repo or admin:org scope. Otherwise, you will receive a 404 Not Found response status.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
Checks whether a team has admin, push, maintain, triage, or pull permission for a repository. Repositories inherited through a parent team will also be checked.
You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the application/vnd.github.v3.repository+json accept header.
If a team doesn't have permission for the repository, you will receive a 404 Not Found response status.
If the repository is private, you must have at least read permission for that repository, and your token must have the repo or admin:org scope. Otherwise, you will receive a 404 Not Found response status.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Note
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
For more information about the permission levels, see \"Repository permission levels for an organization\".
", + "descriptionHTML": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Note
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
For more information about the permission levels, see \"Repository permission levels for an organization\".
", "statusCodes": [ { "httpStatusCode": "204", @@ -507431,7 +507431,7 @@ } ], "previews": [], - "descriptionHTML": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
Lists the child teams of the team specified by {team_slug}.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.
Lists the child teams of the team specified by {team_slug}.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the Get a team by name endpoint.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the Get a team by name endpoint.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a team endpoint.
\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote
\n\nWith nested teams, the privacy for parent teams cannot be secret.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a team endpoint.
\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote
\n\nWith nested teams, the privacy for parent teams cannot be secret.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a team endpoint.
\nTo delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
", + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a team endpoint.
\nTo delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
", "statusCodes": [ { "httpStatusCode": "204", @@ -510438,7 +510438,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team projects endpoint.
Lists the organization projects for a team.
", + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team projects endpoint.
Lists the organization projects for a team.
", "statusCodes": [ { "httpStatusCode": "200", @@ -510795,7 +510795,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a project endpoint.
\nChecks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a project endpoint.
\nChecks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team project permissions endpoint.
\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team project permissions endpoint.
\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a project from a team endpoint.
\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have read access to both the team and project, or admin access to the team or project. Note: This endpoint removes the project from the team, but does not delete it.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a project from a team endpoint.
\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have read access to both the team and project, or admin access to the team or project. Note: This endpoint removes the project from the team, but does not delete it.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team repositories endpoint.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team repositories endpoint.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a repository endpoint.
\nNote
\n\nRepositories inherited through a parent team will also be checked.
\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a repository endpoint.
\nNote
\n\nRepositories inherited through a parent team will also be checked.
\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Add or update team repository permissions\" endpoint.
\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization.
Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Add or update team repository permissions\" endpoint.
\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization.
Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a repository from a team endpoint.
\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.
", + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a repository from a team endpoint.
\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.
", "statusCodes": [ { "httpStatusCode": "204", @@ -513492,7 +513492,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List child teams endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List child teams endpoint.
List all comments on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
List all comments on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Creates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Creates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Get a specific comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Get a specific comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Edits the body text of a discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Edits the body text of a discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Deletes a comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Deletes a comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion comments endpoint.
\nList all comments on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion comments endpoint.
\nList all comments on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.
\nCreates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.
\nCreates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion comment endpoint.
\nGet a specific comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion comment endpoint.
\nGet a specific comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.
\nEdits the body text of a discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.
\nEdits the body text of a discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion comment endpoint.
\nDeletes a comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion comment endpoint.
\nDeletes a comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
List all discussions on a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
List all discussions on a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Get a specific discussion on a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Get a specific discussion on a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Edits the title and body text of a discussion post. Only the parameters you provide are updated.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Edits the title and body text of a discussion post. Only the parameters you provide are updated.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Delete a discussion from a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Delete a discussion from a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.
List all discussions on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.
List all discussions on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.
Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.
Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion endpoint.
\nGet a specific discussion on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion endpoint.
\nGet a specific discussion on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion endpoint.
\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion endpoint.
\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion endpoint.
Delete a discussion from a team's page.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion endpoint.
Delete a discussion from a team's page.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note
\n\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note
\n\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}.
Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}.
To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}.
To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members endpoint.
Team members will include the members of child teams.
", + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members endpoint.
Team members will include the members of child teams.
", "statusCodes": [ { "httpStatusCode": "200", @@ -523796,7 +523796,7 @@ } ], "previews": [], - "descriptionHTML": "The \"Add team member\" endpoint (described below) is closing down.
\nWe recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
The \"Add team member\" endpoint (described below) is closing down.
\nWe recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
The \"Remove team member\" endpoint (described below) is closing down.
\nWe recommend using the Remove team membership for a user endpoint instead. It allows you to remove both active and pending memberships.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nThe \"Remove team member\" endpoint (described below) is closing down.
\nWe recommend using the Remove team membership for a user endpoint instead. It allows you to remove both active and pending memberships.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership for a user endpoint.
\nTeam members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership for a user endpoint.
\nTeam members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
", + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
", "statusCodes": [ { "httpStatusCode": "200", @@ -524154,7 +524154,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nSpecifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"Using environments for deployment.\"
\nNote
\n\nGitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"Using environments for deployment.\"
\nNote
\n\nGitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Note
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nIf you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. Optional: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nIf you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. Optional: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nThis is the user's organization dashboard. You must be authenticated as the user to view this.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nThis is the user's organization dashboard. You must be authenticated as the user to view this.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nThese are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nThese are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nLists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.
\nuri_template. For more information, see \"Hypermedia.\"By default, timeline resources are returned in JSON. You can specify the application/atom+xml type in the Accept header to return timeline resources in Atom format. For more information, see \"Media types.\"
Note
\n\nPrivate feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
\nLists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.
\nuri_template. For more information, see \"Hypermedia.\"By default, timeline resources are returned in JSON. You can specify the application/atom+xml type in the Accept header to return timeline resources in Atom format. For more information, see \"Media types.\"
Note
\n\nPrivate feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
\nNote
\n\nThe :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).
Note
\n\nThe :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).
Renames a branch in a repository.
\nNote
\n\nAlthough the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".
\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.
\nIn order to rename the default branch, fine-grained access tokens also need the administration:write repository permission.
Renames a branch in a repository.
\nNote
\n\nAlthough the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".
\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.
\nIn order to rename the default branch, fine-grained access tokens also need the administration:write repository permission.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nProtecting a branch requires admin or owner permissions to the repository.
\nNote
\n\nPassing new arrays of users and teams replaces their previous values.
Note
\n\nThe list of users, apps, and teams in total is limited to 100 items.
\nProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nProtecting a branch requires admin or owner permissions to the repository.
\nNote
\n\nPassing new arrays of users and teams replaces their previous values.
Note
\n\nThe list of users, apps, and teams in total is limited to 100 items.
\nProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
\nNote
\n\nPassing new arrays of users and teams replaces their previous values.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
\nNote
\n\nPassing new arrays of users and teams replaces their previous values.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.
Note
\n\nYou must enable branch protection to require signed commits.
\nProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.
Note
\n\nYou must enable branch protection to require signed commits.
\nProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists who has access to this protected branch.
\nNote
\n\nUsers, apps, and teams restrictions are only available for organization-owned repositories.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists who has access to this protected branch.
\nNote
\n\nUsers, apps, and teams restrictions are only available for organization-owned repositories.
Creates a new check run for a specific commit in a repository.
\nTo create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.
\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
\nNote
\n\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Creates a new check run for a specific commit in a repository.
\nTo create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.
\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
\nNote
\n\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Gets a single check run using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Gets a single check run using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Updates a check run for a specific commit in a repository.
\nNote
\n\nThe 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.
OAuth apps and personal access tokens (classic) cannot use this endpoint.
", + "descriptionHTML": "Updates a check run for a specific commit in a repository.
\nNote
\n\nThe 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.
OAuth apps and personal access tokens (classic) cannot use this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -141474,7 +141474,7 @@ } ], "previews": [], - "descriptionHTML": "Lists check runs for a check suite using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check runs for a check suite using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name.
Note
\n\nThe 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 endpoint and provide the check_suite_id parameter to the List check runs in a check suite endpoint.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name.
Note
\n\nThe 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 endpoint and provide the check_suite_id parameter to the List check runs in a check suite endpoint.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Creates a check suite manually. By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"Update repository preferences for check suites\".
\nNote
\n\nThe 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.
OAuth apps and personal access tokens (classic) cannot use this endpoint.
", + "descriptionHTML": "Creates a check suite manually. By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"Update repository preferences for check suites\".
\nNote
\n\nThe 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.
OAuth apps and personal access tokens (classic) cannot use this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -149869,7 +149869,7 @@ } ], "previews": [], - "descriptionHTML": "Gets a single check suite using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Gets a single check suite using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.
The rules_count field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.
Warning
\n\nClosing down notice: The tool_name field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.
OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.
The rules_count field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.
Warning
\n\nClosing down notice: The tool_name field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.
OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Removes a collaborator from a repository.
\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.
\nThis endpoint also:
\nRemoving a user as a collaborator has the following effects on forks:
\nNote
\n\nA user can still have access to the repository through organization permissions like base repository permissions.
\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.
\nFor more information on fork permissions, see \"About permissions and visibility of forks\".
", + "descriptionHTML": "Removes a collaborator from a repository.
\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.
\nThis endpoint also:
\nRemoving a user as a collaborator has the following effects on forks:
\nNote
\n\nA user can still have access to the repository through organization permissions like base repository permissions.
\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.
\nFor more information on fork permissions, see \"About permissions and visibility of forks\".
", "statusCodes": [ { "httpStatusCode": "204", @@ -171588,7 +171588,7 @@ } ], "previews": [], - "descriptionHTML": "Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.
Note
\n\nIf there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\" Pagination query parameters are not supported for these media types.
\napplication/vnd.github.diff: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property. Larger diffs may time out and return a 5xx status code.application/vnd.github.sha: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
verified_at | string | The date the signature was verified by GitHub. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on their account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.
Note
\n\nIf there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\" Pagination query parameters are not supported for these media types.
\napplication/vnd.github.diff: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property. Larger diffs may time out and return a 5xx status code.application/vnd.github.sha: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
verified_at | string | The date the signature was verified by GitHub. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on their account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Note
\n\nTo get information about name patterns that branches must match in order to deploy to this environment, see \"Get a deployment branch policy.\"
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Note
\n\nTo get information about name patterns that branches must match in order to deploy to this environment, see \"Get a deployment branch policy.\"
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"Environments.\"
\nNote
\n\nTo create or update name patterns that branches must match in order to deploy to this environment, see \"Deployment branch policies.\"
\nNote
\n\nTo create or update secrets for an environment, see \"GitHub Actions secrets.\"
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"Environments.\"
\nNote
\n\nTo create or update name patterns that branches must match in order to deploy to this environment, see \"Deployment branch policies.\"
\nNote
\n\nTo create or update secrets for an environment, see \"GitHub Actions secrets.\"
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment.
\nNote
\n\nIt's recommended to use the log_url parameter, which replaces target_url.
The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment.
\nNote
\n\nIt's recommended to use the log_url parameter, which replaces target_url.
When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.
\nImportant
\n\nTo start the configuration process and apply the license, you need to POST to /manage/v1/config/apply
The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.
\nNote
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.
\nImportant
\n\nTo start the configuration process and apply the license, you need to POST to /manage/v1/config/apply
The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.
\nNote
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
Uploads a new enterprise license. In order to apply it right away, use the apply query parameter.
Note
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
Uploads a new enterprise license. In order to apply it right away, use the apply query parameter.
Note
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
Note
\n\nThe request body for this operation must be submitted as application/x-www-form-urlencoded data. You can submit a parameter value as a string, or you can use a tool such as curl to submit a parameter value as the contents of a text file. For more information, see the curl documentation.
Note
\n\nThe request body for this operation must be submitted as application/x-www-form-urlencoded data. You can submit a parameter value as a string, or you can use a tool such as curl to submit a parameter value as the contents of a text file. For more information, see the curl documentation.
Gets the settings for your instance. To change settings, see the Set settings endpoint.
\nNote
\n\nYou cannot retrieve the management console password with the Enterprise administration API.
\nGets the settings for your instance. To change settings, see the Set settings endpoint.
\nNote
\n\nYou cannot retrieve the management console password with the Enterprise administration API.
\nWhen you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.
\nNote that you need to POST to /setup/api/configure to start the actual configuration process.
When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:
\nNote
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.
\nNote that you need to POST to /setup/api/configure to start the actual configuration process.
When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:
\nNote
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
This API upgrades your license and also triggers the configuration process.
\nNote
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
This API upgrades your license and also triggers the configuration process.
\nNote
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nLists provisioned SCIM groups in an enterprise.
\nYou can improve query search time by using the excludedAttributes query parameter with a value of members to exclude members from the response.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nLists provisioned SCIM groups in an enterprise.
\nYou can improve query search time by using the excludedAttributes query parameter with a value of members to exclude members from the response.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nCreates a SCIM group for an enterprise.
\nIf members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the externalId and id of each user.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nCreates a SCIM group for an enterprise.
\nIf members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the externalId and id of each user.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nGets information about a SCIM group.
", + "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nGets information about a SCIM group.
", "statusCodes": [ { "httpStatusCode": "200", @@ -212298,7 +212298,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nReplaces an existing provisioned group’s information.
\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the Update an attribute for a SCIM enterprise group endpoint instead.
", + "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nReplaces an existing provisioned group’s information.
\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the Update an attribute for a SCIM enterprise group endpoint instead.
", "statusCodes": [ { "httpStatusCode": "200", @@ -212845,7 +212845,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nUpdate a provisioned group’s individual attributes.
\nTo change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification. Update can also be used to add group memberships.
\nGroup memberships can be sent one at a time or in batches for faster performance. Note: The memberships are referenced through a local user id, and the user will need to be created before they are referenced here.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nUpdate a provisioned group’s individual attributes.
\nTo change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification. Update can also be used to add group memberships.
\nGroup memberships can be sent one at a time or in batches for faster performance. Note: The memberships are referenced through a local user id, and the user will need to be created before they are referenced here.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nDeletes a SCIM group from an enterprise.
", + "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nDeletes a SCIM group from an enterprise.
", "statusCodes": [ { "httpStatusCode": "204", @@ -213400,7 +213400,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nLists provisioned SCIM enterprise members.
\nWhen a user with a SCIM-provisioned external identity is removed from an enterprise through a patch with active flag set to false, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the delete request. Users that were not permanently deleted will be visible in the returned results.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nLists provisioned SCIM enterprise members.
\nWhen a user with a SCIM-provisioned external identity is removed from an enterprise through a patch with active flag set to false, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the delete request. Users that were not permanently deleted will be visible in the returned results.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nCreates an external identity for a new SCIM enterprise user.
\nSCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response NameID to SCIM userName.
When converting existing enterprise to use SCIM, the user handle (userName) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nCreates an external identity for a new SCIM enterprise user.
\nSCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response NameID to SCIM userName.
When converting existing enterprise to use SCIM, the user handle (userName) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nGets information about a SCIM user.
", + "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nGets information about a SCIM user.
", "statusCodes": [ { "httpStatusCode": "200", @@ -215135,7 +215135,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nReplaces an existing provisioned user's information.
\nYou must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the Update an attribute for a SCIM user endpoint instead.
\nWarning
\n\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nReplaces an existing provisioned user's information.
\nYou must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the Update an attribute for a SCIM user endpoint instead.
\nWarning
\n\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nUpdate a provisioned user's individual attributes.
\nTo change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.
Note
\n\nComplicated SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will not work.
Warning
\n\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.
{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\nNote
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nUpdate a provisioned user's individual attributes.
\nTo change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.
Note
\n\nComplicated SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will not work.
Warning
\n\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.
{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\nNote
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nPermanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action.
", + "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nPermanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action.
", "statusCodes": [ { "httpStatusCode": "204", @@ -222162,7 +222162,7 @@ } ], "previews": [], - "descriptionHTML": "Allows you to add a new gist with one or more files.
\nNote
\n\nDon't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.
\nAllows you to add a new gist with one or more files.
\nNote
\n\nDon't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.
\nReturns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.
When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.
Note
\n\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nIf you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.
Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.
When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.
Note
\n\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nIf you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.
Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.
Note
\n\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nReturns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.
Note
\n\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nReturns a single tree using the SHA1 value or ref name for that tree.
\nIf truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.
Note
\n\nThe limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
Returns a single tree using the SHA1 value or ref name for that tree.
\nIf truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.
Note
\n\nThe limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.
Note
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.
Note
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues in an organization assigned to the authenticated user.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues in an organization assigned to the authenticated user.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues in a repository. Only open issues will be listed.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues in a repository. Only open issues will be listed.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.
Note
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.
Note
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues across owned and member repositories assigned to the authenticated user.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues across owned and member repositories assigned to the authenticated user.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return [\"repo\", \"user\"].
Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return [\"repo\", \"user\"].
Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on the application authorizations settings screen within GitHub.
", + "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on the application authorizations settings screen within GitHub.
", "statusCodes": [ { "httpStatusCode": "204", @@ -325977,7 +325977,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nCreates OAuth tokens using Basic Authentication. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use fingerprint to differentiate between them.
You can also create tokens on GitHub Enterprise Server from the personal access tokens settings page. Read more about these tokens in the GitHub Help documentation.
\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see \"About identity and access management with SAML single sign-on\" in the GitHub Enterprise Cloud documentation.
", + "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nCreates OAuth tokens using Basic Authentication. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use fingerprint to differentiate between them.
You can also create tokens on GitHub Enterprise Server from the personal access tokens settings page. Read more about these tokens in the GitHub Help documentation.
\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see \"About identity and access management with SAML single sign-on\" in the GitHub Enterprise Cloud documentation.
", "statusCodes": [ { "httpStatusCode": "201", @@ -328070,7 +328070,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nCreates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
", + "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nCreates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -329011,7 +329011,7 @@ }, { "httpStatusCode": "201", - "description": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nThis method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. fingerprint is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
", + "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nThis method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. fingerprint is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -331992,7 +331992,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nYou can only send one of these scope keys at a time.
", + "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nYou can only send one of these scope keys at a time.
", "statusCodes": [ { "httpStatusCode": "200", @@ -333084,7 +333084,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nLists all organizations, in the order that they were created.
\nNote
\n\nPagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
Lists all organizations, in the order that they were created.
\nNote
\n\nPagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
Warning
\n\nClosing down notice: GitHub Enterprise Server will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.
Warning
\n\nClosing down notice: Code security product enablement for new repositories through the organization API is closing down and will be replaced with code security configurations in a future GitHub Enterprise Server version.
\nUpdates the organization's profile and member privileges.
\nThe authenticated user must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Warning
\n\nClosing down notice: GitHub Enterprise Server will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.
Warning
\n\nClosing down notice: Code security product enablement for new repositories through the organization API is closing down and will be replaced with code security configurations in a future GitHub Enterprise Server version.
\nUpdates the organization's profile and member privileges.
\nThe authenticated user must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Warning
\n\nClosing down notice: The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use code security configurations instead. For more information, see the changelog.
\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"Managing security managers in your organization.\"
\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org, write:org, or repo scopes to use this endpoint.
Warning
\n\nClosing down notice: The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use code security configurations instead. For more information, see the changelog.
\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"Managing security managers in your organization.\"
\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org, write:org, or repo scopes to use this endpoint.
List organizations for the authenticated user.
\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a 403 Forbidden response.
Note
\n\nRequests using a fine-grained access token will receive a 200 Success response with an empty list.
List organizations for the authenticated user.
\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a 403 Forbidden response.
Note
\n\nRequests using a fine-grained access token will receive a 200 Success response with an empty list.
Warning
\n\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.
\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Warning
\n\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.
\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Lists the files in a specified pull request.
\nNote
\n\nResponses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Lists the files in a specified pull request.
\nNote
\n\nResponses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Creates a review on a specified pull request.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note
\n\nTo comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the application/vnd.github.v3.diff media type to the Accept header of a call to the Get a pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Creates a review on a specified pull request.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note
\n\nTo comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the application/vnd.github.v3.diff media type to the Accept header of a call to the Get a pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Dismisses a specified review on a pull request.
\nNote
\n\nTo dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Dismisses a specified review on a pull request.
\nNote
\n\nTo dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Note
\n\nAccessing this endpoint does not count against your REST API rate limit.
\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under resources, you'll see objects relating to different categories:
core object provides your rate limit status for all non-search-related resources in the REST API.search object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"Search.\"code_search object provides your rate limit status for the REST API for searching code. For more information, see \"Search code.\"graphql object provides your rate limit status for the GraphQL API. For more information, see \"Resource limitations.\"integration_manifest object provides your rate limit status for the POST /app-manifests/{code}/conversions operation. For more information, see \"Creating a GitHub App from a manifest.\"dependency_snapshots object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"Dependency graph.\"dependency_sbom object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"Dependency graph.\"code_scanning_upload object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"Uploading a SARIF file to GitHub.\"actions_runner_registration object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"Self-hosted runners.\"source_import object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"API Versions.\"Note
\n\nThe rate object is closing down. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.
Note
\n\nAccessing this endpoint does not count against your REST API rate limit.
\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under resources, you'll see objects relating to different categories:
core object provides your rate limit status for all non-search-related resources in the REST API.search object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"Search.\"code_search object provides your rate limit status for the REST API for searching code. For more information, see \"Search code.\"graphql object provides your rate limit status for the GraphQL API. For more information, see \"Resource limitations.\"integration_manifest object provides your rate limit status for the POST /app-manifests/{code}/conversions operation. For more information, see \"Creating a GitHub App from a manifest.\"dependency_snapshots object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"Dependency graph.\"dependency_sbom object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"Dependency graph.\"code_scanning_upload object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"Uploading a SARIF file to GitHub.\"actions_runner_registration object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"Self-hosted runners.\"source_import object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"API Versions.\"Note
\n\nThe rate object is closing down. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.
List the reactions to a team discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
List the reactions to a team discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Create a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Create a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
List the reactions to a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
List the reactions to a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Create a reaction to a team discussion.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Create a reaction to a team discussion.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -426271,7 +426271,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -427360,7 +427360,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", "statusCodes": [ { "httpStatusCode": "204", @@ -428448,7 +428448,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -429519,7 +429519,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", "statusCodes": [ { "httpStatusCode": "204", @@ -429877,7 +429877,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Gets a public release with the specified release ID.
\nNote
\n\nThis returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"Getting started with the REST API.\"
Gets a public release with the specified release ID.
\nNote
\n\nThis returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"Getting started with the REST API.\"
Lists repositories for the specified organization.
\nNote
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
Lists repositories for the specified organization.
\nNote
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.
Note
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.
Note
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
Creates a new file or replaces an existing file in a repository.
\nNote
\n\nIf you use this endpoint and the \"Delete a file\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. The workflow scope is also required in order to modify files in the .github/workflows directory.
Creates a new file or replaces an existing file in a repository.
\nNote
\n\nIf you use this endpoint and the \"Delete a file\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. The workflow scope is also required in order to modify files in the .github/workflows directory.
Deletes a file in a repository.
\nYou can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.
The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.
You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.
Note
\n\nIf you use this endpoint and the \"Create or update file contents\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
\nDeletes a file in a repository.
\nYou can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.
The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.
You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.
Note
\n\nIf you use this endpoint and the \"Create or update file contents\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
\nGets a redirect URL to download a tar archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes.
\nGets a redirect URL to download a tar archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes.
\nGets a redirect URL to download a zip archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.
\nGets a redirect URL to download a zip archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.
\nCreate a fork for the authenticated user.
\nNote
\n\nForking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub Enterprise Server Support.
\nNote
\n\nAlthough this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.
\nCreate a fork for the authenticated user.
\nNote
\n\nForking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub Enterprise Server Support.
\nNote
\n\nAlthough this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.
\nWarning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis returns the tag protection states of a repository.
\nThis information is only available to repository administrators.
", + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis returns the tag protection states of a repository.
\nThis information is only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "200", @@ -487595,7 +487595,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "201", @@ -487677,7 +487677,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "204", @@ -490105,7 +490105,7 @@ } ], "previews": [], - "descriptionHTML": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook is not subscribed to push events, the server will respond with 204 but no test POST will be generated.
Note
\n\nPreviously /repos/:owner/:repo/hooks/:hook_id/test
This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook is not subscribed to push events, the server will respond with 204 but no test POST will be generated.
Note
\n\nPreviously /repos/:owner/:repo/hooks/:hook_id/test
Find issues by state and keyword. This method returns up to 100 results per page.
\nWhen searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.
For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.
\nq=windows+label:bug+language:python+state:open&sort=created&order=asc
This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.
Note
\n\nFor requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"
Find issues by state and keyword. This method returns up to 100 results per page.
\nWhen searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.
For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.
\nq=windows+label:bug+language:python+state:open&sort=created&order=asc
This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.
Note
\n\nFor requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"
Gets a team using the team's slug. To create the slug, GitHub Enterprise Server replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a - separator. For example, \"My TEam Näme\" would become my-team-name.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
Gets a team using the team's slug. To create the slug, GitHub Enterprise Server replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a - separator. For example, \"My TEam Näme\" would become my-team-name.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
To edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}.
To edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}.
To delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}.
To delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}.
Lists the organization projects for a team.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects.
Lists the organization projects for a team.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects.
Checks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects/{project_id}.
Checks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects/{project_id}.
Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.
Note
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}.
Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.
Note
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}.
Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have read access to both the team and project, or admin access to the team or project. This endpoint removes the project from the team, but does not delete the project.
Note
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}.
Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have read access to both the team and project, or admin access to the team or project. This endpoint removes the project from the team, but does not delete the project.
Note
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}.
Lists a team's repositories visible to the authenticated user.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos.
Lists a team's repositories visible to the authenticated user.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos.
Checks whether a team has admin, push, maintain, triage, or pull permission for a repository. Repositories inherited through a parent team will also be checked.
You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the application/vnd.github.v3.repository+json accept header.
If a team doesn't have permission for the repository, you will receive a 404 Not Found response status.
If the repository is private, you must have at least read permission for that repository, and your token must have the repo or admin:org scope. Otherwise, you will receive a 404 Not Found response status.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
Checks whether a team has admin, push, maintain, triage, or pull permission for a repository. Repositories inherited through a parent team will also be checked.
You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the application/vnd.github.v3.repository+json accept header.
If a team doesn't have permission for the repository, you will receive a 404 Not Found response status.
If the repository is private, you must have at least read permission for that repository, and your token must have the repo or admin:org scope. Otherwise, you will receive a 404 Not Found response status.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Note
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
For more information about the permission levels, see \"Repository permission levels for an organization\".
", + "descriptionHTML": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Note
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
For more information about the permission levels, see \"Repository permission levels for an organization\".
", "statusCodes": [ { "httpStatusCode": "204", @@ -511232,7 +511232,7 @@ } ], "previews": [], - "descriptionHTML": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
Lists the child teams of the team specified by {team_slug}.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.
Lists the child teams of the team specified by {team_slug}.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the Get a team by name endpoint.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the Get a team by name endpoint.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a team endpoint.
\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote
\n\nWith nested teams, the privacy for parent teams cannot be secret.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a team endpoint.
\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote
\n\nWith nested teams, the privacy for parent teams cannot be secret.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a team endpoint.
\nTo delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
", + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a team endpoint.
\nTo delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
", "statusCodes": [ { "httpStatusCode": "204", @@ -514239,7 +514239,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team projects endpoint.
Lists the organization projects for a team.
", + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team projects endpoint.
Lists the organization projects for a team.
", "statusCodes": [ { "httpStatusCode": "200", @@ -514596,7 +514596,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a project endpoint.
\nChecks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a project endpoint.
\nChecks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team project permissions endpoint.
\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team project permissions endpoint.
\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a project from a team endpoint.
\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have read access to both the team and project, or admin access to the team or project. Note: This endpoint removes the project from the team, but does not delete it.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a project from a team endpoint.
\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have read access to both the team and project, or admin access to the team or project. Note: This endpoint removes the project from the team, but does not delete it.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team repositories endpoint.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team repositories endpoint.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a repository endpoint.
\nNote
\n\nRepositories inherited through a parent team will also be checked.
\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a repository endpoint.
\nNote
\n\nRepositories inherited through a parent team will also be checked.
\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Add or update team repository permissions\" endpoint.
\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization.
Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Add or update team repository permissions\" endpoint.
\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization.
Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a repository from a team endpoint.
\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.
", + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a repository from a team endpoint.
\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.
", "statusCodes": [ { "httpStatusCode": "204", @@ -517293,7 +517293,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List child teams endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List child teams endpoint.
List all comments on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
List all comments on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Creates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Creates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Get a specific comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Get a specific comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Edits the body text of a discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Edits the body text of a discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Deletes a comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Deletes a comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion comments endpoint.
\nList all comments on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion comments endpoint.
\nList all comments on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.
\nCreates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.
\nCreates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion comment endpoint.
\nGet a specific comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion comment endpoint.
\nGet a specific comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.
\nEdits the body text of a discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.
\nEdits the body text of a discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion comment endpoint.
\nDeletes a comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion comment endpoint.
\nDeletes a comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
List all discussions on a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
List all discussions on a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Get a specific discussion on a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Get a specific discussion on a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Edits the title and body text of a discussion post. Only the parameters you provide are updated.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Edits the title and body text of a discussion post. Only the parameters you provide are updated.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Delete a discussion from a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Delete a discussion from a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.
List all discussions on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.
List all discussions on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.
Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.
Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion endpoint.
\nGet a specific discussion on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion endpoint.
\nGet a specific discussion on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion endpoint.
\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion endpoint.
\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion endpoint.
Delete a discussion from a team's page.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion endpoint.
Delete a discussion from a team's page.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note
\n\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note
\n\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}.
Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}.
To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}.
To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members endpoint.
Team members will include the members of child teams.
", + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members endpoint.
Team members will include the members of child teams.
", "statusCodes": [ { "httpStatusCode": "200", @@ -527597,7 +527597,7 @@ } ], "previews": [], - "descriptionHTML": "The \"Add team member\" endpoint (described below) is closing down.
\nWe recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
The \"Add team member\" endpoint (described below) is closing down.
\nWe recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
The \"Remove team member\" endpoint (described below) is closing down.
\nWe recommend using the Remove team membership for a user endpoint instead. It allows you to remove both active and pending memberships.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nThe \"Remove team member\" endpoint (described below) is closing down.
\nWe recommend using the Remove team membership for a user endpoint instead. It allows you to remove both active and pending memberships.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership for a user endpoint.
\nTeam members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership for a user endpoint.
\nTeam members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
", + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
", "statusCodes": [ { "httpStatusCode": "200", @@ -527955,7 +527955,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nGets the total GitHub Actions cache usage for an enterprise.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
\nOAuth tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets the total GitHub Actions cache usage for an enterprise.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
\nOAuth tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
\nOAuth tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
\nOAuth tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
Gets GitHub Actions cache usage for a repository.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
\nAnyone with read access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets GitHub Actions cache usage for a repository.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
\nAnyone with read access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an enterprise,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Enforcing a policy for workflow permissions in your enterprise.\"
OAuth tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Success response
" } - ], - "descriptionHTML": "Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an enterprise,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Enforcing a policy for workflow permissions in your enterprise.\"
OAuth tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"Setting the permissions of the GITHUB_TOKEN for your repository.\"
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Conflict response when changing a setting is prevented by the owning organization or enterprise
" } - ], - "descriptionHTML": "Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"Setting the permissions of the GITHUB_TOKEN for your repository.\"
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Gets a single organization secret without revealing its encrypted value.
\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets
\nOAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets a single organization secret without revealing its encrypted value.
\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets
\nOAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Lists all secrets available in an environment without revealing their\nencrypted values.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists all secrets available in an environment without revealing their\nencrypted values.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Gets a single environment secret without revealing its encrypted value.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets a single environment secret without revealing its encrypted value.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists binaries for the runner application that you can download and run.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Creates an organization variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Response when creating a variable
" } - ], - "descriptionHTML": "Creates an organization variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Deletes an environment variable using the variable name.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Deletes an environment variable using the variable name.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Deletes a specific workflow run.
\nAnyone with write access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Deletes a specific workflow run.
\nAnyone with write access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"Using environments for deployment.\"
\nNote
\n\nGitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"Using environments for deployment.\"
\nNote
\n\nGitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Note
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nOK
" } - ], - "descriptionHTML": "Note
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nIf you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. Optional: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nIf you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. Optional: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nThis is the user's organization dashboard. You must be authenticated as the user to view this.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nThis is the user's organization dashboard. You must be authenticated as the user to view this.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nThese are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nThese are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nLists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.
\nuri_template. For more information, see \"Hypermedia.\"By default, timeline resources are returned in JSON. You can specify the application/atom+xml type in the Accept header to return timeline resources in Atom format. For more information, see \"Media types.\"
Note
\n\nPrivate feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
\nLists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.
\nuri_template. For more information, see \"Hypermedia.\"By default, timeline resources are returned in JSON. You can specify the application/atom+xml type in the Accept header to return timeline resources in Atom format. For more information, see \"Media types.\"
Note
\n\nPrivate feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
\nNote
\n\nThe :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).
Note
\n\nThe :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).
Revokes the installation token you're using to authenticate as an installation and access this endpoint.
\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"Create an installation access token for an app\" endpoint.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.
\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"Create an installation access token for an app\" endpoint.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -117847,7 +117847,7 @@ } ], "previews": [], - "descriptionHTML": "Renames a branch in a repository.
\nNote
\n\nAlthough the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".
\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.
\nIn order to rename the default branch, fine-grained access tokens also need the administration:write repository permission.
Renames a branch in a repository.
\nNote
\n\nAlthough the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".
\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.
\nIn order to rename the default branch, fine-grained access tokens also need the administration:write repository permission.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nProtecting a branch requires admin or owner permissions to the repository.
\nNote
\n\nPassing new arrays of users and teams replaces their previous values.
Note
\n\nThe list of users, apps, and teams in total is limited to 100 items.
\nProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nProtecting a branch requires admin or owner permissions to the repository.
\nNote
\n\nPassing new arrays of users and teams replaces their previous values.
Note
\n\nThe list of users, apps, and teams in total is limited to 100 items.
\nProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
\nNote
\n\nPassing new arrays of users and teams replaces their previous values.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
\nNote
\n\nPassing new arrays of users and teams replaces their previous values.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.
Note
\n\nYou must enable branch protection to require signed commits.
\nProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.
Note
\n\nYou must enable branch protection to require signed commits.
\nProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists who has access to this protected branch.
\nNote
\n\nUsers, apps, and teams restrictions are only available for organization-owned repositories.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists who has access to this protected branch.
\nNote
\n\nUsers, apps, and teams restrictions are only available for organization-owned repositories.
Creates a new check run for a specific commit in a repository.
\nTo create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.
\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
\nNote
\n\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Creates a new check run for a specific commit in a repository.
\nTo create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.
\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
\nNote
\n\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Gets a single check run using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Gets a single check run using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Updates a check run for a specific commit in a repository.
\nNote
\n\nThe 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.
OAuth apps and personal access tokens (classic) cannot use this endpoint.
", + "descriptionHTML": "Updates a check run for a specific commit in a repository.
\nNote
\n\nThe 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.
OAuth apps and personal access tokens (classic) cannot use this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -142070,7 +142070,7 @@ } ], "previews": [], - "descriptionHTML": "Lists check runs for a check suite using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check runs for a check suite using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name.
Note
\n\nThe 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 endpoint and provide the check_suite_id parameter to the List check runs in a check suite endpoint.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name.
Note
\n\nThe 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 endpoint and provide the check_suite_id parameter to the List check runs in a check suite endpoint.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Creates a check suite manually. By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"Update repository preferences for check suites\".
\nNote
\n\nThe 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.
OAuth apps and personal access tokens (classic) cannot use this endpoint.
", + "descriptionHTML": "Creates a check suite manually. By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"Update repository preferences for check suites\".
\nNote
\n\nThe 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.
OAuth apps and personal access tokens (classic) cannot use this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -150543,7 +150543,7 @@ } ], "previews": [], - "descriptionHTML": "Gets a single check suite using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Gets a single check suite using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.
The rules_count field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.
Warning
\n\nClosing down notice: The tool_name field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.
OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.
The rules_count field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.
Warning
\n\nClosing down notice: The tool_name field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.
OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Lists all code security configurations available in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nThe enablement status will only be returned for installed security products.
\nLists all code security configurations available in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nThe enablement status will only be returned for installed security products.
\nCreates a code security configuration in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nOnly installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error.
\nCreates a code security configuration in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nOnly installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error.
\nLists the default code security configurations for an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nNote
\n\nThe enablement status will only be returned for installed security products.
\nLists the default code security configurations for an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nNote
\n\nThe enablement status will only be returned for installed security products.
\nGets a code security configuration available in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nThe enablement status will only be returned for installed security products.
\nGets a code security configuration available in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nThe enablement status will only be returned for installed security products.
\nUpdates a code security configuration in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nOnly installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error.
\nUpdates a code security configuration in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nOnly installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error.
\nAttach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.
\nIf insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Accepted
" } - ], - "descriptionHTML": "Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.
\nIf insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Sets a code security configuration as a default to be applied to new repositories in your organization.
\nThis configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nThe enablement status will only be returned for installed security products.
\nSets a code security configuration as a default to be applied to new repositories in your organization.
\nThis configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nThe enablement status will only be returned for installed security products.
\nRemoves a collaborator from a repository.
\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.
\nThis endpoint also:
\nRemoving a user as a collaborator has the following effects on forks:
\nNote
\n\nA user can still have access to the repository through organization permissions like base repository permissions.
\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.
\nFor more information on fork permissions, see \"About permissions and visibility of forks\".
", + "descriptionHTML": "Removes a collaborator from a repository.
\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.
\nThis endpoint also:
\nRemoving a user as a collaborator has the following effects on forks:
\nNote
\n\nA user can still have access to the repository through organization permissions like base repository permissions.
\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.
\nFor more information on fork permissions, see \"About permissions and visibility of forks\".
", "statusCodes": [ { "httpStatusCode": "204", @@ -165923,13 +165923,13 @@ } ], "previews": [], + "descriptionHTML": "When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -167375,13 +167375,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -175751,7 +175751,7 @@ } ], "previews": [], - "descriptionHTML": "Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.
Note
\n\nIf there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\" Pagination query parameters are not supported for these media types.
\napplication/vnd.github.diff: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property. Larger diffs may time out and return a 5xx status code.application/vnd.github.sha: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
verified_at | string | The date the signature was verified by GitHub. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on their account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.
Note
\n\nIf there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\" Pagination query parameters are not supported for these media types.
\napplication/vnd.github.diff: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property. Larger diffs may time out and return a 5xx status code.application/vnd.github.sha: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
verified_at | string | The date the signature was verified by GitHub. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on their account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Gets a single organization secret without revealing its encrypted value.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets a single organization secret without revealing its encrypted value.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Gets a single repository secret without revealing its encrypted value.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets a single repository secret without revealing its encrypted value.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Create a new snapshot of a repository's dependencies.
\nThe authenticated user must have access to the repository.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Created
" } - ], - "descriptionHTML": "Create a new snapshot of a repository's dependencies.
\nThe authenticated user must have access to the repository.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Resource not found
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -196589,13 +196589,13 @@ } ], "previews": [], + "descriptionHTML": "Gets a deployment branch or tag policy for an environment.
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
OK
" } - ], - "descriptionHTML": "Gets a deployment branch or tag policy for an environment.
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Note
\n\nTo get information about name patterns that branches must match in order to deploy to this environment, see \"Get a deployment branch policy.\"
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Note
\n\nTo get information about name patterns that branches must match in order to deploy to this environment, see \"Get a deployment branch policy.\"
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"Environments.\"
\nNote
\n\nTo create or update name patterns that branches must match in order to deploy to this environment, see \"Deployment branch policies.\"
\nNote
\n\nTo create or update secrets for an environment, see \"GitHub Actions secrets.\"
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"Environments.\"
\nNote
\n\nTo create or update name patterns that branches must match in order to deploy to this environment, see \"Deployment branch policies.\"
\nNote
\n\nTo create or update secrets for an environment, see \"GitHub Actions secrets.\"
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Enable a custom deployment protection rule for an environment.
\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.
\nFor more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint, as well as the guide to creating custom deployment protection rules.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
The enabled custom deployment protection rule
" } - ], - "descriptionHTML": "Enable a custom deployment protection rule for an environment.
\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.
\nFor more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint, as well as the guide to creating custom deployment protection rules.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment.
\nNote
\n\nIt's recommended to use the log_url parameter, which replaces target_url.
The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment.
\nNote
\n\nIt's recommended to use the log_url parameter, which replaces target_url.
When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.
\nImportant
\n\nTo start the configuration process and apply the license, you need to POST to /manage/v1/config/apply
The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.
\nNote
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.
\nImportant
\n\nTo start the configuration process and apply the license, you need to POST to /manage/v1/config/apply
The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.
\nNote
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
Uploads a new enterprise license. In order to apply it right away, use the apply query parameter.
Note
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
Uploads a new enterprise license. In order to apply it right away, use the apply query parameter.
Note
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -211351,13 +211351,13 @@ } ], "previews": [], + "descriptionHTML": "Removes any overrides for this hook at the org level for this org.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Removes any overrides for this hook at the org level for this org.
" + ] } ], "orgs": [ @@ -213492,13 +213492,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -213704,13 +213704,13 @@ } ], "previews": [], + "descriptionHTML": "Deletes any overridden enforcement on this repository for the specified hook.
\nResponds with effective values inherited from owner and/or global level.
", "statusCodes": [ { "httpStatusCode": "200", "description": "Responds with effective values inherited from owner and/or global level.
" } - ], - "descriptionHTML": "Deletes any overridden enforcement on this repository for the specified hook.
\nResponds with effective values inherited from owner and/or global level.
" + ] } ], "scim": [ @@ -214060,7 +214060,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nLists provisioned SCIM groups in an enterprise.
\nYou can improve query search time by using the excludedAttributes query parameter with a value of members to exclude members from the response.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nLists provisioned SCIM groups in an enterprise.
\nYou can improve query search time by using the excludedAttributes query parameter with a value of members to exclude members from the response.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nCreates a SCIM group for an enterprise.
\nIf members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the externalId and id of each user.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nCreates a SCIM group for an enterprise.
\nIf members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the externalId and id of each user.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nGets information about a SCIM group.
", + "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nGets information about a SCIM group.
", "statusCodes": [ { "httpStatusCode": "200", @@ -215195,7 +215195,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nReplaces an existing provisioned group’s information.
\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the Update an attribute for a SCIM enterprise group endpoint instead.
", + "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nReplaces an existing provisioned group’s information.
\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the Update an attribute for a SCIM enterprise group endpoint instead.
", "statusCodes": [ { "httpStatusCode": "200", @@ -215742,7 +215742,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nUpdate a provisioned group’s individual attributes.
\nTo change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification. Update can also be used to add group memberships.
\nGroup memberships can be sent one at a time or in batches for faster performance. Note: The memberships are referenced through a local user id, and the user will need to be created before they are referenced here.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nUpdate a provisioned group’s individual attributes.
\nTo change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification. Update can also be used to add group memberships.
\nGroup memberships can be sent one at a time or in batches for faster performance. Note: The memberships are referenced through a local user id, and the user will need to be created before they are referenced here.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nDeletes a SCIM group from an enterprise.
", + "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nDeletes a SCIM group from an enterprise.
", "statusCodes": [ { "httpStatusCode": "204", @@ -216297,7 +216297,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nLists provisioned SCIM enterprise members.
\nWhen a user with a SCIM-provisioned external identity is removed from an enterprise through a patch with active flag set to false, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the delete request. Users that were not permanently deleted will be visible in the returned results.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nLists provisioned SCIM enterprise members.
\nWhen a user with a SCIM-provisioned external identity is removed from an enterprise through a patch with active flag set to false, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the delete request. Users that were not permanently deleted will be visible in the returned results.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nCreates an external identity for a new SCIM enterprise user.
\nSCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response NameID to SCIM userName.
When converting existing enterprise to use SCIM, the user handle (userName) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nCreates an external identity for a new SCIM enterprise user.
\nSCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response NameID to SCIM userName.
When converting existing enterprise to use SCIM, the user handle (userName) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nGets information about a SCIM user.
", + "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nGets information about a SCIM user.
", "statusCodes": [ { "httpStatusCode": "200", @@ -218032,7 +218032,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nReplaces an existing provisioned user's information.
\nYou must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the Update an attribute for a SCIM user endpoint instead.
\nWarning
\n\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nReplaces an existing provisioned user's information.
\nYou must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the Update an attribute for a SCIM user endpoint instead.
\nWarning
\n\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nUpdate a provisioned user's individual attributes.
\nTo change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.
Note
\n\nComplicated SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will not work.
Warning
\n\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.
{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\nNote
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nUpdate a provisioned user's individual attributes.
\nTo change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.
Note
\n\nComplicated SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will not work.
Warning
\n\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.
{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\nNote
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nPermanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action.
", + "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nPermanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action.
", "statusCodes": [ { "httpStatusCode": "204", @@ -222987,13 +222987,13 @@ } ], "previews": [], + "descriptionHTML": "You can demote any user account except your own.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "You can demote any user account except your own.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -225083,7 +225083,7 @@ } ], "previews": [], - "descriptionHTML": "Allows you to add a new gist with one or more files.
\nNote
\n\nDon't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.
\nAllows you to add a new gist with one or more files.
\nNote
\n\nDon't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.
\nReturns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.
When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.
Note
\n\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nIf you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.
Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.
When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.
Note
\n\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nIf you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.
Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.
Note
\n\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nReturns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.
Note
\n\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nReturns a single tree using the SHA1 value or ref name for that tree.
\nIf truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.
Note
\n\nThe limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
Returns a single tree using the SHA1 value or ref name for that tree.
\nIf truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.
Note
\n\nThe limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.
Note
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.
Note
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues in an organization assigned to the authenticated user.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues in an organization assigned to the authenticated user.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues in a repository. Only open issues will be listed.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues in a repository. Only open issues will be listed.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.
Note
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.
Note
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues across owned and member repositories assigned to the authenticated user.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues across owned and member repositories assigned to the authenticated user.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Removes one or more assignees from an issue.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Removes one or more assignees from an issue.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -269271,6 +269271,7 @@ } ], "previews": [], + "descriptionHTML": "Checks if a user has permission to be assigned to a specific issue.
\nIf the assignee can be assigned to this issue, a 204 status code with no content is returned.
Otherwise a 404 status code is returned.
Response if assignee can not be assigned to issue_number
Checks if a user has permission to be assigned to a specific issue.
\nIf the assignee can be assigned to this issue, a 204 status code with no content is returned.
Otherwise a 404 status code is returned.
OK
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -323441,6 +323441,7 @@ } ], "previews": [], + "descriptionHTML": "List all the repositories for this organization migration.
", "statusCodes": [ { "httpStatusCode": "200", @@ -323450,8 +323451,7 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ], - "descriptionHTML": "List all the repositories for this organization migration.
" + ] } ], "users": [ @@ -327822,7 +327822,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return [\"repo\", \"user\"].
Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return [\"repo\", \"user\"].
Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on the application authorizations settings screen within GitHub.
", + "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on the application authorizations settings screen within GitHub.
", "statusCodes": [ { "httpStatusCode": "204", @@ -329242,7 +329242,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nCreates OAuth tokens using Basic Authentication. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use fingerprint to differentiate between them.
You can also create tokens on GitHub Enterprise Server from the personal access tokens settings page. Read more about these tokens in the GitHub Help documentation.
\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see \"About identity and access management with SAML single sign-on\" in the GitHub Enterprise Cloud documentation.
", + "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nCreates OAuth tokens using Basic Authentication. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use fingerprint to differentiate between them.
You can also create tokens on GitHub Enterprise Server from the personal access tokens settings page. Read more about these tokens in the GitHub Help documentation.
\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see \"About identity and access management with SAML single sign-on\" in the GitHub Enterprise Cloud documentation.
", "statusCodes": [ { "httpStatusCode": "201", @@ -331351,7 +331351,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nCreates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
", + "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nCreates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -332300,7 +332300,7 @@ }, { "httpStatusCode": "201", - "description": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nThis method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. fingerprint is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
", + "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nThis method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. fingerprint is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -335305,7 +335305,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nYou can only send one of these scope keys at a time.
", + "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nYou can only send one of these scope keys at a time.
", "statusCodes": [ { "httpStatusCode": "200", @@ -336405,7 +336405,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nLists all organizations, in the order that they were created.
\nNote
\n\nPagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
Lists all organizations, in the order that they were created.
\nNote
\n\nPagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
Warning
\n\nClosing down notice: GitHub Enterprise Server will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.
Warning
\n\nClosing down notice: Code security product enablement for new repositories through the organization API is closing down and will be replaced with code security configurations in a future GitHub Enterprise Server version.
\nUpdates the organization's profile and member privileges.
\nThe authenticated user must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Warning
\n\nClosing down notice: GitHub Enterprise Server will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.
Warning
\n\nClosing down notice: Code security product enablement for new repositories through the organization API is closing down and will be replaced with code security configurations in a future GitHub Enterprise Server version.
\nUpdates the organization's profile and member privileges.
\nThe authenticated user must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Gets the audit log for an organization. For more information, see \"Reviewing the audit log for your organization.\"
\nBy default, the response includes up to 30 events from the past three months. Use the phrase parameter to filter results and retrieve older events. For example, use the phrase parameter with the created qualifier to filter events based on when the events occurred. For more information, see \"Reviewing the audit log for your organization.\"
Use pagination to retrieve fewer or more than 30 events. For more information, see \"Using pagination in the REST API.\"
\nThe authenticated user must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:audit_log scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets the audit log for an organization. For more information, see \"Reviewing the audit log for your organization.\"
\nBy default, the response includes up to 30 events from the past three months. Use the phrase parameter to filter results and retrieve older events. For example, use the phrase parameter with the created qualifier to filter events based on when the events occurred. For more information, see \"Reviewing the audit log for your organization.\"
Use pagination to retrieve fewer or more than 30 events. For more information, see \"Using pagination in the REST API.\"
\nThe authenticated user must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:audit_log scope to use this endpoint.
Warning
\n\nClosing down notice: The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use code security configurations instead. For more information, see the changelog.
\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"Managing security managers in your organization.\"
\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org, write:org, or repo scopes to use this endpoint.
Warning
\n\nClosing down notice: The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use code security configurations instead. For more information, see the changelog.
\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"Managing security managers in your organization.\"
\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org, write:org, or repo scopes to use this endpoint.
List organizations for the authenticated user.
\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a 403 Forbidden response.
Note
\n\nRequests using a fine-grained access token will receive a 200 Success response with an empty list.
List organizations for the authenticated user.
\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a 403 Forbidden response.
Note
\n\nRequests using a fine-grained access token will receive a 200 Success response with an empty list.
Warning
\n\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.
\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Warning
\n\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.
\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Check if the provided user is a public member of the organization.
", "statusCodes": [ { "httpStatusCode": "204", @@ -345128,8 +345129,7 @@ "httpStatusCode": "404", "description": "Not Found if user is not a public member
" } - ], - "descriptionHTML": "Check if the provided user is a public member of the organization.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -347607,13 +347607,13 @@ } ], "previews": [], + "descriptionHTML": "Removes all assigned organization roles from a team. For more information on organization roles, see \"Using organization roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Removes all assigned organization roles from a team. For more information on organization roles, see \"Using organization roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Removes an organization role from a team. For more information on organization roles, see \"Using organization roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Removes an organization role from a team. For more information on organization roles, see \"Using organization roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Remove an organization role from a user. For more information on organization roles, see \"Using organization roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Remove an organization role from a user. For more information on organization roles, see \"Using organization roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Gets information about a suite of rule evaluations from within an organization.\nFor more information, see \"Managing rulesets for repositories in your organization.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -353976,8 +353977,7 @@ "httpStatusCode": "500", "description": "Internal Error
" } - ], - "descriptionHTML": "Gets information about a suite of rule evaluations from within an organization.\nFor more information, see \"Managing rulesets for repositories in your organization.\"
" + ] } ], "rules": [ @@ -361373,13 +361373,13 @@ } ], "previews": [], + "descriptionHTML": "Adds a team as a security manager for an organization. For more information, see \"Managing security for an organization for an organization.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Adds a team as a security manager for an organization. For more information, see \"Managing security for an organization for an organization.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Updates the webhook configuration for an organization. To update more information about the webhook, including the active state and events, use \"Update an organization webhook .\"
You must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
OK
" } - ], - "descriptionHTML": "Updates the webhook configuration for an organization. To update more information about the webhook, including the active state and events, use \"Update an organization webhook .\"
You must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
Gets a specific package version in an organization.
\nOAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
OK
" } - ], - "descriptionHTML": "Gets a specific package version in an organization.
\nOAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
Gets information about the single most recent build of a GitHub Enterprise Server Pages site.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets information about the single most recent build of a GitHub Enterprise Server Pages site.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResource not found
" } - ], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nLists the files in a specified pull request.
\nNote
\n\nResponses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Lists the files in a specified pull request.
\nNote
\n\nResponses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty.
", "statusCodes": [ { "httpStatusCode": "204", @@ -407146,8 +407147,7 @@ "httpStatusCode": "404", "description": "Not Found if pull request has not been merged
" } - ], - "descriptionHTML": "Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -422565,7 +422565,7 @@ } ], "previews": [], - "descriptionHTML": "Creates a review on a specified pull request.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note
\n\nTo comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the application/vnd.github.v3.diff media type to the Accept header of a call to the Get a pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Creates a review on a specified pull request.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note
\n\nTo comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the application/vnd.github.v3.diff media type to the Accept header of a call to the Get a pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Lists comments for a specific pull request review.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Resource not found
" } - ], - "descriptionHTML": "Lists comments for a specific pull request review.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Dismisses a specified review on a pull request.
\nNote
\n\nTo dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Dismisses a specified review on a pull request.
\nNote
\n\nTo dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Note
\n\nAccessing this endpoint does not count against your REST API rate limit.
\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under resources, you'll see objects relating to different categories:
core object provides your rate limit status for all non-search-related resources in the REST API.search object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"Search.\"code_search object provides your rate limit status for the REST API for searching code. For more information, see \"Search code.\"graphql object provides your rate limit status for the GraphQL API. For more information, see \"Resource limitations.\"integration_manifest object provides your rate limit status for the POST /app-manifests/{code}/conversions operation. For more information, see \"Creating a GitHub App from a manifest.\"dependency_snapshots object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"Dependency graph.\"dependency_sbom object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"Dependency graph.\"code_scanning_upload object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"Uploading a SARIF file to GitHub.\"actions_runner_registration object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"Self-hosted runners.\"source_import object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"API Versions.\"Note
\n\nThe rate object is closing down. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.
Note
\n\nAccessing this endpoint does not count against your REST API rate limit.
\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under resources, you'll see objects relating to different categories:
core object provides your rate limit status for all non-search-related resources in the REST API.search object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"Search.\"code_search object provides your rate limit status for the REST API for searching code. For more information, see \"Search code.\"graphql object provides your rate limit status for the GraphQL API. For more information, see \"Resource limitations.\"integration_manifest object provides your rate limit status for the POST /app-manifests/{code}/conversions operation. For more information, see \"Creating a GitHub App from a manifest.\"dependency_snapshots object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"Dependency graph.\"dependency_sbom object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"Dependency graph.\"code_scanning_upload object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"Uploading a SARIF file to GitHub.\"actions_runner_registration object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"Self-hosted runners.\"source_import object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"API Versions.\"Note
\n\nThe rate object is closing down. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.
List the reactions to a team discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
List the reactions to a team discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Create a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Create a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
List the reactions to a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
List the reactions to a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Create a reaction to a team discussion.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Created
" } - ], - "descriptionHTML": "Create a reaction to a team discussion.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -430227,7 +430227,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -431316,7 +431316,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", "statusCodes": [ { "httpStatusCode": "204", @@ -431686,6 +431686,7 @@ } ], "previews": [], + "descriptionHTML": "List the reactions to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -431695,8 +431696,7 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ], - "descriptionHTML": "List the reactions to a pull request review comment.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -432404,7 +432404,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -432767,6 +432767,7 @@ } ], "previews": [], + "descriptionHTML": "List the reactions to a release.
", "statusCodes": [ { "httpStatusCode": "200", @@ -432776,8 +432777,7 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ], - "descriptionHTML": "List the reactions to a release.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -433475,13 +433475,13 @@ } ], "previews": [], + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -433833,7 +433833,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
View the latest published full release for the repository.
\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the created_at attribute. The created_at attribute is the date of the commit used for the release, and not the date when the release was drafted or published.
OK
" } - ], - "descriptionHTML": "View the latest published full release for the repository.
\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the created_at attribute. The created_at attribute is the date of the commit used for the release, and not the date when the release was drafted or published.
Gets a public release with the specified release ID.
\nNote
\n\nThis returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"Getting started with the REST API.\"
Gets a public release with the specified release ID.
\nNote
\n\nThis returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"Getting started with the REST API.\"
Lists repositories for the specified organization.
\nNote
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
Lists repositories for the specified organization.
\nNote
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.
Note
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.
Note
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
Creates a new file or replaces an existing file in a repository.
\nNote
\n\nIf you use this endpoint and the \"Delete a file\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. The workflow scope is also required in order to modify files in the .github/workflows directory.
Creates a new file or replaces an existing file in a repository.
\nNote
\n\nIf you use this endpoint and the \"Delete a file\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. The workflow scope is also required in order to modify files in the .github/workflows directory.
Deletes a file in a repository.
\nYou can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.
The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.
You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.
Note
\n\nIf you use this endpoint and the \"Create or update file contents\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
\nDeletes a file in a repository.
\nYou can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.
The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.
You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.
Note
\n\nIf you use this endpoint and the \"Create or update file contents\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
\nGets a redirect URL to download a tar archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes.
\nGets a redirect URL to download a tar archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes.
\nGets a redirect URL to download a zip archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.
\nGets a redirect URL to download a zip archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.
\nCreate a fork for the authenticated user.
\nNote
\n\nForking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub Enterprise Server Support.
\nNote
\n\nAlthough this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.
\nCreate a fork for the authenticated user.
\nNote
\n\nForking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub Enterprise Server Support.
\nNote
\n\nAlthough this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.
\nWarning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis returns the tag protection states of a repository.
\nThis information is only available to repository administrators.
", + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis returns the tag protection states of a repository.
\nThis information is only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "200", @@ -492269,7 +492269,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "201", @@ -492351,7 +492351,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "204", @@ -494701,6 +494701,7 @@ } ], "previews": [], + "descriptionHTML": "This will trigger a ping event to be sent to the hook.
", "statusCodes": [ { "httpStatusCode": "204", @@ -494710,8 +494711,7 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ], - "descriptionHTML": "This will trigger a ping event to be sent to the hook.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -494779,7 +494779,7 @@ } ], "previews": [], - "descriptionHTML": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook is not subscribed to push events, the server will respond with 204 but no test POST will be generated.
Note
\n\nPreviously /repos/:owner/:repo/hooks/:hook_id/test
This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook is not subscribed to push events, the server will respond with 204 but no test POST will be generated.
Note
\n\nPreviously /repos/:owner/:repo/hooks/:hook_id/test
Find issues by state and keyword. This method returns up to 100 results per page.
\nWhen searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.
For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.
\nq=windows+label:bug+language:python+state:open&sort=created&order=asc
This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.
Note
\n\nFor requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"
Find issues by state and keyword. This method returns up to 100 results per page.
\nWhen searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.
For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.
\nq=windows+label:bug+language:python+state:open&sort=created&order=asc
This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.
Note
\n\nFor requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"
Gets a team using the team's slug. To create the slug, GitHub Enterprise Server replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a - separator. For example, \"My TEam Näme\" would become my-team-name.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
Gets a team using the team's slug. To create the slug, GitHub Enterprise Server replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a - separator. For example, \"My TEam Näme\" would become my-team-name.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
To edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}.
To edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}.
To delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}.
To delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}.
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nLists a team's repositories visible to the authenticated user.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos.
Lists a team's repositories visible to the authenticated user.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos.
Checks whether a team has admin, push, maintain, triage, or pull permission for a repository. Repositories inherited through a parent team will also be checked.
You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the application/vnd.github.v3.repository+json accept header.
If a team doesn't have permission for the repository, you will receive a 404 Not Found response status.
If the repository is private, you must have at least read permission for that repository, and your token must have the repo or admin:org scope. Otherwise, you will receive a 404 Not Found response status.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
Checks whether a team has admin, push, maintain, triage, or pull permission for a repository. Repositories inherited through a parent team will also be checked.
You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the application/vnd.github.v3.repository+json accept header.
If a team doesn't have permission for the repository, you will receive a 404 Not Found response status.
If the repository is private, you must have at least read permission for that repository, and your token must have the repo or admin:org scope. Otherwise, you will receive a 404 Not Found response status.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Note
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
For more information about the permission levels, see \"Repository permission levels for an organization\".
", + "descriptionHTML": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Note
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
For more information about the permission levels, see \"Repository permission levels for an organization\".
", "statusCodes": [ { "httpStatusCode": "204", @@ -516088,13 +516088,13 @@ } ], "previews": [], + "descriptionHTML": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
No Content
" } - ], - "descriptionHTML": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
Lists the child teams of the team specified by {team_slug}.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.
Lists the child teams of the team specified by {team_slug}.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the Get a team by name endpoint.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the Get a team by name endpoint.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a team endpoint.
\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote
\n\nWith nested teams, the privacy for parent teams cannot be secret.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a team endpoint.
\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote
\n\nWith nested teams, the privacy for parent teams cannot be secret.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a team endpoint.
\nTo delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
", + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a team endpoint.
\nTo delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
", "statusCodes": [ { "httpStatusCode": "204", @@ -519095,7 +519095,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team repositories endpoint.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team repositories endpoint.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a repository endpoint.
\nNote
\n\nRepositories inherited through a parent team will also be checked.
\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a repository endpoint.
\nNote
\n\nRepositories inherited through a parent team will also be checked.
\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Add or update team repository permissions\" endpoint.
\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization.
Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Add or update team repository permissions\" endpoint.
\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization.
Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a repository from a team endpoint.
\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.
", + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a repository from a team endpoint.
\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.
", "statusCodes": [ { "httpStatusCode": "204", @@ -522164,7 +522164,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List child teams endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List child teams endpoint.
List all comments on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
List all comments on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Creates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Creates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Get a specific comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Get a specific comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Edits the body text of a discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Edits the body text of a discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Deletes a comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Deletes a comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion comments endpoint.
\nList all comments on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion comments endpoint.
\nList all comments on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.
\nCreates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.
\nCreates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion comment endpoint.
\nGet a specific comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion comment endpoint.
\nGet a specific comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.
\nEdits the body text of a discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.
\nEdits the body text of a discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion comment endpoint.
\nDeletes a comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion comment endpoint.
\nDeletes a comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
List all discussions on a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
List all discussions on a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Get a specific discussion on a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Get a specific discussion on a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Edits the title and body text of a discussion post. Only the parameters you provide are updated.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Edits the title and body text of a discussion post. Only the parameters you provide are updated.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Delete a discussion from a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Delete a discussion from a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.
List all discussions on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.
List all discussions on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.
Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.
Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion endpoint.
\nGet a specific discussion on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion endpoint.
\nGet a specific discussion on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion endpoint.
\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion endpoint.
\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion endpoint.
Delete a discussion from a team's page.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion endpoint.
Delete a discussion from a team's page.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Lists external groups available in an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also limit your page results using the per_page parameter. GitHub Enterprise Server generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see \"Offset and Cursor Pagination explained.\"
You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Lists external groups available in an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also limit your page results using the per_page parameter. GitHub Enterprise Server generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see \"Offset and Cursor Pagination explained.\"
You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -531172,13 +531172,13 @@ } ], "previews": [], + "descriptionHTML": "Lists a connection between a team and an external group.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Lists a connection between a team and an external group.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -531406,13 +531406,13 @@ } ], "previews": [], + "descriptionHTML": "Creates a connection between a team and an external group. Only one external group can be linked to a team.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Creates a connection between a team and an external group. Only one external group can be linked to a team.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -531470,13 +531470,13 @@ } ], "previews": [], + "descriptionHTML": "Deletes a connection between a team and an external group.
\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "Deletes a connection between a team and an external group.
\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
" + ] } ], "members": [ @@ -531859,7 +531859,7 @@ } ], "previews": [], - "descriptionHTML": "Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note
\n\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note
\n\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}.
Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}.
To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}.
To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members endpoint.
Team members will include the members of child teams.
", + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members endpoint.
Team members will include the members of child teams.
", "statusCodes": [ { "httpStatusCode": "200", @@ -532468,7 +532468,7 @@ } ], "previews": [], - "descriptionHTML": "The \"Add team member\" endpoint (described below) is closing down.
\nWe recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
The \"Add team member\" endpoint (described below) is closing down.
\nWe recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
The \"Remove team member\" endpoint (described below) is closing down.
\nWe recommend using the Remove team membership for a user endpoint instead. It allows you to remove both active and pending memberships.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nThe \"Remove team member\" endpoint (described below) is closing down.
\nWe recommend using the Remove team membership for a user endpoint instead. It allows you to remove both active and pending memberships.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership for a user endpoint.
\nTeam members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership for a user endpoint.
\nTeam members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
", + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
", "statusCodes": [ { "httpStatusCode": "200", @@ -532826,7 +532826,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nSpecifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"Using environments for deployment.\"
\nNote
\n\nGitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"Using environments for deployment.\"
\nNote
\n\nGitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Note
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nIf you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. Optional: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nIf you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. Optional: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nThis is the user's organization dashboard. You must be authenticated as the user to view this.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nThis is the user's organization dashboard. You must be authenticated as the user to view this.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nThese are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nThese are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nLists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.
\nuri_template. For more information, see \"Hypermedia.\"By default, timeline resources are returned in JSON. You can specify the application/atom+xml type in the Accept header to return timeline resources in Atom format. For more information, see \"Media types.\"
Note
\n\nPrivate feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
\nLists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.
\nuri_template. For more information, see \"Hypermedia.\"By default, timeline resources are returned in JSON. You can specify the application/atom+xml type in the Accept header to return timeline resources in Atom format. For more information, see \"Media types.\"
Note
\n\nPrivate feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
\nNote
\n\nThe :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).
Note
\n\nThe :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).
Renames a branch in a repository.
\nNote
\n\nAlthough the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".
\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.
\nIn order to rename the default branch, fine-grained access tokens also need the administration:write repository permission.
Renames a branch in a repository.
\nNote
\n\nAlthough the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".
\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.
\nIn order to rename the default branch, fine-grained access tokens also need the administration:write repository permission.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nProtecting a branch requires admin or owner permissions to the repository.
\nNote
\n\nPassing new arrays of users and teams replaces their previous values.
Note
\n\nThe list of users, apps, and teams in total is limited to 100 items.
\nProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nProtecting a branch requires admin or owner permissions to the repository.
\nNote
\n\nPassing new arrays of users and teams replaces their previous values.
Note
\n\nThe list of users, apps, and teams in total is limited to 100 items.
\nProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
\nNote
\n\nPassing new arrays of users and teams replaces their previous values.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
\nNote
\n\nPassing new arrays of users and teams replaces their previous values.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.
Note
\n\nYou must enable branch protection to require signed commits.
\nProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.
Note
\n\nYou must enable branch protection to require signed commits.
\nProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists who has access to this protected branch.
\nNote
\n\nUsers, apps, and teams restrictions are only available for organization-owned repositories.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists who has access to this protected branch.
\nNote
\n\nUsers, apps, and teams restrictions are only available for organization-owned repositories.
Creates a new check run for a specific commit in a repository.
\nTo create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.
\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
\nNote
\n\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Creates a new check run for a specific commit in a repository.
\nTo create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.
\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
\nNote
\n\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Gets a single check run using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Gets a single check run using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Updates a check run for a specific commit in a repository.
\nNote
\n\nThe 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.
OAuth apps and personal access tokens (classic) cannot use this endpoint.
", + "descriptionHTML": "Updates a check run for a specific commit in a repository.
\nNote
\n\nThe 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.
OAuth apps and personal access tokens (classic) cannot use this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -142168,7 +142168,7 @@ } ], "previews": [], - "descriptionHTML": "Lists check runs for a check suite using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check runs for a check suite using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name.
Note
\n\nThe 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 endpoint and provide the check_suite_id parameter to the List check runs in a check suite endpoint.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name.
Note
\n\nThe 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 endpoint and provide the check_suite_id parameter to the List check runs in a check suite endpoint.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Creates a check suite manually. By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"Update repository preferences for check suites\".
\nNote
\n\nThe 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.
OAuth apps and personal access tokens (classic) cannot use this endpoint.
", + "descriptionHTML": "Creates a check suite manually. By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"Update repository preferences for check suites\".
\nNote
\n\nThe 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.
OAuth apps and personal access tokens (classic) cannot use this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -150641,7 +150641,7 @@ } ], "previews": [], - "descriptionHTML": "Gets a single check suite using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Gets a single check suite using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.
The rules_count field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.
Warning
\n\nClosing down notice: The tool_name field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.
OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.
The rules_count field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.
Warning
\n\nClosing down notice: The tool_name field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.
OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Lists all code security configurations available in an enterprise.
\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.
Note
\n\nThe enablement status will only be returned for installed security products.
\nLists all code security configurations available in an enterprise.
\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.
Note
\n\nThe enablement status will only be returned for installed security products.
\nCreates a code security configuration in an enterprise.
\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Note
\n\nOnly installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error.
\nCreates a code security configuration in an enterprise.
\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Note
\n\nOnly installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error.
\nGets a code security configuration available in an enterprise.
\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.
Note
\n\nAny security products that are not installed will report an unset status.
Gets a code security configuration available in an enterprise.
\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.
Note
\n\nAny security products that are not installed will report an unset status.
Updates a code security configuration in an enterprise.
\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Note
\n\nThe enablement status will only be returned for installed security products.
\nUpdates a code security configuration in an enterprise.
\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Note
\n\nThe enablement status will only be returned for installed security products.
\nLists all code security configurations available in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nThe enablement status will only be returned for installed security products.
\nLists all code security configurations available in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nThe enablement status will only be returned for installed security products.
\nCreates a code security configuration in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nOnly installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error.
\nCreates a code security configuration in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nOnly installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error.
\nLists the default code security configurations for an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nNote
\n\nThe enablement status will only be returned for installed security products.
\nLists the default code security configurations for an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nNote
\n\nThe enablement status will only be returned for installed security products.
\nGets a code security configuration available in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nThe enablement status will only be returned for installed security products.
\nGets a code security configuration available in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nThe enablement status will only be returned for installed security products.
\nUpdates a code security configuration in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nOnly installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error.
\nUpdates a code security configuration in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nOnly installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error.
\nSets a code security configuration as a default to be applied to new repositories in your organization.
\nThis configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nThe enablement status will only be returned for installed security products.
\nSets a code security configuration as a default to be applied to new repositories in your organization.
\nThis configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nThe enablement status will only be returned for installed security products.
\nRemoves a collaborator from a repository.
\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.
\nThis endpoint also:
\nRemoving a user as a collaborator has the following effects on forks:
\nNote
\n\nA user can still have access to the repository through organization permissions like base repository permissions.
\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.
\nFor more information on fork permissions, see \"About permissions and visibility of forks\".
", + "descriptionHTML": "Removes a collaborator from a repository.
\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.
\nThis endpoint also:
\nRemoving a user as a collaborator has the following effects on forks:
\nNote
\n\nA user can still have access to the repository through organization permissions like base repository permissions.
\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.
\nFor more information on fork permissions, see \"About permissions and visibility of forks\".
", "statusCodes": [ { "httpStatusCode": "204", @@ -179401,7 +179401,7 @@ } ], "previews": [], - "descriptionHTML": "Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.
Note
\n\nIf there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\" Pagination query parameters are not supported for these media types.
\napplication/vnd.github.diff: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property. Larger diffs may time out and return a 5xx status code.application/vnd.github.sha: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
verified_at | string | The date the signature was verified by GitHub. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on their account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.
Note
\n\nIf there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\" Pagination query parameters are not supported for these media types.
\napplication/vnd.github.diff: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property. Larger diffs may time out and return a 5xx status code.application/vnd.github.sha: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
verified_at | string | The date the signature was verified by GitHub. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on their account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Note
\n\nTo get information about name patterns that branches must match in order to deploy to this environment, see \"Get a deployment branch policy.\"
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Note
\n\nTo get information about name patterns that branches must match in order to deploy to this environment, see \"Get a deployment branch policy.\"
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"Environments.\"
\nNote
\n\nTo create or update name patterns that branches must match in order to deploy to this environment, see \"Deployment branch policies.\"
\nNote
\n\nTo create or update secrets for an environment, see \"GitHub Actions secrets.\"
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"Environments.\"
\nNote
\n\nTo create or update name patterns that branches must match in order to deploy to this environment, see \"Deployment branch policies.\"
\nNote
\n\nTo create or update secrets for an environment, see \"GitHub Actions secrets.\"
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment.
\nNote
\n\nIt's recommended to use the log_url parameter, which replaces target_url.
The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment.
\nNote
\n\nIt's recommended to use the log_url parameter, which replaces target_url.
Warning
\n\nClosing down notice: The ability to fetch code security and analysis settings for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.
\nGets code security and analysis settings for the specified enterprise.
\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.
Warning
\n\nClosing down notice: The ability to fetch code security and analysis settings for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.
\nGets code security and analysis settings for the specified enterprise.
\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.
Warning
\n\nClosing down notice: The ability to update code security and analysis settings for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.
\nUpdates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise.
\nThe authenticated user must be an administrator of the enterprise to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Warning
\n\nClosing down notice: The ability to update code security and analysis settings for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.
\nUpdates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise.
\nThe authenticated user must be an administrator of the enterprise to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Warning
\n\nClosing down notice: The ability to enable or disable a security feature for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.
\nEnables or disables the specified security feature for all repositories in an enterprise.
\nThe authenticated user must be an administrator of the enterprise to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Warning
\n\nClosing down notice: The ability to enable or disable a security feature for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.
\nEnables or disables the specified security feature for all repositories in an enterprise.
\nThe authenticated user must be an administrator of the enterprise to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.
\nImportant
\n\nTo start the configuration process and apply the license, you need to POST to /manage/v1/config/apply
The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.
\nNote
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.
\nImportant
\n\nTo start the configuration process and apply the license, you need to POST to /manage/v1/config/apply
The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.
\nNote
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
Uploads a new enterprise license. In order to apply it right away, use the apply query parameter.
Note
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
Uploads a new enterprise license. In order to apply it right away, use the apply query parameter.
Note
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nLists provisioned SCIM groups in an enterprise.
\nYou can improve query search time by using the excludedAttributes query parameter with a value of members to exclude members from the response.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nLists provisioned SCIM groups in an enterprise.
\nYou can improve query search time by using the excludedAttributes query parameter with a value of members to exclude members from the response.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nCreates a SCIM group for an enterprise.
\nIf members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the externalId and id of each user.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nCreates a SCIM group for an enterprise.
\nIf members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the externalId and id of each user.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nGets information about a SCIM group.
", + "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nGets information about a SCIM group.
", "statusCodes": [ { "httpStatusCode": "200", @@ -220379,7 +220379,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nReplaces an existing provisioned group’s information.
\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the Update an attribute for a SCIM enterprise group endpoint instead.
", + "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nReplaces an existing provisioned group’s information.
\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the Update an attribute for a SCIM enterprise group endpoint instead.
", "statusCodes": [ { "httpStatusCode": "200", @@ -220926,7 +220926,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nUpdate a provisioned group’s individual attributes.
\nTo change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification. Update can also be used to add group memberships.
\nGroup memberships can be sent one at a time or in batches for faster performance. Note: The memberships are referenced through a local user id, and the user will need to be created before they are referenced here.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nUpdate a provisioned group’s individual attributes.
\nTo change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification. Update can also be used to add group memberships.
\nGroup memberships can be sent one at a time or in batches for faster performance. Note: The memberships are referenced through a local user id, and the user will need to be created before they are referenced here.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nDeletes a SCIM group from an enterprise.
", + "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nDeletes a SCIM group from an enterprise.
", "statusCodes": [ { "httpStatusCode": "204", @@ -221481,7 +221481,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nLists provisioned SCIM enterprise members.
\nWhen a user with a SCIM-provisioned external identity is removed from an enterprise through a patch with active flag set to false, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the delete request. Users that were not permanently deleted will be visible in the returned results.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nLists provisioned SCIM enterprise members.
\nWhen a user with a SCIM-provisioned external identity is removed from an enterprise through a patch with active flag set to false, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the delete request. Users that were not permanently deleted will be visible in the returned results.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nCreates an external identity for a new SCIM enterprise user.
\nSCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response NameID to SCIM userName.
When converting existing enterprise to use SCIM, the user handle (userName) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nCreates an external identity for a new SCIM enterprise user.
\nSCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response NameID to SCIM userName.
When converting existing enterprise to use SCIM, the user handle (userName) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nGets information about a SCIM user.
", + "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nGets information about a SCIM user.
", "statusCodes": [ { "httpStatusCode": "200", @@ -223216,7 +223216,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nReplaces an existing provisioned user's information.
\nYou must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the Update an attribute for a SCIM user endpoint instead.
\nWarning
\n\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nReplaces an existing provisioned user's information.
\nYou must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the Update an attribute for a SCIM user endpoint instead.
\nWarning
\n\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nUpdate a provisioned user's individual attributes.
\nTo change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.
Note
\n\nComplicated SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will not work.
Warning
\n\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.
{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\nNote
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nUpdate a provisioned user's individual attributes.
\nTo change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.
Note
\n\nComplicated SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will not work.
Warning
\n\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.
{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\nNote
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nPermanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action.
", + "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nPermanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action.
", "statusCodes": [ { "httpStatusCode": "204", @@ -230314,7 +230314,7 @@ } ], "previews": [], - "descriptionHTML": "Allows you to add a new gist with one or more files.
\nNote
\n\nDon't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.
\nAllows you to add a new gist with one or more files.
\nNote
\n\nDon't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.
\nReturns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.
When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.
Note
\n\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nIf you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.
Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.
When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.
Note
\n\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nIf you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.
Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.
Note
\n\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nReturns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.
Note
\n\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nReturns a single tree using the SHA1 value or ref name for that tree.
\nIf truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.
Note
\n\nThe limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
Returns a single tree using the SHA1 value or ref name for that tree.
\nIf truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.
Note
\n\nThe limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.
Note
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.
Note
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues in an organization assigned to the authenticated user.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues in an organization assigned to the authenticated user.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues in a repository. Only open issues will be listed.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues in a repository. Only open issues will be listed.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.
Note
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.
Note
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues across owned and member repositories assigned to the authenticated user.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues across owned and member repositories assigned to the authenticated user.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return [\"repo\", \"user\"].
Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return [\"repo\", \"user\"].
Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on the application authorizations settings screen within GitHub.
", + "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on the application authorizations settings screen within GitHub.
", "statusCodes": [ { "httpStatusCode": "204", @@ -334481,7 +334481,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nCreates OAuth tokens using Basic Authentication. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use fingerprint to differentiate between them.
You can also create tokens on GitHub Enterprise Server from the personal access tokens settings page. Read more about these tokens in the GitHub Help documentation.
\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see \"About identity and access management with SAML single sign-on\" in the GitHub Enterprise Cloud documentation.
", + "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nCreates OAuth tokens using Basic Authentication. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use fingerprint to differentiate between them.
You can also create tokens on GitHub Enterprise Server from the personal access tokens settings page. Read more about these tokens in the GitHub Help documentation.
\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see \"About identity and access management with SAML single sign-on\" in the GitHub Enterprise Cloud documentation.
", "statusCodes": [ { "httpStatusCode": "201", @@ -336606,7 +336606,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nCreates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
", + "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nCreates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -337563,7 +337563,7 @@ }, { "httpStatusCode": "201", - "description": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nThis method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. fingerprint is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
", + "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nThis method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. fingerprint is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -340592,7 +340592,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nYou can only send one of these scope keys at a time.
", + "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nYou can only send one of these scope keys at a time.
", "statusCodes": [ { "httpStatusCode": "200", @@ -341700,7 +341700,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nLists all organizations, in the order that they were created.
\nNote
\n\nPagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
Lists all organizations, in the order that they were created.
\nNote
\n\nPagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
Warning
\n\nClosing down notice: GitHub Enterprise Server will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.
Warning
\n\nClosing down notice: Code security product enablement for new repositories through the organization API is closing down and will be replaced with code security configurations in a future GitHub Enterprise Server version.
\nUpdates the organization's profile and member privileges.
\nThe authenticated user must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Warning
\n\nClosing down notice: GitHub Enterprise Server will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.
Warning
\n\nClosing down notice: Code security product enablement for new repositories through the organization API is closing down and will be replaced with code security configurations in a future GitHub Enterprise Server version.
\nUpdates the organization's profile and member privileges.
\nThe authenticated user must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Warning
\n\nClosing down notice: The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use code security configurations instead. For more information, see the changelog.
\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"Managing security managers in your organization.\"
\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org, write:org, or repo scopes to use this endpoint.
Warning
\n\nClosing down notice: The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use code security configurations instead. For more information, see the changelog.
\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"Managing security managers in your organization.\"
\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org, write:org, or repo scopes to use this endpoint.
List organizations for the authenticated user.
\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a 403 Forbidden response.
Note
\n\nRequests using a fine-grained access token will receive a 200 Success response with an empty list.
List organizations for the authenticated user.
\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a 403 Forbidden response.
Note
\n\nRequests using a fine-grained access token will receive a 200 Success response with an empty list.
Warning
\n\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.
\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Warning
\n\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.
\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Warning
\n\nClosing down notice: This operation is closing down and will be removed in Enterprise Server 3.20. Please use the \"Organization Roles\" endpoints instead.
\nWarning
\n\nClosing down notice: This operation is closing down and will be removed in Enterprise Server 3.20. Please use the \"Organization Roles\" endpoints instead.
\nWarning
\n\nClosing down notice: This operation is closing down and will be removed in Enterprise Server 3.20. Please use the \"Organization Roles\" endpoints instead.
\nWarning
\n\nClosing down notice: This operation is closing down and will be removed in Enterprise Server 3.20. Please use the \"Organization Roles\" endpoints instead.
\nWarning
\n\nClosing down notice: This operation is closing down and will be removed in Enterprise Server 3.20. Please use the \"Organization Roles\" endpoints instead.
\nWarning
\n\nClosing down notice: This operation is closing down and will be removed in Enterprise Server 3.20. Please use the \"Organization Roles\" endpoints instead.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nLists the files in a specified pull request.
\nNote
\n\nResponses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Lists the files in a specified pull request.
\nNote
\n\nResponses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Creates a review on a specified pull request.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note
\n\nTo comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the application/vnd.github.v3.diff media type to the Accept header of a call to the Get a pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Creates a review on a specified pull request.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note
\n\nTo comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the application/vnd.github.v3.diff media type to the Accept header of a call to the Get a pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Dismisses a specified review on a pull request.
\nNote
\n\nTo dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Dismisses a specified review on a pull request.
\nNote
\n\nTo dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Note
\n\nAccessing this endpoint does not count against your REST API rate limit.
\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under resources, you'll see objects relating to different categories:
core object provides your rate limit status for all non-search-related resources in the REST API.search object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"Search.\"code_search object provides your rate limit status for the REST API for searching code. For more information, see \"Search code.\"graphql object provides your rate limit status for the GraphQL API. For more information, see \"Resource limitations.\"integration_manifest object provides your rate limit status for the POST /app-manifests/{code}/conversions operation. For more information, see \"Creating a GitHub App from a manifest.\"dependency_snapshots object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"Dependency graph.\"dependency_sbom object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"Dependency graph.\"code_scanning_upload object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"Uploading a SARIF file to GitHub.\"actions_runner_registration object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"Self-hosted runners.\"source_import object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"API Versions.\"Note
\n\nThe rate object is closing down. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.
Note
\n\nAccessing this endpoint does not count against your REST API rate limit.
\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under resources, you'll see objects relating to different categories:
core object provides your rate limit status for all non-search-related resources in the REST API.search object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"Search.\"code_search object provides your rate limit status for the REST API for searching code. For more information, see \"Search code.\"graphql object provides your rate limit status for the GraphQL API. For more information, see \"Resource limitations.\"integration_manifest object provides your rate limit status for the POST /app-manifests/{code}/conversions operation. For more information, see \"Creating a GitHub App from a manifest.\"dependency_snapshots object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"Dependency graph.\"dependency_sbom object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"Dependency graph.\"code_scanning_upload object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"Uploading a SARIF file to GitHub.\"actions_runner_registration object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"Self-hosted runners.\"source_import object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"API Versions.\"Note
\n\nThe rate object is closing down. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.
List the reactions to a team discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
List the reactions to a team discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Create a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Create a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
List the reactions to a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
List the reactions to a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Create a reaction to a team discussion.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Create a reaction to a team discussion.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -436439,7 +436439,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -437528,7 +437528,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", "statusCodes": [ { "httpStatusCode": "204", @@ -438616,7 +438616,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -439687,7 +439687,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", "statusCodes": [ { "httpStatusCode": "204", @@ -440045,7 +440045,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Gets a public release with the specified release ID.
\nNote
\n\nThis returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"Getting started with the REST API.\"
Gets a public release with the specified release ID.
\nNote
\n\nThis returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"Getting started with the REST API.\"
Lists repositories for the specified organization.
\nNote
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
Lists repositories for the specified organization.
\nNote
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.
Note
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.
Note
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
Creates a new file or replaces an existing file in a repository.
\nNote
\n\nIf you use this endpoint and the \"Delete a file\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. The workflow scope is also required in order to modify files in the .github/workflows directory.
Creates a new file or replaces an existing file in a repository.
\nNote
\n\nIf you use this endpoint and the \"Delete a file\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. The workflow scope is also required in order to modify files in the .github/workflows directory.
Deletes a file in a repository.
\nYou can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.
The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.
You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.
Note
\n\nIf you use this endpoint and the \"Create or update file contents\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
\nDeletes a file in a repository.
\nYou can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.
The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.
You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.
Note
\n\nIf you use this endpoint and the \"Create or update file contents\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
\nGets a redirect URL to download a tar archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes.
\nGets a redirect URL to download a tar archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes.
\nGets a redirect URL to download a zip archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.
\nGets a redirect URL to download a zip archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.
\nCreate a fork for the authenticated user.
\nNote
\n\nForking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub Enterprise Server Support.
\nNote
\n\nAlthough this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.
\nCreate a fork for the authenticated user.
\nNote
\n\nForking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub Enterprise Server Support.
\nNote
\n\nAlthough this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.
\nWarning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis returns the tag protection states of a repository.
\nThis information is only available to repository administrators.
", + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis returns the tag protection states of a repository.
\nThis information is only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "200", @@ -498490,7 +498490,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "201", @@ -498572,7 +498572,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "204", @@ -501000,7 +501000,7 @@ } ], "previews": [], - "descriptionHTML": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook is not subscribed to push events, the server will respond with 204 but no test POST will be generated.
Note
\n\nPreviously /repos/:owner/:repo/hooks/:hook_id/test
This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook is not subscribed to push events, the server will respond with 204 but no test POST will be generated.
Note
\n\nPreviously /repos/:owner/:repo/hooks/:hook_id/test
Find issues by state and keyword. This method returns up to 100 results per page.
\nWhen searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.
For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.
\nq=windows+label:bug+language:python+state:open&sort=created&order=asc
This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.
Note
\n\nFor requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"
Find issues by state and keyword. This method returns up to 100 results per page.
\nWhen searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.
For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.
\nq=windows+label:bug+language:python+state:open&sort=created&order=asc
This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.
Note
\n\nFor requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"
Gets a team using the team's slug. To create the slug, GitHub Enterprise Server replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a - separator. For example, \"My TEam Näme\" would become my-team-name.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
Gets a team using the team's slug. To create the slug, GitHub Enterprise Server replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a - separator. For example, \"My TEam Näme\" would become my-team-name.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
To edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}.
To edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}.
To delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}.
To delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}.
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nLists a team's repositories visible to the authenticated user.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos.
Lists a team's repositories visible to the authenticated user.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos.
Checks whether a team has admin, push, maintain, triage, or pull permission for a repository. Repositories inherited through a parent team will also be checked.
You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the application/vnd.github.v3.repository+json accept header.
If a team doesn't have permission for the repository, you will receive a 404 Not Found response status.
If the repository is private, you must have at least read permission for that repository, and your token must have the repo or admin:org scope. Otherwise, you will receive a 404 Not Found response status.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
Checks whether a team has admin, push, maintain, triage, or pull permission for a repository. Repositories inherited through a parent team will also be checked.
You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the application/vnd.github.v3.repository+json accept header.
If a team doesn't have permission for the repository, you will receive a 404 Not Found response status.
If the repository is private, you must have at least read permission for that repository, and your token must have the repo or admin:org scope. Otherwise, you will receive a 404 Not Found response status.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Note
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
For more information about the permission levels, see \"Repository permission levels for an organization\".
", + "descriptionHTML": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Note
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
For more information about the permission levels, see \"Repository permission levels for an organization\".
", "statusCodes": [ { "httpStatusCode": "204", @@ -523739,7 +523739,7 @@ } ], "previews": [], - "descriptionHTML": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
Lists the child teams of the team specified by {team_slug}.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.
Lists the child teams of the team specified by {team_slug}.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the Get a team by name endpoint.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the Get a team by name endpoint.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a team endpoint.
\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote
\n\nWith nested teams, the privacy for parent teams cannot be secret.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a team endpoint.
\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote
\n\nWith nested teams, the privacy for parent teams cannot be secret.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a team endpoint.
\nTo delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
", + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a team endpoint.
\nTo delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
", "statusCodes": [ { "httpStatusCode": "204", @@ -526746,7 +526746,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team repositories endpoint.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team repositories endpoint.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a repository endpoint.
\nNote
\n\nRepositories inherited through a parent team will also be checked.
\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a repository endpoint.
\nNote
\n\nRepositories inherited through a parent team will also be checked.
\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Add or update team repository permissions\" endpoint.
\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization.
Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Add or update team repository permissions\" endpoint.
\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization.
Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a repository from a team endpoint.
\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.
", + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a repository from a team endpoint.
\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.
", "statusCodes": [ { "httpStatusCode": "204", @@ -529815,7 +529815,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List child teams endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List child teams endpoint.
List all comments on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
List all comments on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Creates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Creates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Get a specific comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Get a specific comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Edits the body text of a discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Edits the body text of a discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Deletes a comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Deletes a comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion comments endpoint.
\nList all comments on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion comments endpoint.
\nList all comments on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.
\nCreates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.
\nCreates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion comment endpoint.
\nGet a specific comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion comment endpoint.
\nGet a specific comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.
\nEdits the body text of a discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.
\nEdits the body text of a discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion comment endpoint.
\nDeletes a comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion comment endpoint.
\nDeletes a comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
List all discussions on a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
List all discussions on a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Get a specific discussion on a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Get a specific discussion on a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Edits the title and body text of a discussion post. Only the parameters you provide are updated.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Edits the title and body text of a discussion post. Only the parameters you provide are updated.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Delete a discussion from a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Delete a discussion from a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.
List all discussions on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.
List all discussions on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.
Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.
Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion endpoint.
\nGet a specific discussion on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion endpoint.
\nGet a specific discussion on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion endpoint.
\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion endpoint.
\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion endpoint.
Delete a discussion from a team's page.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion endpoint.
Delete a discussion from a team's page.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note
\n\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note
\n\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}.
Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}.
To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}.
To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members endpoint.
Team members will include the members of child teams.
", + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members endpoint.
Team members will include the members of child teams.
", "statusCodes": [ { "httpStatusCode": "200", @@ -540119,7 +540119,7 @@ } ], "previews": [], - "descriptionHTML": "The \"Add team member\" endpoint (described below) is closing down.
\nWe recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
The \"Add team member\" endpoint (described below) is closing down.
\nWe recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
The \"Remove team member\" endpoint (described below) is closing down.
\nWe recommend using the Remove team membership for a user endpoint instead. It allows you to remove both active and pending memberships.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nThe \"Remove team member\" endpoint (described below) is closing down.
\nWe recommend using the Remove team membership for a user endpoint instead. It allows you to remove both active and pending memberships.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership for a user endpoint.
\nTeam members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership for a user endpoint.
\nTeam members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
", + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
", "statusCodes": [ { "httpStatusCode": "200", @@ -540477,7 +540477,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nSpecifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.
Note
\n\nThe patterns_allowed setting only applies to public repositories.
Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"Using environments for deployment.\"
\nNote
\n\nGitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"Using environments for deployment.\"
\nNote
\n\nGitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Note
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nIf you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. Optional: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nIf you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. Optional: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nThis is the user's organization dashboard. You must be authenticated as the user to view this.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nThis is the user's organization dashboard. You must be authenticated as the user to view this.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nThese are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nThese are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nLists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.
\nuri_template. For more information, see \"Hypermedia.\"By default, timeline resources are returned in JSON. You can specify the application/atom+xml type in the Accept header to return timeline resources in Atom format. For more information, see \"Media types.\"
Note
\n\nPrivate feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
\nLists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.
\nuri_template. For more information, see \"Hypermedia.\"By default, timeline resources are returned in JSON. You can specify the application/atom+xml type in the Accept header to return timeline resources in Atom format. For more information, see \"Media types.\"
Note
\n\nPrivate feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
\nNote
\n\nThe :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).
Note
\n\nThe :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).
Renames a branch in a repository.
\nNote
\n\nAlthough the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".
\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.
\nIn order to rename the default branch, fine-grained access tokens also need the administration:write repository permission.
Renames a branch in a repository.
\nNote
\n\nAlthough the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".
\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.
\nIn order to rename the default branch, fine-grained access tokens also need the administration:write repository permission.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nProtecting a branch requires admin or owner permissions to the repository.
\nNote
\n\nPassing new arrays of users and teams replaces their previous values.
Note
\n\nThe list of users, apps, and teams in total is limited to 100 items.
\nProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nProtecting a branch requires admin or owner permissions to the repository.
\nNote
\n\nPassing new arrays of users and teams replaces their previous values.
Note
\n\nThe list of users, apps, and teams in total is limited to 100 items.
\nProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
\nNote
\n\nPassing new arrays of users and teams replaces their previous values.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
\nNote
\n\nPassing new arrays of users and teams replaces their previous values.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.
Note
\n\nYou must enable branch protection to require signed commits.
\nProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.
Note
\n\nYou must enable branch protection to require signed commits.
\nProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists who has access to this protected branch.
\nNote
\n\nUsers, apps, and teams restrictions are only available for organization-owned repositories.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists who has access to this protected branch.
\nNote
\n\nUsers, apps, and teams restrictions are only available for organization-owned repositories.
Creates a new check run for a specific commit in a repository.
\nTo create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.
\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
\nNote
\n\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Creates a new check run for a specific commit in a repository.
\nTo create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.
\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
\nNote
\n\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
Gets a single check run using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Gets a single check run using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Updates a check run for a specific commit in a repository.
\nNote
\n\nThe 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.
OAuth apps and personal access tokens (classic) cannot use this endpoint.
", + "descriptionHTML": "Updates a check run for a specific commit in a repository.
\nNote
\n\nThe 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.
OAuth apps and personal access tokens (classic) cannot use this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -142403,7 +142403,7 @@ } ], "previews": [], - "descriptionHTML": "Lists check runs for a check suite using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check runs for a check suite using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name.
Note
\n\nThe 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 endpoint and provide the check_suite_id parameter to the List check runs in a check suite endpoint.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name.
Note
\n\nThe 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 endpoint and provide the check_suite_id parameter to the List check runs in a check suite endpoint.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Creates a check suite manually. By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"Update repository preferences for check suites\".
\nNote
\n\nThe 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.
OAuth apps and personal access tokens (classic) cannot use this endpoint.
", + "descriptionHTML": "Creates a check suite manually. By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"Update repository preferences for check suites\".
\nNote
\n\nThe 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.
OAuth apps and personal access tokens (classic) cannot use this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -150924,7 +150924,7 @@ } ], "previews": [], - "descriptionHTML": "Gets a single check suite using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Gets a single check suite using its id.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name.
Note
\n\nThe 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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.
The rules_count field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.
Warning
\n\nClosing down notice: The tool_name field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.
OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.
The rules_count field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.
Warning
\n\nClosing down notice: The tool_name field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.
OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Lists all code security configurations available in an enterprise.
\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.
Note
\n\nThe enablement status will only be returned for installed security products.
\nLists all code security configurations available in an enterprise.
\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.
Note
\n\nThe enablement status will only be returned for installed security products.
\nCreates a code security configuration in an enterprise.
\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Note
\n\nOnly installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error.
\nCreates a code security configuration in an enterprise.
\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Note
\n\nOnly installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error.
\nGets a code security configuration available in an enterprise.
\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.
Note
\n\nAny security products that are not installed will report an unset status.
Gets a code security configuration available in an enterprise.
\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.
Note
\n\nAny security products that are not installed will report an unset status.
Updates a code security configuration in an enterprise.
\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Note
\n\nThe enablement status will only be returned for installed security products.
\nUpdates a code security configuration in an enterprise.
\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Note
\n\nThe enablement status will only be returned for installed security products.
\nLists all code security configurations available in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nThe enablement status will only be returned for installed security products.
\nLists all code security configurations available in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nThe enablement status will only be returned for installed security products.
\nCreates a code security configuration in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nOnly installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error.
\nCreates a code security configuration in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nOnly installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error.
\nLists the default code security configurations for an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nNote
\n\nThe enablement status will only be returned for installed security products.
\nLists the default code security configurations for an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nNote
\n\nThe enablement status will only be returned for installed security products.
\nGets a code security configuration available in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nThe enablement status will only be returned for installed security products.
\nGets a code security configuration available in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nThe enablement status will only be returned for installed security products.
\nUpdates a code security configuration in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nOnly installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error.
\nUpdates a code security configuration in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nOnly installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error.
\nSets a code security configuration as a default to be applied to new repositories in your organization.
\nThis configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nThe enablement status will only be returned for installed security products.
\nSets a code security configuration as a default to be applied to new repositories in your organization.
\nThis configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Note
\n\nThe enablement status will only be returned for installed security products.
\nRemoves a collaborator from a repository.
\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.
\nThis endpoint also:
\nRemoving a user as a collaborator has the following effects on forks:
\nNote
\n\nA user can still have access to the repository through organization permissions like base repository permissions.
\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.
\nFor more information on fork permissions, see \"About permissions and visibility of forks\".
", + "descriptionHTML": "Removes a collaborator from a repository.
\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.
\nThis endpoint also:
\nRemoving a user as a collaborator has the following effects on forks:
\nNote
\n\nA user can still have access to the repository through organization permissions like base repository permissions.
\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.
\nFor more information on fork permissions, see \"About permissions and visibility of forks\".
", "statusCodes": [ { "httpStatusCode": "204", @@ -180122,7 +180122,7 @@ } ], "previews": [], - "descriptionHTML": "Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.
Note
\n\nIf there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\" Pagination query parameters are not supported for these media types.
\napplication/vnd.github.diff: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property. Larger diffs may time out and return a 5xx status code.application/vnd.github.sha: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
verified_at | string | The date the signature was verified by GitHub. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on their account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.
Note
\n\nIf there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\" Pagination query parameters are not supported for these media types.
\napplication/vnd.github.diff: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property. Larger diffs may time out and return a 5xx status code.application/vnd.github.sha: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
verified_at | string | The date the signature was verified by GitHub. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on their account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Note
\n\nTo get information about name patterns that branches must match in order to deploy to this environment, see \"Get a deployment branch policy.\"
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Note
\n\nTo get information about name patterns that branches must match in order to deploy to this environment, see \"Get a deployment branch policy.\"
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"Environments.\"
\nNote
\n\nTo create or update name patterns that branches must match in order to deploy to this environment, see \"Deployment branch policies.\"
\nNote
\n\nTo create or update secrets for an environment, see \"GitHub Actions secrets.\"
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"Environments.\"
\nNote
\n\nTo create or update name patterns that branches must match in order to deploy to this environment, see \"Deployment branch policies.\"
\nNote
\n\nTo create or update secrets for an environment, see \"GitHub Actions secrets.\"
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment.
\nNote
\n\nIt's recommended to use the log_url parameter, which replaces target_url.
The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment.
\nNote
\n\nIt's recommended to use the log_url parameter, which replaces target_url.
Warning
\n\nClosing down notice: The ability to fetch code security and analysis settings for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.
\nGets code security and analysis settings for the specified enterprise.
\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.
Warning
\n\nClosing down notice: The ability to fetch code security and analysis settings for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.
\nGets code security and analysis settings for the specified enterprise.
\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.
Warning
\n\nClosing down notice: The ability to update code security and analysis settings for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.
\nUpdates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise.
\nThe authenticated user must be an administrator of the enterprise to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Warning
\n\nClosing down notice: The ability to update code security and analysis settings for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.
\nUpdates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise.
\nThe authenticated user must be an administrator of the enterprise to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Warning
\n\nClosing down notice: The ability to enable or disable a security feature for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.
\nEnables or disables the specified security feature for all repositories in an enterprise.
\nThe authenticated user must be an administrator of the enterprise to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Warning
\n\nClosing down notice: The ability to enable or disable a security feature for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.
\nEnables or disables the specified security feature for all repositories in an enterprise.
\nThe authenticated user must be an administrator of the enterprise to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.
\nImportant
\n\nTo start the configuration process and apply the license, you need to POST to /manage/v1/config/apply
The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.
\nNote
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.
\nImportant
\n\nTo start the configuration process and apply the license, you need to POST to /manage/v1/config/apply
The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.
\nNote
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
Uploads a new enterprise license. In order to apply it right away, use the apply query parameter.
Note
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
Uploads a new enterprise license. In order to apply it right away, use the apply query parameter.
Note
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nLists provisioned SCIM groups in an enterprise.
\nYou can improve query search time by using the excludedAttributes query parameter with a value of members to exclude members from the response.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nLists provisioned SCIM groups in an enterprise.
\nYou can improve query search time by using the excludedAttributes query parameter with a value of members to exclude members from the response.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nCreates a SCIM group for an enterprise.
\nIf members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the externalId and id of each user.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nCreates a SCIM group for an enterprise.
\nIf members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the externalId and id of each user.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nGets information about a SCIM group.
", + "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nGets information about a SCIM group.
", "statusCodes": [ { "httpStatusCode": "200", @@ -221181,7 +221181,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nReplaces an existing provisioned group’s information.
\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the Update an attribute for a SCIM enterprise group endpoint instead.
", + "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nReplaces an existing provisioned group’s information.
\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the Update an attribute for a SCIM enterprise group endpoint instead.
", "statusCodes": [ { "httpStatusCode": "200", @@ -221728,7 +221728,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nUpdate a provisioned group’s individual attributes.
\nTo change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification. Update can also be used to add group memberships.
\nGroup memberships can be sent one at a time or in batches for faster performance. Note: The memberships are referenced through a local user id, and the user will need to be created before they are referenced here.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nUpdate a provisioned group’s individual attributes.
\nTo change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification. Update can also be used to add group memberships.
\nGroup memberships can be sent one at a time or in batches for faster performance. Note: The memberships are referenced through a local user id, and the user will need to be created before they are referenced here.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nDeletes a SCIM group from an enterprise.
", + "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nDeletes a SCIM group from an enterprise.
", "statusCodes": [ { "httpStatusCode": "204", @@ -222283,7 +222283,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nLists provisioned SCIM enterprise members.
\nWhen a user with a SCIM-provisioned external identity is removed from an enterprise through a patch with active flag set to false, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the delete request. Users that were not permanently deleted will be visible in the returned results.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nLists provisioned SCIM enterprise members.
\nWhen a user with a SCIM-provisioned external identity is removed from an enterprise through a patch with active flag set to false, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the delete request. Users that were not permanently deleted will be visible in the returned results.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nCreates an external identity for a new SCIM enterprise user.
\nSCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response NameID to SCIM userName.
When converting existing enterprise to use SCIM, the user handle (userName) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nCreates an external identity for a new SCIM enterprise user.
\nSCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response NameID to SCIM userName.
When converting existing enterprise to use SCIM, the user handle (userName) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nGets information about a SCIM user.
", + "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nGets information about a SCIM user.
", "statusCodes": [ { "httpStatusCode": "200", @@ -224018,7 +224018,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nReplaces an existing provisioned user's information.
\nYou must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the Update an attribute for a SCIM user endpoint instead.
\nWarning
\n\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nReplaces an existing provisioned user's information.
\nYou must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the Update an attribute for a SCIM user endpoint instead.
\nWarning
\n\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.
Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nUpdate a provisioned user's individual attributes.
\nTo change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.
Note
\n\nComplicated SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will not work.
Warning
\n\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.
{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\nNote
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nUpdate a provisioned user's individual attributes.
\nTo change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.
Note
\n\nComplicated SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will not work.
Warning
\n\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.
{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\nNote
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nPermanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action.
", + "descriptionHTML": "Note
\n\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.
\nPermanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action.
", "statusCodes": [ { "httpStatusCode": "204", @@ -231127,7 +231127,7 @@ } ], "previews": [], - "descriptionHTML": "Allows you to add a new gist with one or more files.
\nNote
\n\nDon't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.
\nAllows you to add a new gist with one or more files.
\nNote
\n\nDon't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.
\nReturns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.
When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.
Note
\n\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nIf you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.
Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.
When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.
Note
\n\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nIf you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.
Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.
Note
\n\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nReturns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.
Note
\n\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nReturns a single tree using the SHA1 value or ref name for that tree.
\nIf truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.
Note
\n\nThe limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
Returns a single tree using the SHA1 value or ref name for that tree.
\nIf truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.
Note
\n\nThe limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.
Note
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.
Note
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues in an organization assigned to the authenticated user.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues in an organization assigned to the authenticated user.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues in a repository. Only open issues will be listed.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues in a repository. Only open issues will be listed.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.
Note
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.
Note
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues across owned and member repositories assigned to the authenticated user.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.List issues across owned and member repositories assigned to the authenticated user.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return [\"repo\", \"user\"].
Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return [\"repo\", \"user\"].
Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on the application authorizations settings screen within GitHub.
", + "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on the application authorizations settings screen within GitHub.
", "statusCodes": [ { "httpStatusCode": "204", @@ -335419,7 +335419,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nCreates OAuth tokens using Basic Authentication. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use fingerprint to differentiate between them.
You can also create tokens on GitHub Enterprise Server from the personal access tokens settings page. Read more about these tokens in the GitHub Help documentation.
\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see \"About identity and access management with SAML single sign-on\" in the GitHub Enterprise Cloud documentation.
", + "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nCreates OAuth tokens using Basic Authentication. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use fingerprint to differentiate between them.
You can also create tokens on GitHub Enterprise Server from the personal access tokens settings page. Read more about these tokens in the GitHub Help documentation.
\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see \"About identity and access management with SAML single sign-on\" in the GitHub Enterprise Cloud documentation.
", "statusCodes": [ { "httpStatusCode": "201", @@ -337544,7 +337544,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nCreates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
", + "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nCreates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -338501,7 +338501,7 @@ }, { "httpStatusCode": "201", - "description": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nThis method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. fingerprint is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
", + "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nApps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nThis method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. fingerprint is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -341530,7 +341530,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nYou can only send one of these scope keys at a time.
", + "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nYou can only send one of these scope keys at a time.
", "statusCodes": [ { "httpStatusCode": "200", @@ -342638,7 +342638,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nLists all organizations, in the order that they were created.
\nNote
\n\nPagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
Lists all organizations, in the order that they were created.
\nNote
\n\nPagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
Warning
\n\nClosing down notice: GitHub Enterprise Server will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.
Warning
\n\nClosing down notice: Code security product enablement for new repositories through the organization API is closing down and will be replaced with code security configurations in a future GitHub Enterprise Server version.
\nUpdates the organization's profile and member privileges.
\nThe authenticated user must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Warning
\n\nClosing down notice: GitHub Enterprise Server will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.
Warning
\n\nClosing down notice: Code security product enablement for new repositories through the organization API is closing down and will be replaced with code security configurations in a future GitHub Enterprise Server version.
\nUpdates the organization's profile and member privileges.
\nThe authenticated user must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Warning
\n\nClosing down notice: The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use code security configurations instead. For more information, see the changelog.
\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"Managing security managers in your organization.\"
\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org, write:org, or repo scopes to use this endpoint.
Warning
\n\nClosing down notice: The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use code security configurations instead. For more information, see the changelog.
\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"Managing security managers in your organization.\"
\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org, write:org, or repo scopes to use this endpoint.
List organizations for the authenticated user.
\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a 403 Forbidden response.
Note
\n\nRequests using a fine-grained access token will receive a 200 Success response with an empty list.
List organizations for the authenticated user.
\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a 403 Forbidden response.
Note
\n\nRequests using a fine-grained access token will receive a 200 Success response with an empty list.
Warning
\n\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.
\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Warning
\n\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.
\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Warning
\n\nClosing down notice: This operation is closing down and will be removed in Enterprise Server 3.20. Please use the \"Organization Roles\" endpoints instead.
\nWarning
\n\nClosing down notice: This operation is closing down and will be removed in Enterprise Server 3.20. Please use the \"Organization Roles\" endpoints instead.
\nWarning
\n\nClosing down notice: This operation is closing down and will be removed in Enterprise Server 3.20. Please use the \"Organization Roles\" endpoints instead.
\nWarning
\n\nClosing down notice: This operation is closing down and will be removed in Enterprise Server 3.20. Please use the \"Organization Roles\" endpoints instead.
\nWarning
\n\nClosing down notice: This operation is closing down and will be removed in Enterprise Server 3.20. Please use the \"Organization Roles\" endpoints instead.
\nWarning
\n\nClosing down notice: This operation is closing down and will be removed in Enterprise Server 3.20. Please use the \"Organization Roles\" endpoints instead.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nLists the files in a specified pull request.
\nNote
\n\nResponses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Lists the files in a specified pull request.
\nNote
\n\nResponses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Creates a review on a specified pull request.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note
\n\nTo comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the application/vnd.github.v3.diff media type to the Accept header of a call to the Get a pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Creates a review on a specified pull request.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note
\n\nTo comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the application/vnd.github.v3.diff media type to the Accept header of a call to the Get a pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Dismisses a specified review on a pull request.
\nNote
\n\nTo dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Dismisses a specified review on a pull request.
\nNote
\n\nTo dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Note
\n\nAccessing this endpoint does not count against your REST API rate limit.
\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under resources, you'll see objects relating to different categories:
core object provides your rate limit status for all non-search-related resources in the REST API.search object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"Search.\"code_search object provides your rate limit status for the REST API for searching code. For more information, see \"Search code.\"graphql object provides your rate limit status for the GraphQL API. For more information, see \"Resource limitations.\"integration_manifest object provides your rate limit status for the POST /app-manifests/{code}/conversions operation. For more information, see \"Creating a GitHub App from a manifest.\"dependency_snapshots object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"Dependency graph.\"dependency_sbom object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"Dependency graph.\"code_scanning_upload object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"Uploading a SARIF file to GitHub.\"actions_runner_registration object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"Self-hosted runners.\"source_import object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"API Versions.\"Note
\n\nThe rate object is closing down. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.
Note
\n\nAccessing this endpoint does not count against your REST API rate limit.
\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under resources, you'll see objects relating to different categories:
core object provides your rate limit status for all non-search-related resources in the REST API.search object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"Search.\"code_search object provides your rate limit status for the REST API for searching code. For more information, see \"Search code.\"graphql object provides your rate limit status for the GraphQL API. For more information, see \"Resource limitations.\"integration_manifest object provides your rate limit status for the POST /app-manifests/{code}/conversions operation. For more information, see \"Creating a GitHub App from a manifest.\"dependency_snapshots object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"Dependency graph.\"dependency_sbom object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"Dependency graph.\"code_scanning_upload object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"Uploading a SARIF file to GitHub.\"actions_runner_registration object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"Self-hosted runners.\"source_import object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"API Versions.\"Note
\n\nThe rate object is closing down. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.
List the reactions to a team discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
List the reactions to a team discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Create a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Create a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
List the reactions to a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
List the reactions to a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Create a reaction to a team discussion.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Create a reaction to a team discussion.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -438764,7 +438764,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -439853,7 +439853,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", "statusCodes": [ { "httpStatusCode": "204", @@ -440941,7 +440941,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "204", @@ -442012,7 +442012,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", "statusCodes": [ { "httpStatusCode": "204", @@ -442370,7 +442370,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Gets a public release with the specified release ID.
\nNote
\n\nThis returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"Getting started with the REST API.\"
Gets a public release with the specified release ID.
\nNote
\n\nThis returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"Getting started with the REST API.\"
Lists repositories for the specified organization.
\nNote
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
Lists repositories for the specified organization.
\nNote
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.
Note
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.
Note
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
Creates a new file or replaces an existing file in a repository.
\nNote
\n\nIf you use this endpoint and the \"Delete a file\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. The workflow scope is also required in order to modify files in the .github/workflows directory.
Creates a new file or replaces an existing file in a repository.
\nNote
\n\nIf you use this endpoint and the \"Delete a file\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. The workflow scope is also required in order to modify files in the .github/workflows directory.
Deletes a file in a repository.
\nYou can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.
The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.
You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.
Note
\n\nIf you use this endpoint and the \"Create or update file contents\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
\nDeletes a file in a repository.
\nYou can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.
The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.
You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.
Note
\n\nIf you use this endpoint and the \"Create or update file contents\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
\nGets a redirect URL to download a tar archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes.
\nGets a redirect URL to download a tar archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes.
\nGets a redirect URL to download a zip archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.
\nGets a redirect URL to download a zip archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.
\nCreate a fork for the authenticated user.
\nNote
\n\nForking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub Enterprise Server Support.
\nNote
\n\nAlthough this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.
\nCreate a fork for the authenticated user.
\nNote
\n\nForking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub Enterprise Server Support.
\nNote
\n\nAlthough this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.
\nWarning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis returns the tag protection states of a repository.
\nThis information is only available to repository administrators.
", + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis returns the tag protection states of a repository.
\nThis information is only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "200", @@ -502809,7 +502809,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "201", @@ -502891,7 +502891,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after August 30, 2024. Use the \"Repository Rulesets\" endpoint instead.
\nThis deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "204", @@ -505319,7 +505319,7 @@ } ], "previews": [], - "descriptionHTML": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook is not subscribed to push events, the server will respond with 204 but no test POST will be generated.
Note
\n\nPreviously /repos/:owner/:repo/hooks/:hook_id/test
This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook is not subscribed to push events, the server will respond with 204 but no test POST will be generated.
Note
\n\nPreviously /repos/:owner/:repo/hooks/:hook_id/test
Warning
\n\nNotice: Search for issues and pull requests will be overridden by advanced search on September 4, 2025.\nYou can read more about this change on the GitHub blog.
\nWarning
\n\nNotice: Search for issues and pull requests will be overridden by advanced search on September 4, 2025.\nYou can read more about this change on the GitHub blog.
\nGets a team using the team's slug. To create the slug, GitHub Enterprise Server replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a - separator. For example, \"My TEam Näme\" would become my-team-name.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
Gets a team using the team's slug. To create the slug, GitHub Enterprise Server replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a - separator. For example, \"My TEam Näme\" would become my-team-name.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
To edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}.
To edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}.
To delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}.
To delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}.
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nLists a team's repositories visible to the authenticated user.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos.
Lists a team's repositories visible to the authenticated user.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos.
Checks whether a team has admin, push, maintain, triage, or pull permission for a repository. Repositories inherited through a parent team will also be checked.
You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the application/vnd.github.v3.repository+json accept header.
If a team doesn't have permission for the repository, you will receive a 404 Not Found response status.
If the repository is private, you must have at least read permission for that repository, and your token must have the repo or admin:org scope. Otherwise, you will receive a 404 Not Found response status.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
Checks whether a team has admin, push, maintain, triage, or pull permission for a repository. Repositories inherited through a parent team will also be checked.
You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the application/vnd.github.v3.repository+json accept header.
If a team doesn't have permission for the repository, you will receive a 404 Not Found response status.
If the repository is private, you must have at least read permission for that repository, and your token must have the repo or admin:org scope. Otherwise, you will receive a 404 Not Found response status.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Note
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
For more information about the permission levels, see \"Repository permission levels for an organization\".
", + "descriptionHTML": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Note
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
For more information about the permission levels, see \"Repository permission levels for an organization\".
", "statusCodes": [ { "httpStatusCode": "204", @@ -529552,7 +529552,7 @@ } ], "previews": [], - "descriptionHTML": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
Lists the child teams of the team specified by {team_slug}.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.
Lists the child teams of the team specified by {team_slug}.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the Get a team by name endpoint.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the Get a team by name endpoint.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a team endpoint.
\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote
\n\nWith nested teams, the privacy for parent teams cannot be secret.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a team endpoint.
\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote
\n\nWith nested teams, the privacy for parent teams cannot be secret.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a team endpoint.
\nTo delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
", + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a team endpoint.
\nTo delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
", "statusCodes": [ { "httpStatusCode": "204", @@ -532559,7 +532559,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team repositories endpoint.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team repositories endpoint.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a repository endpoint.
\nNote
\n\nRepositories inherited through a parent team will also be checked.
\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a repository endpoint.
\nNote
\n\nRepositories inherited through a parent team will also be checked.
\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Add or update team repository permissions\" endpoint.
\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization.
Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Add or update team repository permissions\" endpoint.
\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization.
Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a repository from a team endpoint.
\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.
", + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a repository from a team endpoint.
\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.
", "statusCodes": [ { "httpStatusCode": "204", @@ -535640,7 +535640,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List child teams endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List child teams endpoint.
List all comments on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
List all comments on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Creates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Creates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Get a specific comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Get a specific comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Edits the body text of a discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Edits the body text of a discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Deletes a comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Deletes a comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion comments endpoint.
\nList all comments on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion comments endpoint.
\nList all comments on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.
\nCreates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.
\nCreates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion comment endpoint.
\nGet a specific comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion comment endpoint.
\nGet a specific comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.
\nEdits the body text of a discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.
\nEdits the body text of a discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion comment endpoint.
\nDeletes a comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion comment endpoint.
\nDeletes a comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
List all discussions on a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
List all discussions on a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Get a specific discussion on a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Get a specific discussion on a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Edits the title and body text of a discussion post. Only the parameters you provide are updated.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Edits the title and body text of a discussion post. Only the parameters you provide are updated.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Delete a discussion from a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Delete a discussion from a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.
List all discussions on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.
List all discussions on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.
Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.
Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion endpoint.
\nGet a specific discussion on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion endpoint.
\nGet a specific discussion on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion endpoint.
\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion endpoint.
\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion endpoint.
Delete a discussion from a team's page.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion endpoint.
Delete a discussion from a team's page.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note
\n\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note
\n\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}.
Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}.
To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}.
To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members endpoint.
Team members will include the members of child teams.
", + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members endpoint.
Team members will include the members of child teams.
", "statusCodes": [ { "httpStatusCode": "200", @@ -545944,7 +545944,7 @@ } ], "previews": [], - "descriptionHTML": "The \"Add team member\" endpoint (described below) is closing down.
\nWe recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
The \"Add team member\" endpoint (described below) is closing down.
\nWe recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
The \"Remove team member\" endpoint (described below) is closing down.
\nWe recommend using the Remove team membership for a user endpoint instead. It allows you to remove both active and pending memberships.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nThe \"Remove team member\" endpoint (described below) is closing down.
\nWe recommend using the Remove team membership for a user endpoint instead. It allows you to remove both active and pending memberships.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership for a user endpoint.
\nTeam members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership for a user endpoint.
\nTeam members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
", + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
", "statusCodes": [ { "httpStatusCode": "200", @@ -546302,7 +546302,7 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nA check run was completed, and a conclusion is available.
", - "summaryHtml": "This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
A new check run was created.
", - "summaryHtml": "This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the requested_action payload. For more information, see \"Creating CI tests with the Checks API.\"
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the rerequested payload.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
All check runs in a check suite have completed, and a conclusion is available.
", - "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see the GraphQL API documentation for creating a check run or \"Create a check run\" in the REST API documentation.
", - "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
Someone requested to re-run the check runs in a check suite. For more information, see the GraphQL API documentation for creating a check suite or \"Create a check suite\" in the REST API documentation.
", - "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
The commit comment resource.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "The text of the comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "The SHA of the commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "The ID of the commit comment.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "The node ID of the commit comment.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "path", - "description": "The relative path of the file to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "The line index in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -13878,7 +13603,7 @@ "delete": { "default": { "descriptionHtml": "", - "summaryHtml": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the push webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\n\nThis event will not occur when more than three tags are deleted at once.
\nThis event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the push webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\n\nThis event will not occur when more than three tags are deleted at once.
\nA Dependabot alert was automatically closed by a Dependabot auto-triage rule.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThe vulnerable dependency's relationship to your project.
\nNote
\n\nWe are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.
\nThe vulnerable dependency's relationship to your project.
\nNote
\n\nWe are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.
\nA Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThe vulnerable dependency's relationship to your project.
\nNote
\n\nWe are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.
\nThe vulnerable dependency's relationship to your project.
\nNote
\n\nWe are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.
\nA manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThe vulnerable dependency's relationship to your project.
\nNote
\n\nWe are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.
\nThe vulnerable dependency's relationship to your project.
\nNote
\n\nWe are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.
\nA Dependabot alert was manually closed.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThe vulnerable dependency's relationship to your project.
\nNote
\n\nWe are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.
\nThe vulnerable dependency's relationship to your project.
\nNote
\n\nWe are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.
\nA manifest file change removed a vulnerability.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThe vulnerable dependency's relationship to your project.
\nNote
\n\nWe are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.
\nThe vulnerable dependency's relationship to your project.
\nNote
\n\nWe are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.
\nA manifest file change introduced a vulnerable dependency that had previously been fixed.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThe vulnerable dependency's relationship to your project.
\nNote
\n\nWe are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.
\nThe vulnerable dependency's relationship to your project.
\nNote
\n\nWe are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.
\nA Dependabot alert was manually reopened.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThe vulnerable dependency's relationship to your project.
\nNote
\n\nWe are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.
\nThe vulnerable dependency's relationship to your project.
\nNote
\n\nWe are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.
\nA new deployment status was created.
", - "summaryHtml": "This event occurs when there is activity relating to deployment statuses. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.
\nFor activity relating to deployment creation, use the deployment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
\n\nA webhook event is not fired for deployment statuses with an inactive state.
This event occurs when there is activity relating to deployment statuses. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.
\nFor activity relating to deployment creation, use the deployment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
\n\nA webhook event is not fired for deployment statuses with an inactive state.
A comment on the discussion was marked as the answer.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThe category of a discussion was changed.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was closed.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was created.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThe title or body on a discussion was edited, or the category of the discussion was changed.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA label was added to a discussion.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was locked.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was pinned.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was reopened.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was transferred to another repository.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA comment on the discussion was unmarked as the answer.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA label was removed from a discussion.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was unlocked.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was unpinned.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA comment on a discussion was created.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nHow the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "discussion_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "parent_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -45961,7 +45418,7 @@ }, "deleted": { "descriptionHtml": "A comment on a discussion was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nHow the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "discussion_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "parent_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -46873,7 +46060,7 @@ }, "edited": { "descriptionHtml": "A comment on a discussion was edited.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nHow the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "discussion_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "parent_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -50225,271 +49142,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "Contents of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the issue comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -51445,382 +50098,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "Contents of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_github_app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the GitHub app
", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "The slug name of the GitHub app
" - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "client_id", - "description": "" - }, - { - "type": "object", - "name": "owner", - "description": "A GitHub user.
", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "The name of the GitHub app
", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "The set of permissions for the GitHub app
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "issues", - "description": "" - }, - { - "type": "string", - "name": "checks", - "description": "" - }, - { - "type": "string", - "name": "metadata", - "description": "" - }, - { - "type": "string", - "name": "contents", - "description": "" - }, - { - "type": "string", - "name": "deployments", - "description": "" - } - ] - }, - { - "type": "array of strings", - "name": "events", - "description": "The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the issue comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -52798,382 +51076,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "Contents of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_github_app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the GitHub app
", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "The slug name of the GitHub app
" - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "client_id", - "description": "" - }, - { - "type": "object", - "name": "owner", - "description": "A GitHub user.
", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "The name of the GitHub app
", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "The set of permissions for the GitHub app
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "issues", - "description": "" - }, - { - "type": "string", - "name": "checks", - "description": "" - }, - { - "type": "string", - "name": "metadata", - "description": "" - }, - { - "type": "string", - "name": "contents", - "description": "" - }, - { - "type": "string", - "name": "deployments", - "description": "" - } - ] - }, - { - "type": "array of strings", - "name": "events", - "description": "The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the issue comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -98921,7 +96824,7 @@ "projects_v2": { "closed": { "descriptionHtml": "A project in the organization was closed.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA project in the organization was created.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA project in the organization was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe title, description, or README of a project in the organization was changed.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA project in the organization was reopened.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nAn item on an organization project was archived. For more information, see \"Archiving items from your project.\"
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA draft issue in an organization project was converted to an issue.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nAn item was added to a project in the organization.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nAn item was deleted from a project in the organization.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nAn archived item on an organization project was restored from the archive. For more information, see \"Archiving items from your project.\"
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA status update was added to a project in the organization.
", - "summaryHtml": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"About Projects.\"
\nFor activity relating to a project, use the projects_v2 event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nTo share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"About Projects.\"
\nFor activity relating to a project, use the projects_v2 event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nTo share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA status update was removed from a project in the organization.
", - "summaryHtml": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"About Projects.\"
\nFor activity relating to a project, use the projects_v2 event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nTo share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"About Projects.\"
\nFor activity relating to a project, use the projects_v2 event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nTo share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA status update was edited on a project in the organization.
", - "summaryHtml": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"About Projects.\"
\nFor activity relating to a project, use the projects_v2 event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nTo share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"About Projects.\"
\nFor activity relating to a project, use the projects_v2 event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nTo share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "The text of the comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "The SHA of the commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_hunk", - "description": "The diff of the line that the comment refers to.
", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "HTML URL for the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "The ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "in_reply_to_id", - "description": "The comment ID to reply to.
" - }, - { - "type": "integer or null", - "name": "line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "The node ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "original_commit_id", - "description": "The SHA of the original commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "original_line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_position", - "description": "The index of the original line in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "original_start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "The relative path of the file to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "The line index in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "pull_request_review_id", - "description": "The ID of the pull request review to which the comment belongs.
", - "isRequired": true - }, - { - "type": "string", - "name": "pull_request_url", - "description": "URL for the pull request that the review comment belongs to.
", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT" - ] - }, - { - "type": "integer or null", - "name": "start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "start_side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - { - "type": "string", - "name": "subject_type", - "description": "The level at which the comment is targeted, can be a diff line or a file.
", - "enum": [ - "line", - "file" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the pull request review comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -180005,417 +177498,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "The text of the comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "The SHA of the commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_hunk", - "description": "The diff of the line that the comment refers to.
", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "HTML URL for the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "The ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "in_reply_to_id", - "description": "The comment ID to reply to.
" - }, - { - "type": "integer or null", - "name": "line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "The node ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "original_commit_id", - "description": "The SHA of the original commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_position", - "description": "The index of the original line in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "original_start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "The relative path of the file to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "The line index in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "pull_request_review_id", - "description": "The ID of the pull request review to which the comment belongs.
", - "isRequired": true - }, - { - "type": "string", - "name": "pull_request_url", - "description": "URL for the pull request that the review comment belongs to.
", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT" - ] - }, - { - "type": "integer or null", - "name": "start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "start_side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - { - "type": "string", - "name": "subject_type", - "description": "The level at which the comment is targeted, can be a diff line or a file.
", - "enum": [ - "line", - "file" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the pull request review comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -183513,417 +180596,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "The text of the comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "The SHA of the commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_hunk", - "description": "The diff of the line that the comment refers to.
", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "HTML URL for the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "The ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "in_reply_to_id", - "description": "The comment ID to reply to.
" - }, - { - "type": "integer or null", - "name": "line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "The node ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "original_commit_id", - "description": "The SHA of the original commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_position", - "description": "The index of the original line in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "original_start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "The relative path of the file to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "The line index in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "pull_request_review_id", - "description": "The ID of the pull request review to which the comment belongs.
", - "isRequired": true - }, - { - "type": "string", - "name": "pull_request_url", - "description": "URL for the pull request that the review comment belongs to.
", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT" - ] - }, - { - "type": "integer or null", - "name": "start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "start_side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - { - "type": "string", - "name": "subject_type", - "description": "The level at which the comment is targeted, can be a diff line or a file.
", - "enum": [ - "line", - "file" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the pull request review comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -203646,7 +200319,7 @@ "push": { "default": { "descriptionHtml": "", - "summaryHtml": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the delete webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\n\nEvents will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.
\nThis event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the delete webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\n\nEvents will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.
\nA package was published to a registry.
", - "summaryHtml": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\n\nGitHub recommends that you use the newer package event instead.
This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\n\nGitHub recommends that you use the newer package event instead.
A package that was previously published to a registry was updated.
", - "summaryHtml": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\n\nGitHub recommends that you use the newer package event instead.
This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\n\nGitHub recommends that you use the newer package event instead.
A repository vulnerability alert was created.
", - "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
A repository vulnerability alert was dismissed.
", - "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
A previously dismissed or resolved repository vulnerability alert was reopened.
", - "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
A repository vulnerability alert was marked as resolved.
", - "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
A check run was completed, and a conclusion is available.
", - "summaryHtml": "This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
A new check run was created.
", - "summaryHtml": "This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the requested_action payload. For more information, see \"Creating CI tests with the Checks API.\"
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the rerequested payload.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
All check runs in a check suite have completed, and a conclusion is available.
", - "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see the GraphQL API documentation for creating a check run or \"Create a check run\" in the REST API documentation.
", - "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
Someone requested to re-run the check runs in a check suite. For more information, see the GraphQL API documentation for creating a check suite or \"Create a check suite\" in the REST API documentation.
", - "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
The commit comment resource.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "The text of the comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "The SHA of the commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "The ID of the commit comment.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "The node ID of the commit comment.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "path", - "description": "The relative path of the file to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "The line index in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -16052,7 +15777,7 @@ "delete": { "default": { "descriptionHtml": "", - "summaryHtml": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the push webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\n\nThis event will not occur when more than three tags are deleted at once.
\nThis event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the push webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\n\nThis event will not occur when more than three tags are deleted at once.
\nA Dependabot alert was automatically closed by a Dependabot auto-triage rule.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThe vulnerable dependency's relationship to your project.
\nNote
\n\nWe are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.
\nThe vulnerable dependency's relationship to your project.
\nNote
\n\nWe are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.
\nA Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThe vulnerable dependency's relationship to your project.
\nNote
\n\nWe are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.
\nThe vulnerable dependency's relationship to your project.
\nNote
\n\nWe are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.
\nA manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThe vulnerable dependency's relationship to your project.
\nNote
\n\nWe are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.
\nThe vulnerable dependency's relationship to your project.
\nNote
\n\nWe are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.
\nA Dependabot alert was manually closed.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThe vulnerable dependency's relationship to your project.
\nNote
\n\nWe are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.
\nThe vulnerable dependency's relationship to your project.
\nNote
\n\nWe are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.
\nA manifest file change removed a vulnerability.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThe vulnerable dependency's relationship to your project.
\nNote
\n\nWe are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.
\nThe vulnerable dependency's relationship to your project.
\nNote
\n\nWe are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.
\nA manifest file change introduced a vulnerable dependency that had previously been fixed.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThe vulnerable dependency's relationship to your project.
\nNote
\n\nWe are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.
\nThe vulnerable dependency's relationship to your project.
\nNote
\n\nWe are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.
\nA Dependabot alert was manually reopened.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThe vulnerable dependency's relationship to your project.
\nNote
\n\nWe are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.
\nThe vulnerable dependency's relationship to your project.
\nNote
\n\nWe are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.
\nA new deployment status was created.
", - "summaryHtml": "This event occurs when there is activity relating to deployment statuses. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.
\nFor activity relating to deployment creation, use the deployment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
\n\nA webhook event is not fired for deployment statuses with an inactive state.
This event occurs when there is activity relating to deployment statuses. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.
\nFor activity relating to deployment creation, use the deployment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
\n\nA webhook event is not fired for deployment statuses with an inactive state.
A comment on the discussion was marked as the answer.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThe category of a discussion was changed.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was closed.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was created.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThe title or body on a discussion was edited, or the category of the discussion was changed.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA label was added to a discussion.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was locked.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was pinned.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was reopened.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was transferred to another repository.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA comment on the discussion was unmarked as the answer.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA label was removed from a discussion.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was unlocked.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was unpinned.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA comment on a discussion was created.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nHow the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "discussion_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "parent_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -48135,7 +47592,7 @@ }, "deleted": { "descriptionHtml": "A comment on a discussion was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nHow the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "discussion_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "parent_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -49047,7 +48234,7 @@ }, "edited": { "descriptionHtml": "A comment on a discussion was edited.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nHow the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "discussion_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "parent_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -49984,7 +48901,7 @@ "dismissal_request_code_scanning": { "created": { "descriptionHtml": "A code scanning alert dismissal request was created.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.
\n\nDelegated alert dismissal for code scanning is currently in public preview and subject to change.
\nThis event occurs when there is activity related to a user's request to dismiss a code scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -50177,7 +49094,7 @@ }, "response_submitted": { "descriptionHtml": "A code scanning alert dismissal response was submitted.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.
\n\nDelegated alert dismissal for code scanning is currently in public preview and subject to change.
\nThis event occurs when there is activity related to a user's request to dismiss a code scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -53886,271 +52803,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "Contents of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the issue comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -55106,382 +53759,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "Contents of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_github_app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the GitHub app
", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "The slug name of the GitHub app
" - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "client_id", - "description": "" - }, - { - "type": "object", - "name": "owner", - "description": "A GitHub user.
", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "The name of the GitHub app
", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "The set of permissions for the GitHub app
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "issues", - "description": "" - }, - { - "type": "string", - "name": "checks", - "description": "" - }, - { - "type": "string", - "name": "metadata", - "description": "" - }, - { - "type": "string", - "name": "contents", - "description": "" - }, - { - "type": "string", - "name": "deployments", - "description": "" - } - ] - }, - { - "type": "array of strings", - "name": "events", - "description": "The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the issue comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -56459,382 +54737,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "Contents of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_github_app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the GitHub app
", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "The slug name of the GitHub app
" - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "client_id", - "description": "" - }, - { - "type": "object", - "name": "owner", - "description": "A GitHub user.
", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "The name of the GitHub app
", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "The set of permissions for the GitHub app
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "issues", - "description": "" - }, - { - "type": "string", - "name": "checks", - "description": "" - }, - { - "type": "string", - "name": "metadata", - "description": "" - }, - { - "type": "string", - "name": "contents", - "description": "" - }, - { - "type": "string", - "name": "deployments", - "description": "" - } - ] - }, - { - "type": "array of strings", - "name": "events", - "description": "The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the issue comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -102582,7 +100485,7 @@ "projects_v2": { "closed": { "descriptionHtml": "A project in the organization was closed.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA project in the organization was created.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA project in the organization was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe title, description, or README of a project in the organization was changed.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA project in the organization was reopened.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nAn item on an organization project was archived. For more information, see \"Archiving items from your project.\"
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA draft issue in an organization project was converted to an issue.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nAn item was added to a project in the organization.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nAn item was deleted from a project in the organization.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nAn archived item on an organization project was restored from the archive. For more information, see \"Archiving items from your project.\"
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA status update was added to a project in the organization.
", - "summaryHtml": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"About Projects.\"
\nFor activity relating to a project, use the projects_v2 event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nTo share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"About Projects.\"
\nFor activity relating to a project, use the projects_v2 event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nTo share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA status update was removed from a project in the organization.
", - "summaryHtml": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"About Projects.\"
\nFor activity relating to a project, use the projects_v2 event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nTo share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"About Projects.\"
\nFor activity relating to a project, use the projects_v2 event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nTo share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA status update was edited on a project in the organization.
", - "summaryHtml": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"About Projects.\"
\nFor activity relating to a project, use the projects_v2 event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nTo share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"About Projects.\"
\nFor activity relating to a project, use the projects_v2 event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nTo share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "The text of the comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "The SHA of the commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_hunk", - "description": "The diff of the line that the comment refers to.
", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "HTML URL for the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "The ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "in_reply_to_id", - "description": "The comment ID to reply to.
" - }, - { - "type": "integer or null", - "name": "line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "The node ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "original_commit_id", - "description": "The SHA of the original commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "original_line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_position", - "description": "The index of the original line in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "original_start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "The relative path of the file to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "The line index in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "pull_request_review_id", - "description": "The ID of the pull request review to which the comment belongs.
", - "isRequired": true - }, - { - "type": "string", - "name": "pull_request_url", - "description": "URL for the pull request that the review comment belongs to.
", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT" - ] - }, - { - "type": "integer or null", - "name": "start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "start_side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - { - "type": "string", - "name": "subject_type", - "description": "The level at which the comment is targeted, can be a diff line or a file.
", - "enum": [ - "line", - "file" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the pull request review comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -183666,417 +181159,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "The text of the comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "The SHA of the commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_hunk", - "description": "The diff of the line that the comment refers to.
", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "HTML URL for the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "The ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "in_reply_to_id", - "description": "The comment ID to reply to.
" - }, - { - "type": "integer or null", - "name": "line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "The node ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "original_commit_id", - "description": "The SHA of the original commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_position", - "description": "The index of the original line in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "original_start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "The relative path of the file to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "The line index in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "pull_request_review_id", - "description": "The ID of the pull request review to which the comment belongs.
", - "isRequired": true - }, - { - "type": "string", - "name": "pull_request_url", - "description": "URL for the pull request that the review comment belongs to.
", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT" - ] - }, - { - "type": "integer or null", - "name": "start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "start_side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - { - "type": "string", - "name": "subject_type", - "description": "The level at which the comment is targeted, can be a diff line or a file.
", - "enum": [ - "line", - "file" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the pull request review comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -187174,417 +184257,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "The text of the comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "The SHA of the commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_hunk", - "description": "The diff of the line that the comment refers to.
", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "HTML URL for the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "The ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "in_reply_to_id", - "description": "The comment ID to reply to.
" - }, - { - "type": "integer or null", - "name": "line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "The node ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "original_commit_id", - "description": "The SHA of the original commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_position", - "description": "The index of the original line in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "original_start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "The relative path of the file to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "The line index in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "pull_request_review_id", - "description": "The ID of the pull request review to which the comment belongs.
", - "isRequired": true - }, - { - "type": "string", - "name": "pull_request_url", - "description": "URL for the pull request that the review comment belongs to.
", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT" - ] - }, - { - "type": "integer or null", - "name": "start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "start_side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - { - "type": "string", - "name": "subject_type", - "description": "The level at which the comment is targeted, can be a diff line or a file.
", - "enum": [ - "line", - "file" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the pull request review comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -207307,7 +203980,7 @@ "push": { "default": { "descriptionHtml": "", - "summaryHtml": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the delete webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\n\nEvents will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.
\nThis event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the delete webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\n\nEvents will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.
\nA package was published to a registry.
", - "summaryHtml": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\n\nGitHub recommends that you use the newer package event instead.
This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\n\nGitHub recommends that you use the newer package event instead.
A package that was previously published to a registry was updated.
", - "summaryHtml": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\n\nGitHub recommends that you use the newer package event instead.
This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\n\nGitHub recommends that you use the newer package event instead.
A repository vulnerability alert was created.
", - "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
A repository vulnerability alert was dismissed.
", - "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
A previously dismissed or resolved repository vulnerability alert was reopened.
", - "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
A repository vulnerability alert was marked as resolved.
", - "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
A check run was completed, and a conclusion is available.
", - "summaryHtml": "This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
A new check run was created.
", - "summaryHtml": "This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the requested_action payload. For more information, see \"Creating CI tests with the Checks API.\"
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the rerequested payload.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
All check runs in a check suite have completed, and a conclusion is available.
", - "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see the GraphQL API documentation for creating a check run or \"Create a check run\" in the REST API documentation.
", - "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
Someone requested to re-run the check runs in a check suite. For more information, see the GraphQL API documentation for creating a check suite or \"Create a check suite\" in the REST API documentation.
", - "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
The commit comment resource.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "The text of the comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "The SHA of the commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "The ID of the commit comment.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "The node ID of the commit comment.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "path", - "description": "The relative path of the file to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "The line index in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -13082,7 +12807,7 @@ "delete": { "default": { "descriptionHtml": "", - "summaryHtml": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the push webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\n\nThis event will not occur when more than three tags are deleted at once.
\nThis event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the push webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\n\nThis event will not occur when more than three tags are deleted at once.
\nA Dependabot alert was automatically closed by a Dependabot auto-triage rule.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA Dependabot alert was manually closed.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA manifest file change removed a vulnerability.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA manifest file change introduced a vulnerable dependency that had previously been fixed.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA Dependabot alert was manually reopened.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA new deployment status was created.
", - "summaryHtml": "This event occurs when there is activity relating to deployment statuses. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.
\nFor activity relating to deployment creation, use the deployment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
\n\nA webhook event is not fired for deployment statuses with an inactive state.
This event occurs when there is activity relating to deployment statuses. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.
\nFor activity relating to deployment creation, use the deployment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
\n\nA webhook event is not fired for deployment statuses with an inactive state.
A comment on the discussion was marked as the answer.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThe category of a discussion was changed.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was closed.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was created.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThe title or body on a discussion was edited, or the category of the discussion was changed.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA label was added to a discussion.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was locked.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was pinned.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was reopened.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was transferred to another repository.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA comment on the discussion was unmarked as the answer.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA label was removed from a discussion.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was unlocked.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was unpinned.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA comment on a discussion was created.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nHow the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "discussion_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "parent_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -44959,7 +44416,7 @@ }, "deleted": { "descriptionHtml": "A comment on a discussion was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nHow the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "discussion_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "parent_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -45871,7 +45058,7 @@ }, "edited": { "descriptionHtml": "A comment on a discussion was edited.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nHow the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "discussion_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "parent_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -49283,271 +48200,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "Contents of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the issue comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -50503,377 +49156,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "Contents of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_github_app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the GitHub app
", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "The slug name of the GitHub app
" - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "A GitHub user.
", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "The name of the GitHub app
", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "The set of permissions for the GitHub app
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "issues", - "description": "" - }, - { - "type": "string", - "name": "checks", - "description": "" - }, - { - "type": "string", - "name": "metadata", - "description": "" - }, - { - "type": "string", - "name": "contents", - "description": "" - }, - { - "type": "string", - "name": "deployments", - "description": "" - } - ] - }, - { - "type": "array of strings", - "name": "events", - "description": "The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the issue comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -51851,377 +50134,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "Contents of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_github_app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the GitHub app
", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "The slug name of the GitHub app
" - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "A GitHub user.
", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "The name of the GitHub app
", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "The set of permissions for the GitHub app
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "issues", - "description": "" - }, - { - "type": "string", - "name": "checks", - "description": "" - }, - { - "type": "string", - "name": "metadata", - "description": "" - }, - { - "type": "string", - "name": "contents", - "description": "" - }, - { - "type": "string", - "name": "deployments", - "description": "" - } - ] - }, - { - "type": "array of strings", - "name": "events", - "description": "The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the issue comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -92468,7 +90381,7 @@ "projects_v2": { "closed": { "descriptionHtml": "A project in the organization was closed.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA project in the organization was created.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA project in the organization was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe title, description, or README of a project in the organization was changed.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA project in the organization was reopened.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nAn item on an organization project was archived. For more information, see \"Archiving items from your project.\"
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA draft issue in an organization project was converted to an issue.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nAn item was added to a project in the organization.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nAn item was deleted from a project in the organization.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nAn archived item on an organization project was restored from the archive. For more information, see \"Archiving items from your project.\"
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "The text of the comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "The SHA of the commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_hunk", - "description": "The diff of the line that the comment refers to.
", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "HTML URL for the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "The ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "in_reply_to_id", - "description": "The comment ID to reply to.
" - }, - { - "type": "integer or null", - "name": "line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "The node ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "original_commit_id", - "description": "The SHA of the original commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "original_line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_position", - "description": "The index of the original line in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "original_start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "The relative path of the file to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "The line index in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "pull_request_review_id", - "description": "The ID of the pull request review to which the comment belongs.
", - "isRequired": true - }, - { - "type": "string", - "name": "pull_request_url", - "description": "URL for the pull request that the review comment belongs to.
", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT" - ] - }, - { - "type": "integer or null", - "name": "start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "start_side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - { - "type": "string", - "name": "subject_type", - "description": "The level at which the comment is targeted, can be a diff line or a file.
", - "enum": [ - "line", - "file" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the pull request review comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -166185,417 +163688,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "The text of the comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "The SHA of the commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_hunk", - "description": "The diff of the line that the comment refers to.
", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "HTML URL for the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "The ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "in_reply_to_id", - "description": "The comment ID to reply to.
" - }, - { - "type": "integer or null", - "name": "line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "The node ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "original_commit_id", - "description": "The SHA of the original commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_position", - "description": "The index of the original line in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "original_start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "The relative path of the file to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "The line index in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "pull_request_review_id", - "description": "The ID of the pull request review to which the comment belongs.
", - "isRequired": true - }, - { - "type": "string", - "name": "pull_request_url", - "description": "URL for the pull request that the review comment belongs to.
", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT" - ] - }, - { - "type": "integer or null", - "name": "start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "start_side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - { - "type": "string", - "name": "subject_type", - "description": "The level at which the comment is targeted, can be a diff line or a file.
", - "enum": [ - "line", - "file" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the pull request review comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -169693,417 +166786,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "The text of the comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "The SHA of the commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_hunk", - "description": "The diff of the line that the comment refers to.
", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "HTML URL for the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "The ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "in_reply_to_id", - "description": "The comment ID to reply to.
" - }, - { - "type": "integer or null", - "name": "line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "The node ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "original_commit_id", - "description": "The SHA of the original commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_position", - "description": "The index of the original line in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "original_start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "The relative path of the file to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "The line index in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "pull_request_review_id", - "description": "The ID of the pull request review to which the comment belongs.
", - "isRequired": true - }, - { - "type": "string", - "name": "pull_request_url", - "description": "URL for the pull request that the review comment belongs to.
", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT" - ] - }, - { - "type": "integer or null", - "name": "start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "start_side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - { - "type": "string", - "name": "subject_type", - "description": "The level at which the comment is targeted, can be a diff line or a file.
", - "enum": [ - "line", - "file" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the pull request review comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -189826,7 +186509,7 @@ "push": { "default": { "descriptionHtml": "", - "summaryHtml": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the delete webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\n\nEvents will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.
\nThis event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the delete webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\n\nEvents will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.
\nA package was published to a registry.
", - "summaryHtml": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\n\nGitHub recommends that you use the newer package event instead.
This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\n\nGitHub recommends that you use the newer package event instead.
A package that was previously published to a registry was updated.
", - "summaryHtml": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\n\nGitHub recommends that you use the newer package event instead.
This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\n\nGitHub recommends that you use the newer package event instead.
A repository vulnerability alert was created.
", - "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
A repository vulnerability alert was dismissed.
", - "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
A previously dismissed or resolved repository vulnerability alert was reopened.
", - "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
A repository vulnerability alert was marked as resolved.
", - "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
A check run was completed, and a conclusion is available.
", - "summaryHtml": "This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
A new check run was created.
", - "summaryHtml": "This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the requested_action payload. For more information, see \"Creating CI tests with the Checks API.\"
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the rerequested payload.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
All check runs in a check suite have completed, and a conclusion is available.
", - "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see the GraphQL API documentation for creating a check run or \"Create a check run\" in the REST API documentation.
", - "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
Someone requested to re-run the check runs in a check suite. For more information, see the GraphQL API documentation for creating a check suite or \"Create a check suite\" in the REST API documentation.
", - "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
The commit comment resource.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "The text of the comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "The SHA of the commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "The ID of the commit comment.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "The node ID of the commit comment.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "path", - "description": "The relative path of the file to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "The line index in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -14137,7 +13862,7 @@ "delete": { "default": { "descriptionHtml": "", - "summaryHtml": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the push webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\n\nThis event will not occur when more than three tags are deleted at once.
\nThis event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the push webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\n\nThis event will not occur when more than three tags are deleted at once.
\nA Dependabot alert was automatically closed by a Dependabot auto-triage rule.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA Dependabot alert was manually closed.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA manifest file change removed a vulnerability.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA manifest file change introduced a vulnerable dependency that had previously been fixed.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA Dependabot alert was manually reopened.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA new deployment status was created.
", - "summaryHtml": "This event occurs when there is activity relating to deployment statuses. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.
\nFor activity relating to deployment creation, use the deployment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
\n\nA webhook event is not fired for deployment statuses with an inactive state.
This event occurs when there is activity relating to deployment statuses. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.
\nFor activity relating to deployment creation, use the deployment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
\n\nA webhook event is not fired for deployment statuses with an inactive state.
A comment on the discussion was marked as the answer.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThe category of a discussion was changed.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was closed.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was created.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThe title or body on a discussion was edited, or the category of the discussion was changed.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA label was added to a discussion.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was locked.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was pinned.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was reopened.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was transferred to another repository.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA comment on the discussion was unmarked as the answer.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA label was removed from a discussion.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was unlocked.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was unpinned.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA comment on a discussion was created.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nHow the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "discussion_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "parent_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -46014,7 +45471,7 @@ }, "deleted": { "descriptionHtml": "A comment on a discussion was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nHow the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "discussion_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "parent_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -46926,7 +46113,7 @@ }, "edited": { "descriptionHtml": "A comment on a discussion was edited.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nHow the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "discussion_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "parent_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -50338,271 +49255,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "Contents of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the issue comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -51558,377 +50211,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "Contents of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_github_app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the GitHub app
", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "The slug name of the GitHub app
" - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "A GitHub user.
", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "The name of the GitHub app
", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "The set of permissions for the GitHub app
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "issues", - "description": "" - }, - { - "type": "string", - "name": "checks", - "description": "" - }, - { - "type": "string", - "name": "metadata", - "description": "" - }, - { - "type": "string", - "name": "contents", - "description": "" - }, - { - "type": "string", - "name": "deployments", - "description": "" - } - ] - }, - { - "type": "array of strings", - "name": "events", - "description": "The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the issue comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -52906,377 +51189,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "Contents of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_github_app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the GitHub app
", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "The slug name of the GitHub app
" - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "A GitHub user.
", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "The name of the GitHub app
", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "The set of permissions for the GitHub app
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "issues", - "description": "" - }, - { - "type": "string", - "name": "checks", - "description": "" - }, - { - "type": "string", - "name": "metadata", - "description": "" - }, - { - "type": "string", - "name": "contents", - "description": "" - }, - { - "type": "string", - "name": "deployments", - "description": "" - } - ] - }, - { - "type": "array of strings", - "name": "events", - "description": "The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the issue comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -93536,7 +91449,7 @@ "projects_v2": { "closed": { "descriptionHtml": "A project in the organization was closed.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA project in the organization was created.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA project in the organization was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe title, description, or README of a project in the organization was changed.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA project in the organization was reopened.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nAn item on an organization project was archived. For more information, see \"Archiving items from your project.\"
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA draft issue in an organization project was converted to an issue.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nAn item was added to a project in the organization.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nAn item was deleted from a project in the organization.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nAn archived item on an organization project was restored from the archive. For more information, see \"Archiving items from your project.\"
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "The text of the comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "The SHA of the commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_hunk", - "description": "The diff of the line that the comment refers to.
", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "HTML URL for the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "The ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "in_reply_to_id", - "description": "The comment ID to reply to.
" - }, - { - "type": "integer or null", - "name": "line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "The node ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "original_commit_id", - "description": "The SHA of the original commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "original_line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_position", - "description": "The index of the original line in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "original_start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "The relative path of the file to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "The line index in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "pull_request_review_id", - "description": "The ID of the pull request review to which the comment belongs.
", - "isRequired": true - }, - { - "type": "string", - "name": "pull_request_url", - "description": "URL for the pull request that the review comment belongs to.
", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT" - ] - }, - { - "type": "integer or null", - "name": "start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "start_side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - { - "type": "string", - "name": "subject_type", - "description": "The level at which the comment is targeted, can be a diff line or a file.
", - "enum": [ - "line", - "file" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the pull request review comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -167253,417 +164756,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "The text of the comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "The SHA of the commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_hunk", - "description": "The diff of the line that the comment refers to.
", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "HTML URL for the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "The ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "in_reply_to_id", - "description": "The comment ID to reply to.
" - }, - { - "type": "integer or null", - "name": "line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "The node ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "original_commit_id", - "description": "The SHA of the original commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_position", - "description": "The index of the original line in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "original_start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "The relative path of the file to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "The line index in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "pull_request_review_id", - "description": "The ID of the pull request review to which the comment belongs.
", - "isRequired": true - }, - { - "type": "string", - "name": "pull_request_url", - "description": "URL for the pull request that the review comment belongs to.
", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT" - ] - }, - { - "type": "integer or null", - "name": "start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "start_side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - { - "type": "string", - "name": "subject_type", - "description": "The level at which the comment is targeted, can be a diff line or a file.
", - "enum": [ - "line", - "file" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the pull request review comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -170761,417 +167854,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "The text of the comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "The SHA of the commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_hunk", - "description": "The diff of the line that the comment refers to.
", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "HTML URL for the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "The ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "in_reply_to_id", - "description": "The comment ID to reply to.
" - }, - { - "type": "integer or null", - "name": "line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "The node ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "original_commit_id", - "description": "The SHA of the original commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_position", - "description": "The index of the original line in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "original_start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "The relative path of the file to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "The line index in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "pull_request_review_id", - "description": "The ID of the pull request review to which the comment belongs.
", - "isRequired": true - }, - { - "type": "string", - "name": "pull_request_url", - "description": "URL for the pull request that the review comment belongs to.
", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT" - ] - }, - { - "type": "integer or null", - "name": "start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "start_side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - { - "type": "string", - "name": "subject_type", - "description": "The level at which the comment is targeted, can be a diff line or a file.
", - "enum": [ - "line", - "file" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the pull request review comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -190894,7 +187577,7 @@ "push": { "default": { "descriptionHtml": "", - "summaryHtml": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the delete webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\n\nEvents will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.
\nThis event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the delete webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\n\nEvents will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.
\nA package was published to a registry.
", - "summaryHtml": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\n\nGitHub recommends that you use the newer package event instead.
This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\n\nGitHub recommends that you use the newer package event instead.
A package that was previously published to a registry was updated.
", - "summaryHtml": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\n\nGitHub recommends that you use the newer package event instead.
This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\n\nGitHub recommends that you use the newer package event instead.
A repository vulnerability alert was created.
", - "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
A repository vulnerability alert was dismissed.
", - "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
A previously dismissed or resolved repository vulnerability alert was reopened.
", - "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
A repository vulnerability alert was marked as resolved.
", - "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
A check run was completed, and a conclusion is available.
", - "summaryHtml": "This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
A new check run was created.
", - "summaryHtml": "This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the requested_action payload. For more information, see \"Creating CI tests with the Checks API.\"
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the rerequested payload.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
All check runs in a check suite have completed, and a conclusion is available.
", - "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see the GraphQL API documentation for creating a check run or \"Create a check run\" in the REST API documentation.
", - "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
Someone requested to re-run the check runs in a check suite. For more information, see the GraphQL API documentation for creating a check suite or \"Create a check suite\" in the REST API documentation.
", - "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
The commit comment resource.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "The text of the comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "The SHA of the commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "The ID of the commit comment.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "The node ID of the commit comment.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "path", - "description": "The relative path of the file to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "The line index in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -14320,7 +14045,7 @@ "delete": { "default": { "descriptionHtml": "", - "summaryHtml": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the push webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\n\nThis event will not occur when more than three tags are deleted at once.
\nThis event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the push webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\n\nThis event will not occur when more than three tags are deleted at once.
\nA Dependabot alert was automatically closed by a Dependabot auto-triage rule.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA Dependabot alert was manually closed.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA manifest file change removed a vulnerability.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA manifest file change introduced a vulnerable dependency that had previously been fixed.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA Dependabot alert was manually reopened.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA new deployment status was created.
", - "summaryHtml": "This event occurs when there is activity relating to deployment statuses. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.
\nFor activity relating to deployment creation, use the deployment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
\n\nA webhook event is not fired for deployment statuses with an inactive state.
This event occurs when there is activity relating to deployment statuses. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.
\nFor activity relating to deployment creation, use the deployment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
\n\nA webhook event is not fired for deployment statuses with an inactive state.
A comment on the discussion was marked as the answer.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThe category of a discussion was changed.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was closed.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was created.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThe title or body on a discussion was edited, or the category of the discussion was changed.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA label was added to a discussion.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was locked.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was pinned.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was reopened.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was transferred to another repository.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA comment on the discussion was unmarked as the answer.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA label was removed from a discussion.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was unlocked.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was unpinned.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA comment on a discussion was created.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nHow the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "discussion_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "parent_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -46197,7 +45654,7 @@ }, "deleted": { "descriptionHtml": "A comment on a discussion was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nHow the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "discussion_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "parent_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -47109,7 +46296,7 @@ }, "edited": { "descriptionHtml": "A comment on a discussion was edited.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nHow the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "discussion_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "parent_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -50521,271 +49438,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "Contents of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the issue comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -51741,382 +50394,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "Contents of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_github_app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the GitHub app
", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "The slug name of the GitHub app
" - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "client_id", - "description": "" - }, - { - "type": "object", - "name": "owner", - "description": "A GitHub user.
", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "The name of the GitHub app
", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "The set of permissions for the GitHub app
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "issues", - "description": "" - }, - { - "type": "string", - "name": "checks", - "description": "" - }, - { - "type": "string", - "name": "metadata", - "description": "" - }, - { - "type": "string", - "name": "contents", - "description": "" - }, - { - "type": "string", - "name": "deployments", - "description": "" - } - ] - }, - { - "type": "array of strings", - "name": "events", - "description": "The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the issue comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -53094,382 +51372,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "Contents of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_github_app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the GitHub app
", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "The slug name of the GitHub app
" - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "client_id", - "description": "" - }, - { - "type": "object", - "name": "owner", - "description": "A GitHub user.
", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "The name of the GitHub app
", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "The set of permissions for the GitHub app
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "issues", - "description": "" - }, - { - "type": "string", - "name": "checks", - "description": "" - }, - { - "type": "string", - "name": "metadata", - "description": "" - }, - { - "type": "string", - "name": "contents", - "description": "" - }, - { - "type": "string", - "name": "deployments", - "description": "" - } - ] - }, - { - "type": "array of strings", - "name": "events", - "description": "The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the issue comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -93729,7 +91632,7 @@ "projects_v2": { "closed": { "descriptionHtml": "A project in the organization was closed.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA project in the organization was created.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA project in the organization was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe title, description, or README of a project in the organization was changed.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA project in the organization was reopened.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nAn item on an organization project was archived. For more information, see \"Archiving items from your project.\"
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA draft issue in an organization project was converted to an issue.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nAn item was added to a project in the organization.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nAn item was deleted from a project in the organization.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nAn archived item on an organization project was restored from the archive. For more information, see \"Archiving items from your project.\"
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "The text of the comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "The SHA of the commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_hunk", - "description": "The diff of the line that the comment refers to.
", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "HTML URL for the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "The ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "in_reply_to_id", - "description": "The comment ID to reply to.
" - }, - { - "type": "integer or null", - "name": "line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "The node ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "original_commit_id", - "description": "The SHA of the original commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "original_line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_position", - "description": "The index of the original line in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "original_start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "The relative path of the file to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "The line index in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "pull_request_review_id", - "description": "The ID of the pull request review to which the comment belongs.
", - "isRequired": true - }, - { - "type": "string", - "name": "pull_request_url", - "description": "URL for the pull request that the review comment belongs to.
", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT" - ] - }, - { - "type": "integer or null", - "name": "start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "start_side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - { - "type": "string", - "name": "subject_type", - "description": "The level at which the comment is targeted, can be a diff line or a file.
", - "enum": [ - "line", - "file" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the pull request review comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -167446,417 +164939,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "The text of the comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "The SHA of the commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_hunk", - "description": "The diff of the line that the comment refers to.
", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "HTML URL for the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "The ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "in_reply_to_id", - "description": "The comment ID to reply to.
" - }, - { - "type": "integer or null", - "name": "line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "The node ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "original_commit_id", - "description": "The SHA of the original commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_position", - "description": "The index of the original line in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "original_start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "The relative path of the file to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "The line index in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "pull_request_review_id", - "description": "The ID of the pull request review to which the comment belongs.
", - "isRequired": true - }, - { - "type": "string", - "name": "pull_request_url", - "description": "URL for the pull request that the review comment belongs to.
", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT" - ] - }, - { - "type": "integer or null", - "name": "start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "start_side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - { - "type": "string", - "name": "subject_type", - "description": "The level at which the comment is targeted, can be a diff line or a file.
", - "enum": [ - "line", - "file" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the pull request review comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -170954,417 +168037,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "The text of the comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "The SHA of the commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_hunk", - "description": "The diff of the line that the comment refers to.
", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "HTML URL for the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "The ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "in_reply_to_id", - "description": "The comment ID to reply to.
" - }, - { - "type": "integer or null", - "name": "line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "The node ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "original_commit_id", - "description": "The SHA of the original commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_position", - "description": "The index of the original line in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "original_start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "The relative path of the file to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "The line index in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "pull_request_review_id", - "description": "The ID of the pull request review to which the comment belongs.
", - "isRequired": true - }, - { - "type": "string", - "name": "pull_request_url", - "description": "URL for the pull request that the review comment belongs to.
", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT" - ] - }, - { - "type": "integer or null", - "name": "start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "start_side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - { - "type": "string", - "name": "subject_type", - "description": "The level at which the comment is targeted, can be a diff line or a file.
", - "enum": [ - "line", - "file" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the pull request review comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -191087,7 +187760,7 @@ "push": { "default": { "descriptionHtml": "", - "summaryHtml": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the delete webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\n\nEvents will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.
\nThis event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the delete webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\n\nEvents will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.
\nA package was published to a registry.
", - "summaryHtml": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\n\nGitHub recommends that you use the newer package event instead.
This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\n\nGitHub recommends that you use the newer package event instead.
A package that was previously published to a registry was updated.
", - "summaryHtml": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\n\nGitHub recommends that you use the newer package event instead.
This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\n\nGitHub recommends that you use the newer package event instead.
A repository vulnerability alert was created.
", - "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
A repository vulnerability alert was dismissed.
", - "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
A previously dismissed or resolved repository vulnerability alert was reopened.
", - "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
A repository vulnerability alert was marked as resolved.
", - "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
A check run was completed, and a conclusion is available.
", - "summaryHtml": "This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
A new check run was created.
", - "summaryHtml": "This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the requested_action payload. For more information, see \"Creating CI tests with the Checks API.\"
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the rerequested payload.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
All check runs in a check suite have completed, and a conclusion is available.
", - "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see the GraphQL API documentation for creating a check run or \"Create a check run\" in the REST API documentation.
", - "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
Someone requested to re-run the check runs in a check suite. For more information, see the GraphQL API documentation for creating a check suite or \"Create a check suite\" in the REST API documentation.
", - "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
The commit comment resource.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "The text of the comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "The SHA of the commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "The ID of the commit comment.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "The node ID of the commit comment.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "path", - "description": "The relative path of the file to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "The line index in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -15375,7 +15100,7 @@ "delete": { "default": { "descriptionHtml": "", - "summaryHtml": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the push webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\n\nThis event will not occur when more than three tags are deleted at once.
\nThis event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the push webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\n\nThis event will not occur when more than three tags are deleted at once.
\nA Dependabot alert was automatically closed by a Dependabot auto-triage rule.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA Dependabot alert was manually closed.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA manifest file change removed a vulnerability.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA manifest file change introduced a vulnerable dependency that had previously been fixed.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA Dependabot alert was manually reopened.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA new deployment status was created.
", - "summaryHtml": "This event occurs when there is activity relating to deployment statuses. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.
\nFor activity relating to deployment creation, use the deployment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
\n\nA webhook event is not fired for deployment statuses with an inactive state.
This event occurs when there is activity relating to deployment statuses. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.
\nFor activity relating to deployment creation, use the deployment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
\n\nA webhook event is not fired for deployment statuses with an inactive state.
A comment on the discussion was marked as the answer.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThe category of a discussion was changed.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was closed.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was created.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThe title or body on a discussion was edited, or the category of the discussion was changed.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA label was added to a discussion.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was locked.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was pinned.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was reopened.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was transferred to another repository.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA comment on the discussion was unmarked as the answer.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA label was removed from a discussion.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was unlocked.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was unpinned.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA comment on a discussion was created.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nHow the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "discussion_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "parent_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -47381,7 +46838,7 @@ }, "deleted": { "descriptionHtml": "A comment on a discussion was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nHow the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "discussion_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "parent_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -48293,7 +47480,7 @@ }, "edited": { "descriptionHtml": "A comment on a discussion was edited.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nHow the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "discussion_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "parent_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -51705,271 +50622,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "Contents of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the issue comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -52925,382 +51578,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "Contents of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_github_app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the GitHub app
", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "The slug name of the GitHub app
" - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "client_id", - "description": "" - }, - { - "type": "object", - "name": "owner", - "description": "A GitHub user.
", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "The name of the GitHub app
", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "The set of permissions for the GitHub app
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "issues", - "description": "" - }, - { - "type": "string", - "name": "checks", - "description": "" - }, - { - "type": "string", - "name": "metadata", - "description": "" - }, - { - "type": "string", - "name": "contents", - "description": "" - }, - { - "type": "string", - "name": "deployments", - "description": "" - } - ] - }, - { - "type": "array of strings", - "name": "events", - "description": "The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the issue comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -54278,382 +52556,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "Contents of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_github_app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the GitHub app
", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "The slug name of the GitHub app
" - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "client_id", - "description": "" - }, - { - "type": "object", - "name": "owner", - "description": "A GitHub user.
", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "The name of the GitHub app
", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "The set of permissions for the GitHub app
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "issues", - "description": "" - }, - { - "type": "string", - "name": "checks", - "description": "" - }, - { - "type": "string", - "name": "metadata", - "description": "" - }, - { - "type": "string", - "name": "contents", - "description": "" - }, - { - "type": "string", - "name": "deployments", - "description": "" - } - ] - }, - { - "type": "array of strings", - "name": "events", - "description": "The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the issue comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -94913,7 +92816,7 @@ "projects_v2": { "closed": { "descriptionHtml": "A project in the organization was closed.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA project in the organization was created.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA project in the organization was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe title, description, or README of a project in the organization was changed.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA project in the organization was reopened.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nAn item on an organization project was archived. For more information, see \"Archiving items from your project.\"
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA draft issue in an organization project was converted to an issue.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nAn item was added to a project in the organization.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nAn item was deleted from a project in the organization.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nAn archived item on an organization project was restored from the archive. For more information, see \"Archiving items from your project.\"
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "The text of the comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "The SHA of the commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_hunk", - "description": "The diff of the line that the comment refers to.
", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "HTML URL for the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "The ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "in_reply_to_id", - "description": "The comment ID to reply to.
" - }, - { - "type": "integer or null", - "name": "line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "The node ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "original_commit_id", - "description": "The SHA of the original commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "original_line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_position", - "description": "The index of the original line in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "original_start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "The relative path of the file to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "The line index in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "pull_request_review_id", - "description": "The ID of the pull request review to which the comment belongs.
", - "isRequired": true - }, - { - "type": "string", - "name": "pull_request_url", - "description": "URL for the pull request that the review comment belongs to.
", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT" - ] - }, - { - "type": "integer or null", - "name": "start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "start_side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - { - "type": "string", - "name": "subject_type", - "description": "The level at which the comment is targeted, can be a diff line or a file.
", - "enum": [ - "line", - "file" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the pull request review comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -168630,417 +166123,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "The text of the comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "The SHA of the commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_hunk", - "description": "The diff of the line that the comment refers to.
", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "HTML URL for the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "The ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "in_reply_to_id", - "description": "The comment ID to reply to.
" - }, - { - "type": "integer or null", - "name": "line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "The node ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "original_commit_id", - "description": "The SHA of the original commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_position", - "description": "The index of the original line in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "original_start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "The relative path of the file to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "The line index in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "pull_request_review_id", - "description": "The ID of the pull request review to which the comment belongs.
", - "isRequired": true - }, - { - "type": "string", - "name": "pull_request_url", - "description": "URL for the pull request that the review comment belongs to.
", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT" - ] - }, - { - "type": "integer or null", - "name": "start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "start_side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - { - "type": "string", - "name": "subject_type", - "description": "The level at which the comment is targeted, can be a diff line or a file.
", - "enum": [ - "line", - "file" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the pull request review comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -172138,417 +169221,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "The text of the comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "The SHA of the commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_hunk", - "description": "The diff of the line that the comment refers to.
", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "HTML URL for the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "The ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "in_reply_to_id", - "description": "The comment ID to reply to.
" - }, - { - "type": "integer or null", - "name": "line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "The node ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "original_commit_id", - "description": "The SHA of the original commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_position", - "description": "The index of the original line in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "original_start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "The relative path of the file to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "The line index in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "pull_request_review_id", - "description": "The ID of the pull request review to which the comment belongs.
", - "isRequired": true - }, - { - "type": "string", - "name": "pull_request_url", - "description": "URL for the pull request that the review comment belongs to.
", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT" - ] - }, - { - "type": "integer or null", - "name": "start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "start_side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - { - "type": "string", - "name": "subject_type", - "description": "The level at which the comment is targeted, can be a diff line or a file.
", - "enum": [ - "line", - "file" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the pull request review comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -192271,7 +188944,7 @@ "push": { "default": { "descriptionHtml": "", - "summaryHtml": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the delete webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\n\nEvents will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.
\nThis event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the delete webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\n\nEvents will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.
\nA package was published to a registry.
", - "summaryHtml": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\n\nGitHub recommends that you use the newer package event instead.
This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\n\nGitHub recommends that you use the newer package event instead.
A package that was previously published to a registry was updated.
", - "summaryHtml": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\n\nGitHub recommends that you use the newer package event instead.
This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\n\nGitHub recommends that you use the newer package event instead.
A repository vulnerability alert was created.
", - "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
A repository vulnerability alert was dismissed.
", - "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
A previously dismissed or resolved repository vulnerability alert was reopened.
", - "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
A repository vulnerability alert was marked as resolved.
", - "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
A check run was completed, and a conclusion is available.
", - "summaryHtml": "This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
A new check run was created.
", - "summaryHtml": "This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the requested_action payload. For more information, see \"Creating CI tests with the Checks API.\"
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the rerequested payload.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was 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.
All check runs in a check suite have completed, and a conclusion is available.
", - "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see the GraphQL API documentation for creating a check run or \"Create a check run\" in the REST API documentation.
", - "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
Someone requested to re-run the check runs in a check suite. For more information, see the GraphQL API documentation for creating a check suite or \"Create a check suite\" in the REST API documentation.
", - "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
\nThe API only looks for pushes in the repository where the check suite was 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.
The commit comment resource.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "The text of the comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "The SHA of the commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "The ID of the commit comment.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "The node ID of the commit comment.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "path", - "description": "The relative path of the file to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "The line index in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -15439,7 +15164,7 @@ "delete": { "default": { "descriptionHtml": "", - "summaryHtml": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the push webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\n\nThis event will not occur when more than three tags are deleted at once.
\nThis event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the push webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\n\nThis event will not occur when more than three tags are deleted at once.
\nA Dependabot alert was automatically closed by a Dependabot auto-triage rule.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA Dependabot alert was manually closed.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA manifest file change removed a vulnerability.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA manifest file change introduced a vulnerable dependency that had previously been fixed.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA Dependabot alert was manually reopened.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\n\nWebhook events for Dependabot alerts are currently in public preview and subject to change.
\nA new deployment status was created.
", - "summaryHtml": "This event occurs when there is activity relating to deployment statuses. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.
\nFor activity relating to deployment creation, use the deployment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
\n\nA webhook event is not fired for deployment statuses with an inactive state.
This event occurs when there is activity relating to deployment statuses. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.
\nFor activity relating to deployment creation, use the deployment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
\n\nA webhook event is not fired for deployment statuses with an inactive state.
A comment on the discussion was marked as the answer.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThe category of a discussion was changed.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was closed.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was created.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThe title or body on a discussion was edited, or the category of the discussion was changed.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA label was added to a discussion.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was locked.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was pinned.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was reopened.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was transferred to another repository.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA comment on the discussion was unmarked as the answer.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA label was removed from a discussion.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was unlocked.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was unpinned.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA comment on a discussion was created.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nHow the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "discussion_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "parent_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -47445,7 +46902,7 @@ }, "deleted": { "descriptionHtml": "A comment on a discussion was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nHow the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "discussion_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "parent_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -48357,7 +47544,7 @@ }, "edited": { "descriptionHtml": "A comment on a discussion was edited.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThis event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nHow the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "child_comment_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "discussion_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer or null", - "name": "parent_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -49294,7 +48211,7 @@ "dismissal_request_code_scanning": { "created": { "descriptionHtml": "A code scanning alert dismissal request was created.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.
\n\nDelegated alert dismissal for code scanning is currently in public preview and subject to change.
\nThis event occurs when there is activity related to a user's request to dismiss a code scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -49487,7 +48404,7 @@ }, "response_submitted": { "descriptionHtml": "A code scanning alert dismissal response was submitted.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.
\n\nDelegated alert dismissal for code scanning is currently in public preview and subject to change.
\nThis event occurs when there is activity related to a user's request to dismiss a code scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -53256,271 +52173,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "Contents of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "null", - "name": "performed_via_github_app", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the issue comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -54476,382 +53129,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "Contents of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_github_app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the GitHub app
", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "The slug name of the GitHub app
" - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "client_id", - "description": "" - }, - { - "type": "object", - "name": "owner", - "description": "A GitHub user.
", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "The name of the GitHub app
", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "The set of permissions for the GitHub app
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "issues", - "description": "" - }, - { - "type": "string", - "name": "checks", - "description": "" - }, - { - "type": "string", - "name": "metadata", - "description": "" - }, - { - "type": "string", - "name": "contents", - "description": "" - }, - { - "type": "string", - "name": "deployments", - "description": "" - } - ] - }, - { - "type": "array of strings", - "name": "events", - "description": "The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the issue comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -55829,382 +54107,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "Contents of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the issue comment
", - "isRequired": true - }, - { - "type": "string", - "name": "issue_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "performed_via_github_app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the GitHub app
", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "The slug name of the GitHub app
" - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "client_id", - "description": "" - }, - { - "type": "object", - "name": "owner", - "description": "A GitHub user.
", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "The name of the GitHub app
", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "The set of permissions for the GitHub app
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "issues", - "description": "" - }, - { - "type": "string", - "name": "checks", - "description": "" - }, - { - "type": "string", - "name": "metadata", - "description": "" - }, - { - "type": "string", - "name": "contents", - "description": "" - }, - { - "type": "string", - "name": "deployments", - "description": "" - } - ] - }, - { - "type": "array of strings", - "name": "events", - "description": "The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
" - } - ] - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the issue comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -96464,7 +94367,7 @@ "projects_v2": { "closed": { "descriptionHtml": "A project in the organization was closed.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA project in the organization was created.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA project in the organization was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe title, description, or README of a project in the organization was changed.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA project in the organization was reopened.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nAn item on an organization project was archived. For more information, see \"Archiving items from your project.\"
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nA draft issue in an organization project was converted to an issue.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nAn item was added to a project in the organization.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nAn item was deleted from a project in the organization.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nAn archived item on an organization project was restored from the archive. For more information, see \"Archiving items from your project.\"
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThis event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\n\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
\nThe comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "The text of the comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "The SHA of the commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_hunk", - "description": "The diff of the line that the comment refers to.
", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "HTML URL for the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "The ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "in_reply_to_id", - "description": "The comment ID to reply to.
" - }, - { - "type": "integer or null", - "name": "line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "The node ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "original_commit_id", - "description": "The SHA of the original commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "original_line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_position", - "description": "The index of the original line in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "original_start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "The relative path of the file to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "The line index in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "pull_request_review_id", - "description": "The ID of the pull request review to which the comment belongs.
", - "isRequired": true - }, - { - "type": "string", - "name": "pull_request_url", - "description": "URL for the pull request that the review comment belongs to.
", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT" - ] - }, - { - "type": "integer or null", - "name": "start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "start_side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - { - "type": "string", - "name": "subject_type", - "description": "The level at which the comment is targeted, can be a diff line or a file.
", - "enum": [ - "line", - "file" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the pull request review comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -170181,417 +167674,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "The text of the comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "The SHA of the commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_hunk", - "description": "The diff of the line that the comment refers to.
", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "HTML URL for the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "The ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "in_reply_to_id", - "description": "The comment ID to reply to.
" - }, - { - "type": "integer or null", - "name": "line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "The node ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "original_commit_id", - "description": "The SHA of the original commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_position", - "description": "The index of the original line in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "original_start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "The relative path of the file to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "The line index in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "pull_request_review_id", - "description": "The ID of the pull request review to which the comment belongs.
", - "isRequired": true - }, - { - "type": "string", - "name": "pull_request_url", - "description": "URL for the pull request that the review comment belongs to.
", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT" - ] - }, - { - "type": "integer or null", - "name": "start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "start_side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - { - "type": "string", - "name": "subject_type", - "description": "The level at which the comment is targeted, can be a diff line or a file.
", - "enum": [ - "line", - "file" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the pull request review comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -173689,417 +170772,7 @@ "in": "body", "description": "The comment itself.
", "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "_links", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "html", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "pull_request", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "object", - "name": "self", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "href", - "description": "", - "isRequired": true - } - ] - } - ] - }, - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "The text of the comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "commit_id", - "description": "The SHA of the commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "diff_hunk", - "description": "The diff of the line that the comment refers to.
", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "HTML URL for the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "The ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "integer", - "name": "in_reply_to_id", - "description": "The comment ID to reply to.
" - }, - { - "type": "integer or null", - "name": "line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "The node ID of the pull request review comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "original_commit_id", - "description": "The SHA of the original commit to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_line", - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment
", - "isRequired": true - }, - { - "type": "integer", - "name": "original_position", - "description": "The index of the original line in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "original_start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "description": "The relative path of the file to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "position", - "description": "The line index in the diff to which the comment applies.
", - "isRequired": true - }, - { - "type": "integer or null", - "name": "pull_request_review_id", - "description": "The ID of the pull request review to which the comment belongs.
", - "isRequired": true - }, - { - "type": "string", - "name": "pull_request_url", - "description": "URL for the pull request that the review comment belongs to.
", - "isRequired": true - }, - { - "type": "object", - "name": "reactions", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT" - ] - }, - { - "type": "integer or null", - "name": "start_line", - "description": "The first line of the range for a multi-line comment.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "start_side", - "description": "The side of the first line of the range for a multi-line comment.
", - "isRequired": true, - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - { - "type": "string", - "name": "subject_type", - "description": "The level at which the comment is targeted, can be a diff line or a file.
", - "enum": [ - "line", - "file" - ] - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the pull request review comment
", - "isRequired": true - }, - { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - } - ] + "childParamsGroups": [] }, { "type": "object", @@ -193822,7 +190495,7 @@ "push": { "default": { "descriptionHtml": "", - "summaryHtml": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the delete webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\n\nEvents will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.
\nThis event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the delete webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
\n\nEvents will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.
\nA package was published to a registry.
", - "summaryHtml": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\n\nGitHub recommends that you use the newer package event instead.
This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\n\nGitHub recommends that you use the newer package event instead.
A package that was previously published to a registry was updated.
", - "summaryHtml": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\n\nGitHub recommends that you use the newer package event instead.
This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\n\nGitHub recommends that you use the newer package event instead.
A repository vulnerability alert was created.
", - "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
A repository vulnerability alert was dismissed.
", - "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
A previously dismissed or resolved repository vulnerability alert was reopened.
", - "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
A repository vulnerability alert was marked as resolved.
", - "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.