diff --git a/docs/actions/createEnvironmentVariable.md b/docs/actions/createEnvironmentVariable.md index b37054d41..a783a9419 100644 --- a/docs/actions/createEnvironmentVariable.md +++ b/docs/actions/createEnvironmentVariable.md @@ -1,7 +1,7 @@ --- name: Create an environment variable -example: octokit.rest.actions.createEnvironmentVariable({ repository_id, environment_name, name, value }) -route: POST /repositories/{repository_id}/environments/{environment_name}/variables +example: octokit.rest.actions.createEnvironmentVariable({ owner, repo, environment_name, name, value }) +route: POST /repos/{owner}/{repo}/environments/{environment_name}/variables scope: actions type: API method --- @@ -16,7 +16,8 @@ OAuth tokens and personal access tokens (classic) need the `repo` scope to use t ```js octokit.rest.actions.createEnvironmentVariable({ - repository_id, + owner, + repo, environment_name, name, value, @@ -34,9 +35,14 @@ octokit.rest.actions.createEnvironmentVariable({ - repository_idyes + owneryes -The unique identifier of the repository. +The account owner of the repository. The name is not case sensitive. + + +repoyes + +The name of the repository without the `.git` extension. The name is not case sensitive. environment_nameyes diff --git a/docs/actions/createOrUpdateEnvironmentSecret.md b/docs/actions/createOrUpdateEnvironmentSecret.md index aa89118e2..33ec2dec7 100644 --- a/docs/actions/createOrUpdateEnvironmentSecret.md +++ b/docs/actions/createOrUpdateEnvironmentSecret.md @@ -1,7 +1,7 @@ --- name: Create or update an environment secret -example: octokit.rest.actions.createOrUpdateEnvironmentSecret({ repository_id, environment_name, secret_name, encrypted_value, key_id }) -route: PUT /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name} +example: octokit.rest.actions.createOrUpdateEnvironmentSecret({ owner, repo, environment_name, secret_name, encrypted_value, key_id }) +route: PUT /repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name} scope: actions type: API method --- @@ -17,7 +17,8 @@ OAuth tokens and personal access tokens (classic) need the `repo` scope to use t ```js octokit.rest.actions.createOrUpdateEnvironmentSecret({ - repository_id, + owner, + repo, environment_name, secret_name, encrypted_value, @@ -36,9 +37,14 @@ octokit.rest.actions.createOrUpdateEnvironmentSecret({ - repository_idyes + owneryes -The unique identifier of the repository. +The account owner of the repository. The name is not case sensitive. + + +repoyes + +The name of the repository without the `.git` extension. The name is not case sensitive. environment_nameyes diff --git a/docs/actions/deleteEnvironmentSecret.md b/docs/actions/deleteEnvironmentSecret.md index 4e7d40989..d2b96fecd 100644 --- a/docs/actions/deleteEnvironmentSecret.md +++ b/docs/actions/deleteEnvironmentSecret.md @@ -1,7 +1,7 @@ --- name: Delete an environment secret -example: octokit.rest.actions.deleteEnvironmentSecret({ repository_id, environment_name, secret_name }) -route: DELETE /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name} +example: octokit.rest.actions.deleteEnvironmentSecret({ owner, repo, environment_name, secret_name }) +route: DELETE /repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name} scope: actions type: API method --- @@ -16,7 +16,8 @@ OAuth tokens and personal access tokens (classic) need the `repo` scope to use t ```js octokit.rest.actions.deleteEnvironmentSecret({ - repository_id, + owner, + repo, environment_name, secret_name, }); @@ -33,9 +34,14 @@ octokit.rest.actions.deleteEnvironmentSecret({ - repository_idyes + owneryes -The unique identifier of the repository. +The account owner of the repository. The name is not case sensitive. + + +repoyes + +The name of the repository without the `.git` extension. The name is not case sensitive. environment_nameyes diff --git a/docs/actions/deleteEnvironmentVariable.md b/docs/actions/deleteEnvironmentVariable.md index 118d2e499..ae2e39be8 100644 --- a/docs/actions/deleteEnvironmentVariable.md +++ b/docs/actions/deleteEnvironmentVariable.md @@ -1,7 +1,7 @@ --- name: Delete an environment variable -example: octokit.rest.actions.deleteEnvironmentVariable({ repository_id, name, environment_name }) -route: DELETE /repositories/{repository_id}/environments/{environment_name}/variables/{name} +example: octokit.rest.actions.deleteEnvironmentVariable({ owner, repo, name, environment_name }) +route: DELETE /repos/{owner}/{repo}/environments/{environment_name}/variables/{name} scope: actions type: API method --- @@ -16,7 +16,8 @@ OAuth tokens and personal access tokens (classic) need the `repo` scope to use t ```js octokit.rest.actions.deleteEnvironmentVariable({ - repository_id, + owner, + repo, name, environment_name, }); @@ -33,9 +34,14 @@ octokit.rest.actions.deleteEnvironmentVariable({ - repository_idyes + owneryes -The unique identifier of the repository. +The account owner of the repository. The name is not case sensitive. + + +repoyes + +The name of the repository without the `.git` extension. The name is not case sensitive. nameyes diff --git a/docs/actions/getCustomOidcSubClaimForRepo.md b/docs/actions/getCustomOidcSubClaimForRepo.md index d6ce80736..3b0617319 100644 --- a/docs/actions/getCustomOidcSubClaimForRepo.md +++ b/docs/actions/getCustomOidcSubClaimForRepo.md @@ -9,8 +9,8 @@ type: API method # Get the customization template for an OIDC subject claim for a repository Gets the customization template for an OpenID Connect (OIDC) subject claim. -You must authenticate using an access token with the `repo` scope to use this -endpoint. GitHub Apps must have the `organization_administration:read` permission to use this endpoint. + +OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.getCustomOidcSubClaimForRepo({ diff --git a/docs/actions/getEnvironmentPublicKey.md b/docs/actions/getEnvironmentPublicKey.md index 72222bd91..500b72422 100644 --- a/docs/actions/getEnvironmentPublicKey.md +++ b/docs/actions/getEnvironmentPublicKey.md @@ -1,7 +1,7 @@ --- name: Get an environment public key -example: octokit.rest.actions.getEnvironmentPublicKey({ repository_id, environment_name }) -route: GET /repositories/{repository_id}/environments/{environment_name}/secrets/public-key +example: octokit.rest.actions.getEnvironmentPublicKey({ owner, repo, environment_name }) +route: GET /repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key scope: actions type: API method --- @@ -17,7 +17,8 @@ If the repository is private, OAuth tokens and personal access tokens (classic) ```js octokit.rest.actions.getEnvironmentPublicKey({ - repository_id, + owner, + repo, environment_name, }); ``` @@ -33,9 +34,14 @@ octokit.rest.actions.getEnvironmentPublicKey({ - repository_idyes + owneryes -The unique identifier of the repository. +The account owner of the repository. The name is not case sensitive. + + +repoyes + +The name of the repository without the `.git` extension. The name is not case sensitive. environment_nameyes diff --git a/docs/actions/getEnvironmentSecret.md b/docs/actions/getEnvironmentSecret.md index ba5fc2cf9..81ac7f9ae 100644 --- a/docs/actions/getEnvironmentSecret.md +++ b/docs/actions/getEnvironmentSecret.md @@ -1,7 +1,7 @@ --- name: Get an environment secret -example: octokit.rest.actions.getEnvironmentSecret({ repository_id, environment_name, secret_name }) -route: GET /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name} +example: octokit.rest.actions.getEnvironmentSecret({ owner, repo, environment_name, secret_name }) +route: GET /repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name} scope: actions type: API method --- @@ -16,7 +16,8 @@ OAuth tokens and personal access tokens (classic) need the `repo` scope to use t ```js octokit.rest.actions.getEnvironmentSecret({ - repository_id, + owner, + repo, environment_name, secret_name, }); @@ -33,9 +34,14 @@ octokit.rest.actions.getEnvironmentSecret({ - repository_idyes + owneryes -The unique identifier of the repository. +The account owner of the repository. The name is not case sensitive. + + +repoyes + +The name of the repository without the `.git` extension. The name is not case sensitive. environment_nameyes diff --git a/docs/actions/getEnvironmentVariable.md b/docs/actions/getEnvironmentVariable.md index d79c2e439..9184cfec8 100644 --- a/docs/actions/getEnvironmentVariable.md +++ b/docs/actions/getEnvironmentVariable.md @@ -1,7 +1,7 @@ --- name: Get an environment variable -example: octokit.rest.actions.getEnvironmentVariable({ repository_id, environment_name, name }) -route: GET /repositories/{repository_id}/environments/{environment_name}/variables/{name} +example: octokit.rest.actions.getEnvironmentVariable({ owner, repo, environment_name, name }) +route: GET /repos/{owner}/{repo}/environments/{environment_name}/variables/{name} scope: actions type: API method --- @@ -16,7 +16,8 @@ OAuth tokens and personal access tokens (classic) need the `repo` scope to use t ```js octokit.rest.actions.getEnvironmentVariable({ - repository_id, + owner, + repo, environment_name, name, }); @@ -33,9 +34,14 @@ octokit.rest.actions.getEnvironmentVariable({ - repository_idyes + owneryes -The unique identifier of the repository. +The account owner of the repository. The name is not case sensitive. + + +repoyes + +The name of the repository without the `.git` extension. The name is not case sensitive. environment_nameyes diff --git a/docs/actions/listEnvironmentSecrets.md b/docs/actions/listEnvironmentSecrets.md index a02fc00a3..fec1b985a 100644 --- a/docs/actions/listEnvironmentSecrets.md +++ b/docs/actions/listEnvironmentSecrets.md @@ -1,7 +1,7 @@ --- name: List environment secrets -example: octokit.rest.actions.listEnvironmentSecrets({ repository_id, environment_name }) -route: GET /repositories/{repository_id}/environments/{environment_name}/secrets +example: octokit.rest.actions.listEnvironmentSecrets({ owner, repo, environment_name }) +route: GET /repos/{owner}/{repo}/environments/{environment_name}/secrets scope: actions type: API method --- @@ -17,7 +17,8 @@ OAuth app tokens and personal access tokens (classic) need the `repo` scope to u ```js octokit.rest.actions.listEnvironmentSecrets({ - repository_id, + owner, + repo, environment_name, }); ``` @@ -33,9 +34,14 @@ octokit.rest.actions.listEnvironmentSecrets({ - repository_idyes + owneryes -The unique identifier of the repository. +The account owner of the repository. The name is not case sensitive. + + +repoyes + +The name of the repository without the `.git` extension. The name is not case sensitive. environment_nameyes diff --git a/docs/actions/listEnvironmentVariables.md b/docs/actions/listEnvironmentVariables.md index c68c39c4f..8ce9458cf 100644 --- a/docs/actions/listEnvironmentVariables.md +++ b/docs/actions/listEnvironmentVariables.md @@ -1,7 +1,7 @@ --- name: List environment variables -example: octokit.rest.actions.listEnvironmentVariables({ repository_id, environment_name }) -route: GET /repositories/{repository_id}/environments/{environment_name}/variables +example: octokit.rest.actions.listEnvironmentVariables({ owner, repo, environment_name }) +route: GET /repos/{owner}/{repo}/environments/{environment_name}/variables scope: actions type: API method --- @@ -16,7 +16,8 @@ OAuth app tokens and personal access tokens (classic) need the `repo` scope to u ```js octokit.rest.actions.listEnvironmentVariables({ - repository_id, + owner, + repo, environment_name, }); ``` @@ -32,9 +33,14 @@ octokit.rest.actions.listEnvironmentVariables({ - repository_idyes + owneryes -The unique identifier of the repository. +The account owner of the repository. The name is not case sensitive. + + +repoyes + +The name of the repository without the `.git` extension. The name is not case sensitive. environment_nameyes diff --git a/docs/actions/listWorkflowRuns.md b/docs/actions/listWorkflowRuns.md index dff3798ab..6bfde7e1d 100644 --- a/docs/actions/listWorkflowRuns.md +++ b/docs/actions/listWorkflowRuns.md @@ -65,7 +65,7 @@ Returns workflow run triggered by the event you specify. For example, `push`, `p statusno -Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. +Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. per_pageno diff --git a/docs/actions/listWorkflowRunsForRepo.md b/docs/actions/listWorkflowRunsForRepo.md index 55f1787a9..02ff060a6 100644 --- a/docs/actions/listWorkflowRunsForRepo.md +++ b/docs/actions/listWorkflowRunsForRepo.md @@ -14,6 +14,8 @@ Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. +This API 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`. + ```js octokit.rest.actions.listWorkflowRunsForRepo({ owner, @@ -59,7 +61,7 @@ Returns workflow run triggered by the event you specify. For example, `push`, `p statusno -Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. +Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. per_pageno diff --git a/docs/actions/setCustomOidcSubClaimForRepo.md b/docs/actions/setCustomOidcSubClaimForRepo.md index d79578f43..83964e4ad 100644 --- a/docs/actions/setCustomOidcSubClaimForRepo.md +++ b/docs/actions/setCustomOidcSubClaimForRepo.md @@ -9,8 +9,8 @@ type: API method # Set the customization template for an OIDC subject claim for a repository Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository. -You must authenticate using an access token with the `repo` scope to use this -endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. ```js octokit.rest.actions.setCustomOidcSubClaimForRepo({ diff --git a/docs/actions/updateEnvironmentVariable.md b/docs/actions/updateEnvironmentVariable.md index 5255364d4..824511069 100644 --- a/docs/actions/updateEnvironmentVariable.md +++ b/docs/actions/updateEnvironmentVariable.md @@ -1,7 +1,7 @@ --- name: Update an environment variable -example: octokit.rest.actions.updateEnvironmentVariable({ repository_id, environment_name }) -route: PATCH /repositories/{repository_id}/environments/{environment_name}/variables/{name} +example: octokit.rest.actions.updateEnvironmentVariable({ owner, repo, environment_name }) +route: PATCH /repos/{owner}/{repo}/environments/{environment_name}/variables/{name} scope: actions type: API method --- @@ -16,7 +16,8 @@ OAuth app tokens and personal access tokens (classic) need the `repo` scope to u ```js octokit.rest.actions.updateEnvironmentVariable({ - repository_id, + owner, + repo, environment_name, }); ``` @@ -32,9 +33,14 @@ octokit.rest.actions.updateEnvironmentVariable({ - repository_idyes + owneryes -The unique identifier of the repository. +The account owner of the repository. The name is not case sensitive. + + +repoyes + +The name of the repository without the `.git` extension. The name is not case sensitive. nameno diff --git a/docs/activity/getFeeds.md b/docs/activity/getFeeds.md index a0049f9b0..6fc03c19c 100644 --- a/docs/activity/getFeeds.md +++ b/docs/activity/getFeeds.md @@ -8,7 +8,7 @@ type: API method # Get feeds -GitHub provides several timeline resources in [Atom]() format. The Feeds API lists all the feeds available to the authenticated user: +Lists 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. - **Timeline**: The GitHub global public timeline - **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." @@ -18,6 +18,8 @@ GitHub provides several timeline resources in [Atom]( statusno -The current status. +The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. conclusionno diff --git a/docs/copilot/addCopilotForBusinessSeatsForTeams.md b/docs/copilot/addCopilotForBusinessSeatsForTeams.md deleted file mode 100644 index 75b694499..000000000 --- a/docs/copilot/addCopilotForBusinessSeatsForTeams.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -name: Add teams to the Copilot for Business subscription for an organization -example: octokit.rest.copilot.addCopilotForBusinessSeatsForTeams({ org, selected_teams }) -route: POST /orgs/{org}/copilot/billing/selected_teams -scope: copilot -type: API method ---- - -# Add teams to the Copilot for Business subscription for an organization - -**Note**: This endpoint is in beta and is subject to change. - -Purchases a GitHub Copilot for Business seat for all users within each specified team. -The organization will be billed accordingly. For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)". - -Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must -authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. - -In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy. -For more information about setting up a Copilot for Business subscription, see "[Setting up a Copilot for Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-for-business-subscription-for-your-organization)". -For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". - -```js -octokit.rest.copilot.addCopilotForBusinessSeatsForTeams({ - org, - selected_teams, -}); -``` - -## Parameters - - - - - - - - - - - - - -
namerequireddescription
orgyes - -The organization name. The name is not case sensitive. - -
selected_teamsyes - -List of team names within the organization to which to grant access to GitHub Copilot. - -
- -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/copilot/copilot-for-business#add-teams-to-the-copilot-for-business-subscription-for-an-organization). diff --git a/docs/copilot/addCopilotForBusinessSeatsForUsers.md b/docs/copilot/addCopilotForBusinessSeatsForUsers.md deleted file mode 100644 index 828ed0c86..000000000 --- a/docs/copilot/addCopilotForBusinessSeatsForUsers.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -name: Add users to the Copilot for Business subscription for an organization -example: octokit.rest.copilot.addCopilotForBusinessSeatsForUsers({ org, selected_usernames }) -route: POST /orgs/{org}/copilot/billing/selected_users -scope: copilot -type: API method ---- - -# Add users to the Copilot for Business subscription for an organization - -**Note**: This endpoint is in beta and is subject to change. - -Purchases a GitHub Copilot for Business seat for each user specified. -The organization will be billed accordingly. For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)". - -Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must -authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. - -In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy. -For more information about setting up a Copilot for Business subscription, see "[Setting up a Copilot for Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-for-business-subscription-for-your-organization)". -For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". - -```js -octokit.rest.copilot.addCopilotForBusinessSeatsForUsers({ - org, - selected_usernames, -}); -``` - -## Parameters - - - - - - - - - - - - - -
namerequireddescription
orgyes - -The organization name. The name is not case sensitive. - -
selected_usernamesyes - -The usernames of the organization members to be granted access to GitHub Copilot. - -
- -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/copilot/copilot-for-business#add-users-to-the-copilot-for-business-subscription-for-an-organization). diff --git a/docs/git/deleteRef.md b/docs/git/deleteRef.md index ea387ab04..bfe59b125 100644 --- a/docs/git/deleteRef.md +++ b/docs/git/deleteRef.md @@ -8,6 +8,8 @@ type: API method # Delete a reference +Deletes the provided reference. + ```js octokit.rest.git.deleteRef({ owner, @@ -39,7 +41,7 @@ The name of the repository without the `.git` extension. The name is not case se refyes -The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. +The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. diff --git a/docs/git/getRef.md b/docs/git/getRef.md index 784f7a291..8fd0829a8 100644 --- a/docs/git/getRef.md +++ b/docs/git/getRef.md @@ -43,7 +43,7 @@ The name of the repository without the `.git` extension. The name is not case se refyes -The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. +The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. diff --git a/docs/git/listMatchingRefs.md b/docs/git/listMatchingRefs.md index 65549a998..78f5f9541 100644 --- a/docs/git/listMatchingRefs.md +++ b/docs/git/listMatchingRefs.md @@ -47,7 +47,7 @@ The name of the repository without the `.git` extension. The name is not case se refyes -The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. +The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. diff --git a/docs/git/updateRef.md b/docs/git/updateRef.md index 2d16a0fb5..ab77f5cf5 100644 --- a/docs/git/updateRef.md +++ b/docs/git/updateRef.md @@ -8,6 +8,8 @@ type: API method # Update a reference +Updates the provided reference to point to a new SHA. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + ```js octokit.rest.git.updateRef({ owner, @@ -40,7 +42,7 @@ The name of the repository without the `.git` extension. The name is not case se refyes -The name of the reference to update (for example, `heads/featureA`). Can be a branch name (`heads/BRANCH_NAME`) or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. +The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. shayes diff --git a/docs/licenses/getForRepo.md b/docs/licenses/getForRepo.md index 2550c6025..8729cf785 100644 --- a/docs/licenses/getForRepo.md +++ b/docs/licenses/getForRepo.md @@ -42,6 +42,11 @@ The account owner of the repository. The name is not case sensitive. The name of the repository without the `.git` extension. The name is not case sensitive. + +refno + +The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. + diff --git a/docs/oidc/getOidcCustomSubTemplateForOrg.md b/docs/oidc/getOidcCustomSubTemplateForOrg.md index 02f274a45..c37dac815 100644 --- a/docs/oidc/getOidcCustomSubTemplateForOrg.md +++ b/docs/oidc/getOidcCustomSubTemplateForOrg.md @@ -9,8 +9,8 @@ type: API method # Get the customization template for an OIDC subject claim for an organization Gets the customization template for an OpenID Connect (OIDC) subject claim. -You must authenticate using an access token with the `read:org` scope to use this endpoint. -GitHub Apps must have the `organization_administration:write` permission to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. ```js octokit.rest.oidc.getOidcCustomSubTemplateForOrg({ diff --git a/docs/oidc/updateOidcCustomSubTemplateForOrg.md b/docs/oidc/updateOidcCustomSubTemplateForOrg.md index da02faac4..6f93c4ffe 100644 --- a/docs/oidc/updateOidcCustomSubTemplateForOrg.md +++ b/docs/oidc/updateOidcCustomSubTemplateForOrg.md @@ -9,8 +9,8 @@ type: API method # Set the customization template for an OIDC subject claim for an organization Creates or updates the customization template for an OpenID Connect (OIDC) subject claim. -You must authenticate using an access token with the `write:org` scope to use this endpoint. -GitHub Apps must have the `admin:org` permission to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. ```js octokit.rest.oidc.updateOidcCustomSubTemplateForOrg({ diff --git a/docs/orgs/createWebhook.md b/docs/orgs/createWebhook.md index 1816bc682..85a49e202 100644 --- a/docs/orgs/createWebhook.md +++ b/docs/orgs/createWebhook.md @@ -8,7 +8,12 @@ type: API method # Create an organization webhook -Here's how you can create a hook that posts payloads in JSON format: +Create a hook that posts payloads in JSON format. + +You must be an organization owner to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or +edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. ```js octokit.rest.orgs.createWebhook({ diff --git a/docs/orgs/deleteWebhook.md b/docs/orgs/deleteWebhook.md index c56aed367..264614830 100644 --- a/docs/orgs/deleteWebhook.md +++ b/docs/orgs/deleteWebhook.md @@ -8,6 +8,11 @@ type: API method # Delete an organization webhook +You must be an organization owner to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit +webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + ```js octokit.rest.orgs.deleteWebhook({ org, diff --git a/docs/orgs/getWebhook.md b/docs/orgs/getWebhook.md index 0336facf5..da818607c 100644 --- a/docs/orgs/getWebhook.md +++ b/docs/orgs/getWebhook.md @@ -8,7 +8,13 @@ type: API method # Get an organization webhook -Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization)." +Returns a webhook configured in an organization. To get only the webhook +`config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). + +You must be an organization owner to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit +webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. ```js octokit.rest.orgs.getWebhook({ diff --git a/docs/orgs/getWebhookConfigForOrg.md b/docs/orgs/getWebhookConfigForOrg.md index 9054df5eb..fda7301ad 100644 --- a/docs/orgs/getWebhookConfigForOrg.md +++ b/docs/orgs/getWebhookConfigForOrg.md @@ -10,7 +10,10 @@ type: API method Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)." -OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint. +You must be an organization owner to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit +webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. ```js octokit.rest.orgs.getWebhookConfigForOrg({ diff --git a/docs/orgs/getWebhookDelivery.md b/docs/orgs/getWebhookDelivery.md index f121ee110..95e030578 100644 --- a/docs/orgs/getWebhookDelivery.md +++ b/docs/orgs/getWebhookDelivery.md @@ -10,6 +10,11 @@ type: API method Returns a delivery for a webhook configured in an organization. +You must be an organization owner to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit +webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + ```js octokit.rest.orgs.getWebhookDelivery({ org, diff --git a/docs/orgs/list.md b/docs/orgs/list.md index 8327131af..0d7c68afa 100644 --- a/docs/orgs/list.md +++ b/docs/orgs/list.md @@ -8,7 +8,7 @@ type: API method # List organizations -Lists all organizations, in the order that they were created on GitHub. +Lists all organizations, in the order that they were created. **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. diff --git a/docs/orgs/listWebhookDeliveries.md b/docs/orgs/listWebhookDeliveries.md index cab01272f..6a51af539 100644 --- a/docs/orgs/listWebhookDeliveries.md +++ b/docs/orgs/listWebhookDeliveries.md @@ -10,6 +10,11 @@ type: API method Returns a list of webhook deliveries for a webhook configured in an organization. +You must be an organization owner to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit +webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + ```js octokit.rest.orgs.listWebhookDeliveries({ org, diff --git a/docs/orgs/listWebhooks.md b/docs/orgs/listWebhooks.md index d4558c113..99dadd898 100644 --- a/docs/orgs/listWebhooks.md +++ b/docs/orgs/listWebhooks.md @@ -8,6 +8,11 @@ type: API method # List organization webhooks +You must be an organization owner to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit +webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + ```js octokit.rest.orgs.listWebhooks({ org, diff --git a/docs/orgs/pingWebhook.md b/docs/orgs/pingWebhook.md index e8b2bfd7c..0741c4529 100644 --- a/docs/orgs/pingWebhook.md +++ b/docs/orgs/pingWebhook.md @@ -8,7 +8,13 @@ type: API method # Ping an organization webhook -This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. +This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) +to be sent to the hook. + +You must be an organization owner to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit +webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. ```js octokit.rest.orgs.pingWebhook({ diff --git a/docs/orgs/redeliverWebhookDelivery.md b/docs/orgs/redeliverWebhookDelivery.md index e3e0daac6..21b92919e 100644 --- a/docs/orgs/redeliverWebhookDelivery.md +++ b/docs/orgs/redeliverWebhookDelivery.md @@ -10,6 +10,11 @@ type: API method Redeliver a delivery for a webhook configured in an organization. +You must be an organization owner to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit +webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + ```js octokit.rest.orgs.redeliverWebhookDelivery({ org, diff --git a/docs/orgs/updateWebhook.md b/docs/orgs/updateWebhook.md index bde099155..f1916765e 100644 --- a/docs/orgs/updateWebhook.md +++ b/docs/orgs/updateWebhook.md @@ -8,7 +8,16 @@ type: API method # Update an organization webhook -Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)." +Updates a webhook configured in an organization. When you update a webhook, +the `secret` will be overwritten. If you previously had a `secret` set, you must +provide the same `secret` or set a new `secret` or the secret will be removed. If +you are only updating individual webhook `config` properties, use "[Update a webhook +configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)". + +You must be an organization owner to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit +webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. ```js octokit.rest.orgs.updateWebhook({ diff --git a/docs/orgs/updateWebhookConfigForOrg.md b/docs/orgs/updateWebhookConfigForOrg.md index c6980349c..6a75e22af 100644 --- a/docs/orgs/updateWebhookConfigForOrg.md +++ b/docs/orgs/updateWebhookConfigForOrg.md @@ -10,7 +10,10 @@ type: API method 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 ](/rest/orgs/webhooks#update-an-organization-webhook)." -OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint. +You must be an organization owner to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit +webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. ```js octokit.rest.orgs.updateWebhookConfigForOrg({ diff --git a/docs/repos/checkPrivateVulnerabilityReporting.md b/docs/repos/checkPrivateVulnerabilityReporting.md new file mode 100644 index 000000000..23277bfaa --- /dev/null +++ b/docs/repos/checkPrivateVulnerabilityReporting.md @@ -0,0 +1,44 @@ +--- +name: Check if private vulnerability reporting is enabled for a repository +example: octokit.rest.repos.checkPrivateVulnerabilityReporting({ owner, repo }) +route: GET /repos/{owner}/{repo}/private-vulnerability-reporting +scope: repos +type: API method +--- + +# Check if private vulnerability reporting is enabled for a repository + +Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see "[Evaluating the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)". + +```js +octokit.rest.repos.checkPrivateVulnerabilityReporting({ + owner, + repo, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository without the `.git` extension. The name is not case sensitive. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository). diff --git a/docs/repos/compareCommitsWithBasehead.md b/docs/repos/compareCommitsWithBasehead.md index 0a219f93d..d1772c76f 100644 --- a/docs/repos/compareCommitsWithBasehead.md +++ b/docs/repos/compareCommitsWithBasehead.md @@ -8,7 +8,7 @@ type: API method # Compare two commits -Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." +Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order. diff --git a/docs/users/getContextForUser.md b/docs/users/getContextForUser.md index e79832c5d..660d37c73 100644 --- a/docs/users/getContextForUser.md +++ b/docs/users/getContextForUser.md @@ -10,12 +10,7 @@ type: API method Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. -The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this: - -```shell - curl -u username:token - https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 -``` +The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository). OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. diff --git a/package-lock.json b/package-lock.json index c3ee9dc54..31179a9b8 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,7 +9,7 @@ "version": "0.0.0-development", "license": "MIT", "dependencies": { - "@octokit/types": "^12.6.0" + "@octokit/types": "^13.0.0" }, "devDependencies": { "@octokit/core": "^6.0.0", @@ -1532,6 +1532,21 @@ "node": ">= 18" } }, + "node_modules/@octokit/core/node_modules/@octokit/openapi-types": { + "version": "20.0.0", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-20.0.0.tgz", + "integrity": "sha512-EtqRBEjp1dL/15V7WiX5LJMIxxkdiGJnabzYx5Apx4FkQIFgAfKumXeYAqqJCj1s+BMX4cPFIFC4OLCR6stlnA==", + "dev": true + }, + "node_modules/@octokit/core/node_modules/@octokit/types": { + "version": "12.6.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-12.6.0.tgz", + "integrity": "sha512-1rhSOfRa6H9w4YwK0yrf5faDaDTb+yLyBUKOCV4xtCDB5VmIPqd/v9yr9o6SAzOAlRxMiRiCic6JVM1/kunVkw==", + "dev": true, + "dependencies": { + "@octokit/openapi-types": "^20.0.0" + } + }, "node_modules/@octokit/endpoint": { "version": "10.0.0", "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-10.0.0.tgz", @@ -1545,6 +1560,21 @@ "node": ">= 18" } }, + "node_modules/@octokit/endpoint/node_modules/@octokit/openapi-types": { + "version": "20.0.0", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-20.0.0.tgz", + "integrity": "sha512-EtqRBEjp1dL/15V7WiX5LJMIxxkdiGJnabzYx5Apx4FkQIFgAfKumXeYAqqJCj1s+BMX4cPFIFC4OLCR6stlnA==", + "dev": true + }, + "node_modules/@octokit/endpoint/node_modules/@octokit/types": { + "version": "12.6.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-12.6.0.tgz", + "integrity": "sha512-1rhSOfRa6H9w4YwK0yrf5faDaDTb+yLyBUKOCV4xtCDB5VmIPqd/v9yr9o6SAzOAlRxMiRiCic6JVM1/kunVkw==", + "dev": true, + "dependencies": { + "@octokit/openapi-types": "^20.0.0" + } + }, "node_modules/@octokit/graphql": { "version": "8.0.0", "resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-8.0.0.tgz", @@ -1559,10 +1589,25 @@ "node": ">= 18" } }, - "node_modules/@octokit/openapi-types": { + "node_modules/@octokit/graphql/node_modules/@octokit/openapi-types": { "version": "20.0.0", "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-20.0.0.tgz", - "integrity": "sha512-EtqRBEjp1dL/15V7WiX5LJMIxxkdiGJnabzYx5Apx4FkQIFgAfKumXeYAqqJCj1s+BMX4cPFIFC4OLCR6stlnA==" + "integrity": "sha512-EtqRBEjp1dL/15V7WiX5LJMIxxkdiGJnabzYx5Apx4FkQIFgAfKumXeYAqqJCj1s+BMX4cPFIFC4OLCR6stlnA==", + "dev": true + }, + "node_modules/@octokit/graphql/node_modules/@octokit/types": { + "version": "12.6.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-12.6.0.tgz", + "integrity": "sha512-1rhSOfRa6H9w4YwK0yrf5faDaDTb+yLyBUKOCV4xtCDB5VmIPqd/v9yr9o6SAzOAlRxMiRiCic6JVM1/kunVkw==", + "dev": true, + "dependencies": { + "@octokit/openapi-types": "^20.0.0" + } + }, + "node_modules/@octokit/openapi-types": { + "version": "21.0.0", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-21.0.0.tgz", + "integrity": "sha512-B6/NBvsNQT5UWYWSFcUT55XTMZBHyflNke7Ryvhs3dLe3I2TTPwpGPMib70YS1Ha5Iccc5CtXTLU7lHstC5e3Q==" }, "node_modules/@octokit/request": { "version": "9.0.0", @@ -1591,6 +1636,36 @@ "node": ">= 18" } }, + "node_modules/@octokit/request-error/node_modules/@octokit/openapi-types": { + "version": "20.0.0", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-20.0.0.tgz", + "integrity": "sha512-EtqRBEjp1dL/15V7WiX5LJMIxxkdiGJnabzYx5Apx4FkQIFgAfKumXeYAqqJCj1s+BMX4cPFIFC4OLCR6stlnA==", + "dev": true + }, + "node_modules/@octokit/request-error/node_modules/@octokit/types": { + "version": "12.6.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-12.6.0.tgz", + "integrity": "sha512-1rhSOfRa6H9w4YwK0yrf5faDaDTb+yLyBUKOCV4xtCDB5VmIPqd/v9yr9o6SAzOAlRxMiRiCic6JVM1/kunVkw==", + "dev": true, + "dependencies": { + "@octokit/openapi-types": "^20.0.0" + } + }, + "node_modules/@octokit/request/node_modules/@octokit/openapi-types": { + "version": "20.0.0", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-20.0.0.tgz", + "integrity": "sha512-EtqRBEjp1dL/15V7WiX5LJMIxxkdiGJnabzYx5Apx4FkQIFgAfKumXeYAqqJCj1s+BMX4cPFIFC4OLCR6stlnA==", + "dev": true + }, + "node_modules/@octokit/request/node_modules/@octokit/types": { + "version": "12.6.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-12.6.0.tgz", + "integrity": "sha512-1rhSOfRa6H9w4YwK0yrf5faDaDTb+yLyBUKOCV4xtCDB5VmIPqd/v9yr9o6SAzOAlRxMiRiCic6JVM1/kunVkw==", + "dev": true, + "dependencies": { + "@octokit/openapi-types": "^20.0.0" + } + }, "node_modules/@octokit/tsconfig": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/@octokit/tsconfig/-/tsconfig-3.0.0.tgz", @@ -1598,11 +1673,11 @@ "dev": true }, "node_modules/@octokit/types": { - "version": "12.6.0", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-12.6.0.tgz", - "integrity": "sha512-1rhSOfRa6H9w4YwK0yrf5faDaDTb+yLyBUKOCV4xtCDB5VmIPqd/v9yr9o6SAzOAlRxMiRiCic6JVM1/kunVkw==", + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-13.0.0.tgz", + "integrity": "sha512-jSOgEoFZvjg78txlb7cuRTAEvyyQkIEB4Nujg5ZN7E1xaICsr8A0X045Nwb1wUWNrBUHBHZNtcsDIhk8d8ipCw==", "dependencies": { - "@octokit/openapi-types": "^20.0.0" + "@octokit/openapi-types": "^21.0.0" } }, "node_modules/@pkgjs/parseargs": { diff --git a/package.json b/package.json index 3f24dfc96..f10a2ed73 100644 --- a/package.json +++ b/package.json @@ -25,7 +25,7 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "dependencies": { - "@octokit/types": "^12.6.0" + "@octokit/types": "^13.0.0" }, "devDependencies": { "@octokit/core": "^6.0.0", diff --git a/scripts/update-endpoints/generated/endpoints.json b/scripts/update-endpoints/generated/endpoints.json index 5b15ae8e9..4b90bfbd9 100644 --- a/scripts/update-endpoints/generated/endpoints.json +++ b/scripts/update-endpoints/generated/endpoints.json @@ -424,7 +424,7 @@ "scope": "actions", "id": "createEnvironmentVariable", "method": "POST", - "url": "/repositories/{repository_id}/environments/{environment_name}/variables", + "url": "/repos/{owner}/{repo}/environments/{environment_name}/variables", "isDeprecated": false, "deprecationDate": null, "removalDate": null, @@ -434,10 +434,23 @@ "headers": [], "parameters": [ { - "name": "repository_id", - "description": "The unique identifier of the repository.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", - "type": "integer", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "PATH", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -500,7 +513,7 @@ "scope": "actions", "id": "createOrUpdateEnvironmentSecret", "method": "PUT", - "url": "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", + "url": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, @@ -510,10 +523,23 @@ "headers": [], "parameters": [ { - "name": "repository_id", - "description": "The unique identifier of the repository.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", - "type": "integer", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "PATH", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -1440,7 +1466,7 @@ "scope": "actions", "id": "deleteEnvironmentSecret", "method": "DELETE", - "url": "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", + "url": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, @@ -1450,10 +1476,23 @@ "headers": [], "parameters": [ { - "name": "repository_id", - "description": "The unique identifier of the repository.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", - "type": "integer", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "PATH", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -1499,7 +1538,7 @@ "scope": "actions", "id": "deleteEnvironmentVariable", "method": "DELETE", - "url": "/repositories/{repository_id}/environments/{environment_name}/variables/{name}", + "url": "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, @@ -1509,10 +1548,23 @@ "headers": [], "parameters": [ { - "name": "repository_id", - "description": "The unique identifier of the repository.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", - "type": "integer", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "PATH", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -3171,7 +3223,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the customization template for an OpenID Connect (OIDC) subject claim.\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint. GitHub Apps must have the `organization_administration:read` permission to use this endpoint.", + "description": "Gets the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository", "previews": [], "headers": [], @@ -3224,7 +3276,7 @@ "scope": "actions", "id": "getEnvironmentPublicKey", "method": "GET", - "url": "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key", + "url": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key", "isDeprecated": false, "deprecationDate": null, "removalDate": null, @@ -3234,10 +3286,23 @@ "headers": [], "parameters": [ { - "name": "repository_id", - "description": "The unique identifier of the repository.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", - "type": "integer", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "PATH", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -3278,7 +3343,7 @@ "scope": "actions", "id": "getEnvironmentSecret", "method": "GET", - "url": "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", + "url": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, @@ -3288,10 +3353,23 @@ "headers": [], "parameters": [ { - "name": "repository_id", - "description": "The unique identifier of the repository.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", - "type": "integer", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "PATH", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -3345,7 +3423,7 @@ "scope": "actions", "id": "getEnvironmentVariable", "method": "GET", - "url": "/repositories/{repository_id}/environments/{environment_name}/variables/{name}", + "url": "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, @@ -3355,10 +3433,23 @@ "headers": [], "parameters": [ { - "name": "repository_id", - "description": "The unique identifier of the repository.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", - "type": "integer", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "PATH", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -4840,7 +4931,7 @@ "scope": "actions", "id": "listEnvironmentSecrets", "method": "GET", - "url": "/repositories/{repository_id}/environments/{environment_name}/secrets", + "url": "/repos/{owner}/{repo}/environments/{environment_name}/secrets", "isDeprecated": false, "deprecationDate": null, "removalDate": null, @@ -4850,10 +4941,23 @@ "headers": [], "parameters": [ { - "name": "repository_id", - "description": "The unique identifier of the repository.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", - "type": "integer", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "PATH", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -4920,7 +5024,7 @@ "scope": "actions", "id": "listEnvironmentVariables", "method": "GET", - "url": "/repositories/{repository_id}/environments/{environment_name}/variables", + "url": "/repos/{owner}/{repo}/environments/{environment_name}/variables", "isDeprecated": false, "deprecationDate": null, "removalDate": null, @@ -4930,10 +5034,23 @@ "headers": [], "parameters": [ { - "name": "repository_id", - "description": "The unique identifier of the repository.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", - "type": "integer", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "PATH", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -6565,7 +6682,7 @@ }, { "name": "status", - "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`.", + "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.", "in": "QUERY", "type": "string", "required": false, @@ -6692,7 +6809,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis API 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`.", "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository", "previews": [], "headers": [], @@ -6764,7 +6881,7 @@ }, { "name": "status", - "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`.", + "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.", "in": "QUERY", "type": "string", "required": false, @@ -8009,7 +8126,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository.\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "description": "Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository", "previews": [], "headers": [], @@ -8574,7 +8691,7 @@ "scope": "actions", "id": "updateEnvironmentVariable", "method": "PATCH", - "url": "/repositories/{repository_id}/environments/{environment_name}/variables/{name}", + "url": "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, @@ -8584,10 +8701,23 @@ "headers": [], "parameters": [ { - "name": "repository_id", - "description": "The unique identifier of the repository.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", - "type": "integer", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "PATH", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -8947,7 +9077,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:\n\n* **Timeline**: The GitHub global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", + "description": "Lists 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.\n\n* **Timeline**: The GitHub global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.\n\nBy 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](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", "documentationUrl": "https://docs.github.com/rest/activity/feeds#get-feeds", "previews": [], "headers": [], @@ -16156,11 +16286,18 @@ }, { "name": "status", - "description": "The current status.", + "description": "The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.", "in": "BODY", "type": "string", "required": false, - "enum": ["queued", "in_progress", "completed"], + "enum": [ + "queued", + "in_progress", + "completed", + "waiting", + "requested", + "pending" + ], "allowNull": false, "mapToData": null, "validation": null, @@ -22223,6 +22360,11 @@ }, { "code": 403, "description": "Forbidden", "examples": null }, { "code": 404, "description": "Resource not found", "examples": null }, + { + "code": 422, + "description": "There is a problem with your account's associated payment method.", + "examples": null + }, { "code": 500, "description": "Internal Error", "examples": null } ], "renamed": null @@ -26322,6 +26464,7 @@ ] }, { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 409, "description": "Conflict", "examples": null }, { "code": 422, "description": "Validation failed, or the endpoint has been spammed.", @@ -26407,6 +26550,7 @@ } ] }, + { "code": 409, "description": "Conflict", "examples": null }, { "code": 422, "description": "Validation failed, or the endpoint has been spammed.", @@ -26570,6 +26714,7 @@ } ] }, + { "code": 409, "description": "Conflict", "examples": null }, { "code": 422, "description": "Validation failed, or the endpoint has been spammed.", @@ -26722,6 +26867,7 @@ }, { "code": 403, "description": "Forbidden", "examples": null }, { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 409, "description": "Conflict", "examples": null }, { "code": 422, "description": "Validation failed, or the endpoint has been spammed.", @@ -26739,7 +26885,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", + "description": "Deletes the provided reference.", "documentationUrl": "https://docs.github.com/rest/git/refs#delete-a-reference", "previews": [], "headers": [], @@ -26772,7 +26918,7 @@ }, { "name": "ref", - "description": "The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", + "description": "The Git reference. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", "in": "PATH", "type": "string", "required": true, @@ -26786,6 +26932,7 @@ ], "responses": [ { "code": 204, "description": "Response", "examples": null }, + { "code": 409, "description": "Conflict", "examples": null }, { "code": 422, "description": "Validation failed, or the endpoint has been spammed.", @@ -26860,6 +27007,7 @@ }, { "code": 403, "description": "Forbidden", "examples": null }, { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 409, "description": "Conflict", "examples": null }, { "code": 422, "description": "Validation failed, or the endpoint has been spammed.", @@ -26932,7 +27080,8 @@ } ] }, - { "code": 404, "description": "Resource not found", "examples": null } + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 409, "description": "Conflict", "examples": null } ], "renamed": null }, @@ -26978,7 +27127,7 @@ }, { "name": "ref", - "description": "The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", + "description": "The Git reference. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", "in": "PATH", "type": "string", "required": true, @@ -27000,7 +27149,8 @@ } ] }, - { "code": 404, "description": "Resource not found", "examples": null } + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 409, "description": "Conflict", "examples": null } ], "renamed": null }, @@ -27068,7 +27218,8 @@ } ] }, - { "code": 404, "description": "Resource not found", "examples": null } + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 409, "description": "Conflict", "examples": null } ], "renamed": null }, @@ -27153,6 +27304,7 @@ ] }, { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 409, "description": "Conflict", "examples": null }, { "code": 422, "description": "Validation failed, or the endpoint has been spammed.", @@ -27203,7 +27355,7 @@ }, { "name": "ref", - "description": "The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", + "description": "The Git reference. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", "in": "PATH", "type": "string", "required": true, @@ -27224,7 +27376,8 @@ "data": "[{\"ref\":\"refs/heads/feature-a\",\"node_id\":\"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-a\",\"object\":{\"type\":\"commit\",\"sha\":\"aa218f56b14c9653891f9e74264a383fa43fefbd\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd\"}},{\"ref\":\"refs/heads/feature-b\",\"node_id\":\"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWI=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-b\",\"object\":{\"type\":\"commit\",\"sha\":\"612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac\"}}]" } ] - } + }, + { "code": 409, "description": "Conflict", "examples": null } ], "renamed": null }, @@ -27237,7 +27390,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", + "description": "Updates the provided reference to point to a new SHA. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", "documentationUrl": "https://docs.github.com/rest/git/refs#update-a-reference", "previews": [], "headers": [], @@ -27270,7 +27423,7 @@ }, { "name": "ref", - "description": "The name of the reference to update (for example, `heads/featureA`). Can be a branch name (`heads/BRANCH_NAME`) or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", + "description": "The Git reference. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", "in": "PATH", "type": "string", "required": true, @@ -27318,6 +27471,7 @@ } ] }, + { "code": 409, "description": "Conflict", "examples": null }, { "code": 422, "description": "Validation failed, or the endpoint has been spammed.", @@ -32069,6 +32223,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "ref", + "description": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -34121,7 +34288,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the customization template for an OpenID Connect (OIDC) subject claim.\nYou must authenticate using an access token with the `read:org` scope to use this endpoint.\nGitHub Apps must have the `organization_administration:write` permission to use this endpoint.", + "description": "Gets the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization", "previews": [], "headers": [], @@ -34160,7 +34327,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.\nYou must authenticate using an access token with the `write:org` scope to use this endpoint.\nGitHub Apps must have the `admin:org` permission to use this endpoint.", + "description": "Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization", "previews": [], "headers": [], @@ -35294,7 +35461,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Here's how you can create a hook that posts payloads in JSON format:", + "description": "Create a hook that posts payloads in JSON format.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or \nedit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "documentationUrl": "https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook", "previews": [], "headers": [], @@ -35554,7 +35721,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", + "description": "You must be an organization owner to use this endpoint. \n\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.", "documentationUrl": "https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook", "previews": [], "headers": [], @@ -35986,7 +36153,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Returns a webhook configured in an organization. To get only the webhook `config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization).\"", + "description": "Returns a webhook configured in an organization. To get only the webhook\n`config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). \n\nYou must be an organization owner to use this endpoint. \n\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.", "documentationUrl": "https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook", "previews": [], "headers": [], @@ -36041,7 +36208,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use \"[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.", + "description": "Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use \"[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook).\"\n\nYou must be an organization owner to use this endpoint. \n\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.", "documentationUrl": "https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization", "previews": [], "headers": [], @@ -36095,7 +36262,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Returns a delivery for a webhook configured in an organization.", + "description": "Returns a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\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.", "documentationUrl": "https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook", "previews": [], "headers": [], @@ -36169,7 +36336,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all organizations, in the order that they were created on GitHub.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.", + "description": "Lists all organizations, in the order that they were created.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.", "documentationUrl": "https://docs.github.com/rest/orgs/orgs#list-organizations", "previews": [], "headers": [], @@ -37954,7 +38121,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Returns a list of webhook deliveries for a webhook configured in an organization.", + "description": "Returns a list of webhook deliveries for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\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.", "documentationUrl": "https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook", "previews": [], "headers": [], @@ -38054,7 +38221,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", + "description": "You must be an organization owner to use this endpoint. \n\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.", "documentationUrl": "https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks", "previews": [], "headers": [], @@ -38222,7 +38389,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.", + "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event)\nto be sent to the hook.\n\nYou must be an organization owner to use this endpoint. \n\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.", "documentationUrl": "https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook", "previews": [], "headers": [], @@ -38269,7 +38436,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Redeliver a delivery for a webhook configured in an organization.", + "description": "Redeliver a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\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.", "documentationUrl": "https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook", "previews": [], "headers": [], @@ -39786,7 +39953,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization).\"", + "description": "Updates a webhook configured in an organization. When you update a webhook,\nthe `secret` will be overwritten. If you previously had a `secret` set, you must\nprovide the same `secret` or set a new `secret` or the secret will be removed. If\nyou are only updating individual webhook `config` properties, use \"[Update a webhook\nconfiguration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)\". \n\nYou must be an organization owner to use this endpoint. \n\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.", "documentationUrl": "https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook", "previews": [], "headers": [], @@ -39950,7 +40117,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "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 ](/rest/orgs/webhooks#update-an-organization-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.", + "description": "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 ](/rest/orgs/webhooks#update-an-organization-webhook).\"\n\nYou must be an organization owner to use this endpoint. \n\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.", "documentationUrl": "https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization", "previews": [], "headers": [], @@ -45118,6 +45285,7 @@ }, { "code": 304, "description": "Not modified", "examples": null }, { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 406, "description": "Unacceptable", "examples": null }, { "code": 500, "description": "Internal Error", "examples": null }, { "code": 503, "description": "Service unavailable", "examples": null } ], @@ -50134,6 +50302,58 @@ ], "renamed": null }, + { + "name": "Check if private vulnerability reporting is enabled for a repository", + "scope": "repos", + "id": "checkPrivateVulnerabilityReporting", + "method": "GET", + "url": "/repos/{owner}/{repo}/private-vulnerability-reporting", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see \"[Evaluating the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)\".", + "documentationUrl": "https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Private vulnerability reporting status", + "examples": [{ "data": "{\"enabled\":true}" }] + }, + { "code": 422, "description": "Bad Request", "examples": null }, + { "code": 422, "description": "Bad Request", "examples": null } + ], + "renamed": null + }, { "name": "Check if vulnerability alerts are enabled for a repository", "scope": "repos", @@ -50374,7 +50594,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "documentationUrl": "https://docs.github.com/rest/commits/commits#compare-two-commits", "previews": [], "headers": [], @@ -51601,6 +51821,7 @@ ], "responses": [ { "code": 204, "description": "Response", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, { "code": 422, "description": "Validation failed, or the endpoint has been spammed.", @@ -58044,6 +58265,7 @@ ] }, { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 409, "description": "Conflict", "examples": null }, { "code": 422, "description": "Validation failed, or the endpoint has been spammed.", @@ -61549,6 +61771,7 @@ } ] }, + { "code": 409, "description": "Conflict", "examples": null }, { "code": 422, "description": "Validation failed, or the endpoint has been spammed.", @@ -63558,7 +63781,8 @@ "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"notification_setting\":\"notifications_enabled\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false}]" } ] - } + }, + { "code": 409, "description": "Conflict", "examples": null } ], "renamed": null }, @@ -70578,7 +70802,7 @@ "description": "Response", "examples": [ { - "data": "[{\"type\":\"commit\",\"details\":{\"path\":\"/example/secrets.txt\",\"start_line\":1,\"end_line\":1,\"start_column\":1,\"end_column\":64,\"blob_sha\":\"af5626b4a114abcb82d63db7c8082c3c4756e51b\",\"blob_url\":\"https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b\",\"commit_sha\":\"f14d7debf9775f957cf4f1e8176da0786431f72b\",\"commit_url\":\"https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b\"}},{\"type\":\"issue_title\",\"details\":{\"issue_title_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"}},{\"type\":\"issue_body\",\"details\":{\"issue_body_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"}},{\"type\":\"issue_comment\",\"details\":{\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451\"}},{\"type\":\"discussion_title\",\"details\":{\"discussion_title_url\":\"https://github.com/community/community/discussions/39082\"}},{\"type\":\"discussion_body\",\"details\":{\"discussion_body_url\":\"https://github.com/community/community/discussions/39082#discussion-4566270\"}},{\"type\":\"discussion_comment\",\"details\":{\"discussion_comment_url\":\"https://github.com/community/community/discussions/39082#discussioncomment-4158232\"}},{\"type\":\"pull_request_title\",\"details\":{\"pull_request_title_url\":\"https://api.github.com/repos/octocat/Hello-World/pull/2846\"}},{\"type\":\"pull_request_body\",\"details\":{\"pull_request_body_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/2846\"}},{\"type\":\"pull_request_comment\",\"details\":{\"pull_request_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1825855898\"}},{\"type\":\"pull_request_review\",\"details\":{\"pull_request_review_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80\"}},{\"type\":\"pull_request_review_comment\",\"details\":{\"pull_request_review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/12\"}}]" + "data": "[{\"type\":\"commit\",\"details\":{\"path\":\"/example/secrets.txt\",\"start_line\":1,\"end_line\":1,\"start_column\":1,\"end_column\":64,\"blob_sha\":\"af5626b4a114abcb82d63db7c8082c3c4756e51b\",\"blob_url\":\"https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b\",\"commit_sha\":\"f14d7debf9775f957cf4f1e8176da0786431f72b\",\"commit_url\":\"https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b\"}},{\"type\":\"wiki_commit\",\"details\":{\"path\":\"/example/Home.md\",\"start_line\":1,\"end_line\":1,\"start_column\":1,\"end_column\":64,\"blob_sha\":\"af5626b4a114abcb82d63db7c8082c3c4756e51b\",\"page_url\":\"https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5\",\"commit_sha\":\"302c0b7e200761c9dd9b57e57db540ee0b4293a5\",\"commit_url\":\"https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5\"}},{\"type\":\"issue_title\",\"details\":{\"issue_title_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"}},{\"type\":\"issue_body\",\"details\":{\"issue_body_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"}},{\"type\":\"issue_comment\",\"details\":{\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451\"}},{\"type\":\"discussion_title\",\"details\":{\"discussion_title_url\":\"https://github.com/community/community/discussions/39082\"}},{\"type\":\"discussion_body\",\"details\":{\"discussion_body_url\":\"https://github.com/community/community/discussions/39082#discussion-4566270\"}},{\"type\":\"discussion_comment\",\"details\":{\"discussion_comment_url\":\"https://github.com/community/community/discussions/39082#discussioncomment-4158232\"}},{\"type\":\"pull_request_title\",\"details\":{\"pull_request_title_url\":\"https://api.github.com/repos/octocat/Hello-World/pull/2846\"}},{\"type\":\"pull_request_body\",\"details\":{\"pull_request_body_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/2846\"}},{\"type\":\"pull_request_comment\",\"details\":{\"pull_request_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1825855898\"}},{\"type\":\"pull_request_review\",\"details\":{\"pull_request_review_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80\"}},{\"type\":\"pull_request_review_comment\",\"details\":{\"pull_request_review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/12\"}}]" } ] }, @@ -71583,18 +71807,19 @@ "type": "string", "required": false, "enum": [ - "actions", - "composer", - "erlang", - "go", - "maven", + "rubygems", "npm", - "nuget", - "other", "pip", + "maven", + "nuget", + "composer", + "go", + "rust", + "erlang", + "actions", "pub", - "rubygems", - "rust" + "other", + "swift" ], "allowNull": false, "mapToData": null, @@ -78090,7 +78315,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.\n\nThe `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this:\n\n```shell\n curl -u username:token\n https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192\n```\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.\n\n The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/users/users#get-contextual-information-for-a-user", "previews": [], "headers": [], diff --git a/src/generated/endpoints.ts b/src/generated/endpoints.ts index 77093d3c4..b631f27e4 100644 --- a/src/generated/endpoints.ts +++ b/src/generated/endpoints.ts @@ -20,10 +20,10 @@ const Endpoints: EndpointsDefaultsAndDecorations = { "POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel", ], createEnvironmentVariable: [ - "POST /repositories/{repository_id}/environments/{environment_name}/variables", + "POST /repos/{owner}/{repo}/environments/{environment_name}/variables", ], createOrUpdateEnvironmentSecret: [ - "PUT /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", + "PUT /repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}", ], createOrUpdateOrgSecret: ["PUT /orgs/{org}/actions/secrets/{secret_name}"], createOrUpdateRepoSecret: [ @@ -54,10 +54,10 @@ const Endpoints: EndpointsDefaultsAndDecorations = { "DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id}", ], deleteEnvironmentSecret: [ - "DELETE /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", + "DELETE /repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}", ], deleteEnvironmentVariable: [ - "DELETE /repositories/{repository_id}/environments/{environment_name}/variables/{name}", + "DELETE /repos/{owner}/{repo}/environments/{environment_name}/variables/{name}", ], deleteOrgSecret: ["DELETE /orgs/{org}/actions/secrets/{secret_name}"], deleteOrgVariable: ["DELETE /orgs/{org}/actions/variables/{name}"], @@ -127,13 +127,13 @@ const Endpoints: EndpointsDefaultsAndDecorations = { "GET /repos/{owner}/{repo}/actions/oidc/customization/sub", ], getEnvironmentPublicKey: [ - "GET /repositories/{repository_id}/environments/{environment_name}/secrets/public-key", + "GET /repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key", ], getEnvironmentSecret: [ - "GET /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", + "GET /repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}", ], getEnvironmentVariable: [ - "GET /repositories/{repository_id}/environments/{environment_name}/variables/{name}", + "GET /repos/{owner}/{repo}/environments/{environment_name}/variables/{name}", ], getGithubActionsDefaultWorkflowPermissionsOrganization: [ "GET /orgs/{org}/actions/permissions/workflow", @@ -185,10 +185,10 @@ const Endpoints: EndpointsDefaultsAndDecorations = { ], listArtifactsForRepo: ["GET /repos/{owner}/{repo}/actions/artifacts"], listEnvironmentSecrets: [ - "GET /repositories/{repository_id}/environments/{environment_name}/secrets", + "GET /repos/{owner}/{repo}/environments/{environment_name}/secrets", ], listEnvironmentVariables: [ - "GET /repositories/{repository_id}/environments/{environment_name}/variables", + "GET /repos/{owner}/{repo}/environments/{environment_name}/variables", ], listJobsForWorkflowRun: [ "GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs", @@ -306,7 +306,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { "PUT /repos/{owner}/{repo}/actions/permissions/access", ], updateEnvironmentVariable: [ - "PATCH /repositories/{repository_id}/environments/{environment_name}/variables/{name}", + "PATCH /repos/{owner}/{repo}/environments/{environment_name}/variables/{name}", ], updateOrgVariable: ["PATCH /orgs/{org}/actions/variables/{name}"], updateRepoVariable: [ @@ -1374,6 +1374,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = { "GET /repos/{owner}/{repo}/automated-security-fixes", ], checkCollaborator: ["GET /repos/{owner}/{repo}/collaborators/{username}"], + checkPrivateVulnerabilityReporting: [ + "GET /repos/{owner}/{repo}/private-vulnerability-reporting", + ], checkVulnerabilityAlerts: [ "GET /repos/{owner}/{repo}/vulnerability-alerts", ], diff --git a/src/generated/method-types.ts b/src/generated/method-types.ts index 648566a1c..6c737c419 100644 --- a/src/generated/method-types.ts +++ b/src/generated/method-types.ts @@ -843,8 +843,8 @@ export type RestEndpointMethods = { }; /** * Gets the customization template for an OpenID Connect (OIDC) subject claim. - * You must authenticate using an access token with the `repo` scope to use this - * endpoint. GitHub Apps must have the `organization_administration:read` permission to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ getCustomOidcSubClaimForRepo: { ( @@ -1632,6 +1632,8 @@ export type RestEndpointMethods = { * Anyone with read access to the repository can use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * + * This API 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`. */ listWorkflowRunsForRepo: { ( @@ -1891,8 +1893,8 @@ export type RestEndpointMethods = { }; /** * Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository. - * You must authenticate using an access token with the `repo` scope to use this - * endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ setCustomOidcSubClaimForRepo: { ( @@ -2117,7 +2119,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user: + * Lists 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. * * * **Timeline**: The GitHub global public timeline * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." @@ -2127,6 +2129,8 @@ export type RestEndpointMethods = { * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub. * + * 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](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ getFeeds: { @@ -5210,7 +5214,9 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - + /** + * Deletes the provided reference. + */ deleteRef: { ( params?: RestEndpointMethodTypes["git"]["deleteRef"]["parameters"], @@ -5358,7 +5364,9 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - + /** + * Updates the provided reference to point to a new SHA. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + */ updateRef: { ( params?: RestEndpointMethodTypes["git"]["updateRef"]["parameters"], @@ -6632,8 +6640,8 @@ export type RestEndpointMethods = { oidc: { /** * Gets the customization template for an OpenID Connect (OIDC) subject claim. - * You must authenticate using an access token with the `read:org` scope to use this endpoint. - * GitHub Apps must have the `organization_administration:write` permission to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ getOidcCustomSubTemplateForOrg: { ( @@ -6646,8 +6654,8 @@ export type RestEndpointMethods = { }; /** * Creates or updates the customization template for an OpenID Connect (OIDC) subject claim. - * You must authenticate using an access token with the `write:org` scope to use this endpoint. - * GitHub Apps must have the `admin:org` permission to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ updateOidcCustomSubTemplateForOrg: { ( @@ -6868,7 +6876,12 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Here's how you can create a hook that posts payloads in JSON format: + * Create a hook that posts payloads in JSON format. + * + * You must be an organization owner to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or + * edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ createWebhook: { ( @@ -6912,7 +6925,12 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - + /** + * You must be an organization owner to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + */ deleteWebhook: { ( params?: RestEndpointMethodTypes["orgs"]["deleteWebhook"]["parameters"], @@ -7022,7 +7040,13 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization)." + * Returns a webhook configured in an organization. To get only the webhook + * `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). + * + * You must be an organization owner to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ getWebhook: { ( @@ -7034,7 +7058,10 @@ export type RestEndpointMethods = { /** * Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint. + * You must be an organization owner to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ getWebhookConfigForOrg: { ( @@ -7047,6 +7074,11 @@ export type RestEndpointMethods = { }; /** * Returns a delivery for a webhook configured in an organization. + * + * You must be an organization owner to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ getWebhookDelivery: { ( @@ -7058,7 +7090,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists all organizations, in the order that they were created on GitHub. + * Lists all organizations, in the order that they were created. * * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ @@ -7361,6 +7393,11 @@ export type RestEndpointMethods = { }; /** * Returns a list of webhook deliveries for a webhook configured in an organization. + * + * You must be an organization owner to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ listWebhookDeliveries: { ( @@ -7371,7 +7408,12 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - + /** + * You must be an organization owner to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + */ listWebhooks: { ( params?: RestEndpointMethodTypes["orgs"]["listWebhooks"]["parameters"], @@ -7400,7 +7442,13 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. + * This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) + * to be sent to the hook. + * + * You must be an organization owner to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ pingWebhook: { ( @@ -7411,6 +7459,11 @@ export type RestEndpointMethods = { }; /** * Redeliver a delivery for a webhook configured in an organization. + * + * You must be an organization owner to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ redeliverWebhookDelivery: { ( @@ -7694,7 +7747,16 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)." + * Updates a webhook configured in an organization. When you update a webhook, + * the `secret` will be overwritten. If you previously had a `secret` set, you must + * provide the same `secret` or set a new `secret` or the secret will be removed. If + * you are only updating individual webhook `config` properties, use "[Update a webhook + * configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)". + * + * You must be an organization owner to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ updateWebhook: { ( @@ -7706,7 +7768,10 @@ export type RestEndpointMethods = { /** * 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 ](/rest/orgs/webhooks#update-an-organization-webhook)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint. + * You must be an organization owner to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ updateWebhookConfigForOrg: { ( @@ -9411,6 +9476,18 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see "[Evaluating the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)". + */ + checkPrivateVulnerabilityReporting: { + ( + params?: RestEndpointMethodTypes["repos"]["checkPrivateVulnerabilityReporting"]["parameters"], + ): Promise< + RestEndpointMethodTypes["repos"]["checkPrivateVulnerabilityReporting"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". */ @@ -9491,7 +9568,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + * Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." * * This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order. * @@ -13386,12 +13463,7 @@ export type RestEndpointMethods = { /** * Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * - * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this: - * - * ```shell - * curl -u username:token - * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 - * ``` + * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ diff --git a/src/generated/parameters-and-response-types.ts b/src/generated/parameters-and-response-types.ts index 768dcdcae..2aa832a9b 100644 --- a/src/generated/parameters-and-response-types.ts +++ b/src/generated/parameters-and-response-types.ts @@ -34,13 +34,13 @@ export type RestEndpointMethodTypes = { }; createEnvironmentVariable: { parameters: RequestParameters & - Endpoints["POST /repositories/{repository_id}/environments/{environment_name}/variables"]["parameters"]; - response: Endpoints["POST /repositories/{repository_id}/environments/{environment_name}/variables"]["response"]; + Endpoints["POST /repos/{owner}/{repo}/environments/{environment_name}/variables"]["parameters"]; + response: Endpoints["POST /repos/{owner}/{repo}/environments/{environment_name}/variables"]["response"]; }; createOrUpdateEnvironmentSecret: { parameters: RequestParameters & - Endpoints["PUT /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}"]["parameters"]; - response: Endpoints["PUT /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}"]["response"]; + Endpoints["PUT /repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}"]["parameters"]; + response: Endpoints["PUT /repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}"]["response"]; }; createOrUpdateOrgSecret: { parameters: RequestParameters & @@ -104,13 +104,13 @@ export type RestEndpointMethodTypes = { }; deleteEnvironmentSecret: { parameters: RequestParameters & - Endpoints["DELETE /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}"]["parameters"]; - response: Endpoints["DELETE /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}"]["response"]; + Endpoints["DELETE /repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}"]["parameters"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}"]["response"]; }; deleteEnvironmentVariable: { parameters: RequestParameters & - Endpoints["DELETE /repositories/{repository_id}/environments/{environment_name}/variables/{name}"]["parameters"]; - response: Endpoints["DELETE /repositories/{repository_id}/environments/{environment_name}/variables/{name}"]["response"]; + Endpoints["DELETE /repos/{owner}/{repo}/environments/{environment_name}/variables/{name}"]["parameters"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/environments/{environment_name}/variables/{name}"]["response"]; }; deleteOrgSecret: { parameters: RequestParameters & @@ -249,18 +249,18 @@ export type RestEndpointMethodTypes = { }; getEnvironmentPublicKey: { parameters: RequestParameters & - Endpoints["GET /repositories/{repository_id}/environments/{environment_name}/secrets/public-key"]["parameters"]; - response: Endpoints["GET /repositories/{repository_id}/environments/{environment_name}/secrets/public-key"]["response"]; + Endpoints["GET /repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key"]["response"]; }; getEnvironmentSecret: { parameters: RequestParameters & - Endpoints["GET /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}"]["parameters"]; - response: Endpoints["GET /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}"]["response"]; + Endpoints["GET /repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}"]["response"]; }; getEnvironmentVariable: { parameters: RequestParameters & - Endpoints["GET /repositories/{repository_id}/environments/{environment_name}/variables/{name}"]["parameters"]; - response: Endpoints["GET /repositories/{repository_id}/environments/{environment_name}/variables/{name}"]["response"]; + Endpoints["GET /repos/{owner}/{repo}/environments/{environment_name}/variables/{name}"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/environments/{environment_name}/variables/{name}"]["response"]; }; getGithubActionsDefaultWorkflowPermissionsOrganization: { parameters: RequestParameters & @@ -379,13 +379,13 @@ export type RestEndpointMethodTypes = { }; listEnvironmentSecrets: { parameters: RequestParameters & - Endpoints["GET /repositories/{repository_id}/environments/{environment_name}/secrets"]["parameters"]; - response: Endpoints["GET /repositories/{repository_id}/environments/{environment_name}/secrets"]["response"]; + Endpoints["GET /repos/{owner}/{repo}/environments/{environment_name}/secrets"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/environments/{environment_name}/secrets"]["response"]; }; listEnvironmentVariables: { parameters: RequestParameters & - Endpoints["GET /repositories/{repository_id}/environments/{environment_name}/variables"]["parameters"]; - response: Endpoints["GET /repositories/{repository_id}/environments/{environment_name}/variables"]["response"]; + Endpoints["GET /repos/{owner}/{repo}/environments/{environment_name}/variables"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/environments/{environment_name}/variables"]["response"]; }; listJobsForWorkflowRun: { parameters: RequestParameters & @@ -614,8 +614,8 @@ export type RestEndpointMethodTypes = { }; updateEnvironmentVariable: { parameters: RequestParameters & - Endpoints["PATCH /repositories/{repository_id}/environments/{environment_name}/variables/{name}"]["parameters"]; - response: Endpoints["PATCH /repositories/{repository_id}/environments/{environment_name}/variables/{name}"]["response"]; + Endpoints["PATCH /repos/{owner}/{repo}/environments/{environment_name}/variables/{name}"]["parameters"]; + response: Endpoints["PATCH /repos/{owner}/{repo}/environments/{environment_name}/variables/{name}"]["response"]; }; updateOrgVariable: { parameters: RequestParameters & @@ -3128,6 +3128,11 @@ export type RestEndpointMethodTypes = { Endpoints["GET /repos/{owner}/{repo}/collaborators/{username}"]["parameters"]; response: Endpoints["GET /repos/{owner}/{repo}/collaborators/{username}"]["response"]; }; + checkPrivateVulnerabilityReporting: { + parameters: RequestParameters & + Endpoints["GET /repos/{owner}/{repo}/private-vulnerability-reporting"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/private-vulnerability-reporting"]["response"]; + }; checkVulnerabilityAlerts: { parameters: RequestParameters & Endpoints["GET /repos/{owner}/{repo}/vulnerability-alerts"]["parameters"];